
文本描述
VortexFileSync
面向现代 Minecraft 网络的高性能文件同步工具
VortexFileSync 是一款专为现代 Minecraft 网络打造的高性能文件同步插件。它通过集中式数据库实现配置、脚本和数据在多个服务器实例间的无缝共享,确保整个网络绝对一致,无需人工干预。
它旨在自动化更新多台服务器的繁琐过程:允许你在一个“主”服务器上编辑文件,并实时自动将其传播到其他所有服务器。
它能做什么?
你可以创建以下类型的同步任务:
- 同步整个文件夹:轻松共享目录,例如
plugins/Skript/scripts、plugins/LuckPerms 或自定义配置文件夹。
- 自动检测更改:使用高级 SHA-256 哈希算法监控文件变化,仅在检测到实际更新时才进行同步。
- 触发命令执行:当执行特定的游戏内或控制台命令(例如重载配置后)时,自动上传更改。
- 应用 YAML 覆盖:保持文件同步的同时保留服务器特定值(如数据库凭证或服务器名称),通过强大的覆盖系统实现。
- 执行同步后命令:服务器接收文件更新后,自动运行控制台命令,例如
/sk reload all 或 /lp reload。
重要提示:范围与世界文件
VortexFileSync 专为配置和数据同步设计。 它不用于同步活跃的世界文件,例如 level.dat、区域文件或类似的世界数据。
尝试在服务器运行时同步世界文件夹会导致损坏或不完整的传输。请仅将此插件用于插件配置、脚本和静态数据。
MySQL 配置要求
由于所有文件都存储在数据库中,你必须确保 MySQL 或 MariaDB 服务器已配置为处理你的文件夹大小。如果上传失败,很可能是由于 max_allowed_packet 限制所致。
推荐设置:128MB
这支持大型插件目录和脚本库。
如何更新:
- 找到你的 MySQL 配置文件,通常在 Linux 上是
my.cnf,Windows 上是 my.ini。
- 找到
[mysqld] 部分。
- 添加或修改以下行:
[mysqld]
max_allowed_packet=128M
- 重启 MySQL 服务以使更改生效。
灵活的同步方法
FileSync 适应你网络的特定需求,对文件的移动方式和时机提供细粒度控制。
- 定时间隔:为服务器设置自定义心跳,以检查全局数据库中的更新。
- 命令触发:将上传链接到现有的管理员命令,以便在执行命令的瞬间推送更改。
- 手动控制:使用专用管理员命令强制上传或检查整个网络的同步状态。
- 过滤同步:使用详细的忽略列表排除特定文件、文件类型或子目录,使其不同步。
高级功能
- 原子更新:通过使用基于 zip 的传输和“先验证后应用”逻辑来确保文件完整性。
- 选择性 YAML 覆盖:按服务器更改 YAML 文件中的特定键,非常适合服务器特定的值(如 ID 或本地路径)。
- 冲突预防:智能锁定和哈希机制防止在多服务器更新期间出现部分下载或竞态条件。
- 基于数据库:利用 MySQL 和 MariaDB 的可靠性进行全局状态管理。
命令与权限
/vfs upload:手动触发配置的文件夹上传到网络数据库。
/vfs:显示用法和插件信息。
- 权限:
vortexfilesync.admin - 所有命令和管理操作必需。
兼容性与性能
支持版本:Paper 及兼容分支 1.18+
零 NMS 使用
由于该插件不使用任何 NMS 代码,更新流畅且一致。你的服务器通常可以在不需要插件更新的情况下升级 Minecraft 版本。
数据库支持
完全支持 MySQL 和 MariaDB,强烈建议以获得最佳性能。该插件使用稳健的存储库模式,确保即使在大型网络上也能高效处理数据。
配置与文档
每个配置文件都经过精心记录,以确保顺畅的设置体验。无论是定义复杂的 YAML 覆盖、设置文件过滤器还是配置命令触发器,你都将在 config.yml 中找到每个选项的清晰说明。

Text Description
VortexFileSync
High-Performance File Synchronization for Modern Minecraft Networks
VortexFileSync is a high-performance file synchronization plugin built for modern Minecraft networks. It enables seamless sharing of configuration files, scripts, and data across multiple server instances via a centralized database, ensuring absolute consistency across your entire network without manual intervention.
It's designed to automate the tedious process of updating multiple servers, allowing you to edit a file on one "master" server and have it automatically propagate to all others in real-time.
What can you do with it?
You can create synchronization tasks that:
- Sync Entire Folders: Effortlessly share directories like
plugins/Skript/scripts, plugins/LuckPerms, or custom config folders.
- Auto-Detect Changes: Uses advanced SHA-256 hashing to monitor file changes and only sync when an actual update is detected.
- Trigger on Commands: Automatically upload changes when specific in-game or console commands are executed, for example after reloading a config.
- Apply YAML Overrides: Keep files synced while maintaining server-specific values, such as database credentials or server names, using a powerful override system.
- Execute Post-Sync Commands: Automatically run console commands like
/sk reload all or /lp reload after a server receives a file update.
Important: Scope & World Files
VortexFileSync is designed for configuration and data synchronization. It is not intended for synchronizing active world files, such as level.dat, region files, or similar world data.
Attempting to sync world folders while a server is running will result in corruption or incomplete transfers. Please only use this plugin for plugin configurations, scripts, and static data.
MySQL Configuration Requirement
Since all files are stored in your database, you must ensure your MySQL or MariaDB server is configured to handle the size of your folders. If your upload fails, it is likely due to the max_allowed_packet limit.
Recommended Setting: 128MB
This supports large plugin directories and script libraries.
How to update it:
- Locate your MySQL configuration file, usually
my.cnf on Linux or my.ini on Windows.
- Find the
[mysqld] section.
- Add or modify the following lines:
[mysqld]
max_allowed_packet=128M
- Restart your MySQL service for the changes to take effect.
Flexible Sync Methods
FileSync adapts to your network's specific needs with granular control over how and when files move.
- Timed Intervals: Set a custom heartbeat for servers to check the global database for updates.
- Command Triggers: Link uploads to existing admin commands so changes are pushed the moment you execute them.
- Manual Control: Use dedicated admin commands to force uploads or check sync status across the network.
- Filtered Syncing: Use detailed ignore lists to exclude specific files, file types, or subdirectories from being synchronized.
Advanced Features
- Atomic Updates: Ensures file integrity by using zip-based transfers and verify-before-apply logic.
- Selective YAML Overrides: Change only specific keys in a YAML file per server, perfect for server-specific values like IDs or local paths.
- Conflict Prevention: Intelligent locking and hashing prevents partial downloads or race conditions during multi-server updates.
- Database Backed: Leverages the reliability of MySQL and MariaDB for global state management.
Commands & Permissions
/vfs upload: Manually trigger an upload of configured folders to the network database.
/vfs: Display usage and plugin information.
- Permission:
vortexfilesync.admin - Required for all commands and administrative actions.
Compatibility & Performance
Supported Versions: Paper and compatible forks 1.18+
Zero NMS Usage
Since the plugin uses no NMS, updates are smooth and consistent. Your server can usually update Minecraft versions without needing a plugin update.
Database Support
Fully supports MySQL and MariaDB, highly recommended for best performance. The plugin uses a robust repository pattern to ensure data is handled efficiently even on large networks.
Configuration & Documentation
Every configuration file is meticulously documented to ensure a smooth setup experience. Whether you are defining complex YAML overrides, setting up file filters, or configuring command triggers, you'll find clear explanations for every option in the config.yml.
评论 0
登录后参与评分
还没有评论,来抢沙发吧