> For the complete documentation index, see [llms.txt](https://wiki.vortexdevelopment.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.vortexdevelopment.net/projects/vortexfilesync.md). # VortexFileSync ### 🌟 Overview VortexFileSync is a powerful Minecraft plugin designed to synchronize configuration files, plugin data, and even JAR files across multiple servers in real-time. By leveraging a centralized MySQL/MariaDB database, it ensures that your server network stays consistent without manual file transfers. ### ✨ Core Features * **Centralized Synchronization:** Keep multiple servers in sync using a shared database. * **Flexible Config:** Define specific paths for uploading and downloading files. * **Regex Filtering:** Use powerful regular expressions to exclude specific files or directories from being synced. * **Post-Sync Commands:** Automatically execute commands after a file is downloaded or uploaded (ideal for reloading plugins). * **YAML Overrides:** Dynamically change YAML values during the download process. This allows you to have a master configuration that is slightly tweaked for each individual server (e.g., different server names or database settings). * **Performance Focused:** Asynchronous file processing ensuring no impact on server performance. ### 📥 Installation 1. Place the `VortexFileSync.jar` in your plugins folder. 2. Restart your server to generate the configuration files. 3. Configure your **MySQL/MariaDB** database settings in the `config.yml`. 4. Define your **Upload** and **Download** sections. 5. Restart or reload the plugin to apply changes. *** #### 🔗 Essential Links * **Discord Support**: [Join our Discord](https://dc.vortexdevelopment.net) * **Plugin Repository**: [Browse Artifacts](https://repo.vortexdevelopment.net/repository) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://wiki.vortexdevelopment.net/projects/vortexfilesync.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.