> For the complete documentation index, see [llms.txt](https://sayandev.gitbook.io/sayanvanish/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sayandev.gitbook.io/sayanvanish/installation.md).

# Installation

{% hint style="warning" %}
SayanVanish needs an active internet connection to be enabled on your server. Ensure your server is connected to the internet during the initial startup.
{% endhint %}

{% hint style="danger" %}
SayanVanish will require approximately 100MB of disk space to store its dependencies, configuration files, and other necessary data required for proper functionality.
{% endhint %}

{% hint style="danger" %}
SayanVanish does not support Paper 1.16 and 1.17. Additionally, compatibility with 1.8 is limited to modern forks such as CarbonSpigot, which include updated versions of SnakeYAML and SQLite.
{% endhint %}

### Bukkit Installation

1. **Download the Plugin**
   * Download the SayanVanish Bukkit jar file from [Hangar](https://hangar.papermc.io/Syrent/SayanVanish) or [Modrinth](https://modrinth.com/plugin/sayanvanish).
2. **Install the Plugin**
   * Place the downloaded jar file inside the `plugins` folder.
3. **Restart the Server**
   * Restart your Minecraft server to load the plugin.

{% hint style="danger" %}
Do **NOT** copy and paste the SayanVanish directory across multiple servers. The `settings.yml` file contains a unique ID generated during the plugin's first startup. Duplicating this file could lead to synchronization issues.
{% endhint %}

#### Optional Steps

* **Configure Database**
  * Modify the `database.yml` file to change the database type if necessary.
* **Customize Features**
  * Adjust settings in the `features` folder to enable or disable specific features.
* **Setup Permissions**
  * Configure the appropriate permissions for your users.

{% content-ref url="/pages/mHobypzW6wJ2Gm4lxl8w" %}
[settings.yml](/sayanvanish/configuration/settings.yml.md)
{% endcontent-ref %}

{% content-ref url="/pages/5mXpG3Hz8Nga3WrRjW7r" %}
[database.yml](/sayanvanish/configuration/database.yml.md)
{% endcontent-ref %}

{% content-ref url="/pages/MUCebbUID1Fjjq9rB6ti" %}
[\<feature>.yml](/sayanvanish/configuration/less-than-feature-greater-than.yml.md)
{% endcontent-ref %}

### Proxy (Velocity/Bungeecord) Installation

{% hint style="info" %}
Using proxy modules to sync data between servers is not necessary. These modules enable the `%sayanvanish_online_total%` and `%sayanvanish_online_<server>%` placeholders and allow API calls from Velocity to backend servers.
{% endhint %}

{% hint style="danger" %}
You will still be required to install SayanVanish on your backend servers to ensure proper functionality.
{% endhint %}

1. **Download the Plugin**
   * Download the SayanVanish Velocity/Bungeecord jar file from [Hangar](https://hangar.papermc.io/Syrent/SayanVanish) or [Modrinth](https://modrinth.com/plugin/sayanvanish).
2. **Install the Plugin**
   * Place the downloaded jar file in your `plugins` directory.
3. **Restart the Proxy**
   * Restart your proxy server to load the plugin.
4. **Configure Database on Proxy**
   * Navigate to the `SayanVanish` folder on your proxy server and change the database method to MySQL or Redis.
5. **Configure Database on Backend Servers**
   * On each of your backend servers, change the database method to MySQL or Redis.
6. **Enable Proxy Mode**
   * Set `proxy-mode` to `true` in the `settings.yml` file on your backend servers.
7. **Restart Servers**
   * Restart both your proxy and backend servers to apply the changes.