DOCSEARCHbyAlgolia
Submit Docs

HuskSync Documentation

website·Indexed 32 days ago

https://william278.net/docs

A modern, cross-server player data synchronization system for Spigot and Fabric servers. HuskSync enables comprehensive synchronization of player data, including inventories, and provides a v3 API for retrieving and updating data snapshots.

Tokens
120.4K
Snippets
511
Records
894
Agent score
63%

What's inside HuskSync

  1. Overview of HuskHomes teleportation plugin

    HuskHomes is a teleportation plugin for Minecraft Paper and Fabric servers. It provides a suite of teleportation commands for players and administrators, including /sethome, /home, /tpa, /rtp, /tp, and /warp. The plugin uses interactive JSON chat menus instead of chest GUIs, making it compatible with Bedrock players via Geyser. When configured with a compatible database, it supports cross-server teleportation across a proxy network.

  2. Overview of HuskTowns Minecraft Plugin

    HuskTowns is an intuitive, cross-server Towny-style protection solution for Minecraft servers. It is developed as a Java plugin and is licensed under Apache-2.0.

  3. Overview of SchematicUpload

    SchematicUpload is a Spigot plugin that provides a secure web panel for players to upload and download schematics to and from a server. It eliminates the need for administrators to manually import player files. Key features include a simple web interface, configurable hostname/port, and administrative limits on the number of uploads a player can perform within a specific timeframe.

  4. Overview of HuskTowns

    HuskTowns is a proxy-compatible Towny-style protection plugin for Spigot-based Minecraft servers. It allows players to form towns, claim chunks, and manage communities. Key features include cross-server support for towns and claims, interactive chat-based menus (instead of chest GUIs), and integration with Dynmap, BlueMap, Pl3xMap, Plan, LuckPerms, and HuskHomes.

  5. Overview of SchematicUpload

    SchematicUpload is a Spigot plugin that allows players to upload and download schematics to/from a server via a secure web panel. It eliminates the need for administrators to manually import player schematics. The system works by providing players with a unique authentication code via an in-game command, which they use to access the web interface and upload their files directly to the server's schematics folder.

  6. Overview of Minecraft plugins by William278

    William278 develops several open-source Minecraft server software projects and plugins, including:

    • HuskHomes: A suite for homes, warps, and teleportation.
    • HuskSync: A cross-server player data synchronization system.
    • HuskTowns: A cross-server Towny-style protection solution.
    • HuskClaims: A cross-server compatible grief prevention plugin.
    • Velocitab: A TAB list plugin specifically for Velocity proxies.
    • PAPIProxyBridge: A library plugin that enables the use of PlaceholderAPI on proxy servers.

  7. Overview of HuskSync player data synchronization

    HuskSync is a cross-server player data synchronization system designed for BungeeCord or Velocity networks running Paper or Fabric servers. It uses optimized Redis caching to ensure fast data synchronization when players switch servers.

    Supported synchronized data includes:

    • Inventories and Ender Chests
    • Health, Hunger, and Potion Effects
    • Advancements and Statistics
    • XP, Game Mode, and Attributes
    • Player Location
    • Locked Maps (Map Art syncing is available on Paper only)
    • Persistent Data
    • Economy Balance (Note: The author recommends using a dedicated cross-server economy plugin like XConomy or RedisEconomy for balance syncing).

    Additionally, the system provides tools to backup, restore, and rotate player data snapshots in-game.

  8. Overview of HuskBungeeRTP functionality

    HuskBungeeRTP provides cross-server random teleportation (RTP) across a proxy network. It uses an 'origin' server (where the command is run) and a 'destination' server (where the player is sent). The process involves:

    1. The origin server selects a destination server based on random choice or load-balancing (via Plan hook).
    2. The origin server requests a safe location from the destination server via Redis.
    3. The destination server identifies a safe spot (optionally using JakesRTP for better performance).
    4. The origin server uses HuskHomes to execute the cross-server teleport.

  9. Overview of Velocitab

    Velocitab is a Velocity proxy plugin that manages TAB menus using scoreboard team client-bound packets to sort player lists without requiring a backend plugin. It supports RGB formatting, animations, multiple TAB menus for different server groups, and customizable player nametags.

  10. Overview of HuskSync supported synchronization features

    HuskSync synchronizes various player profile elements across servers. When a feature is enabled, data is synced; when disabled, the player inherits data from the local server's player data file.

    Supported Features:

    • Inventories (including selected hotbar slot)
    • Ender chests (including Purpur's custom resizing, provided it is enabled on all servers)
    • Health (points and scale)
    • Hunger (saturation and exhaustion)
    • Attributes (max health, movement speed, reach, etc.)
    • Experience (level, points, and score)
    • Potion effects
    • Advancements, recipes, and progress
    • Game modes
    • Flight status
    • Statistics
    • Location (coordinates and world; intended for mirrored worlds/RPG servers)
    • Persistent Data Container (custom plugin persistent data key map)
    • Locked maps (saves pixel canvas grid to map NBT and generates virtual maps on other servers)

    Unsupported Features:

    • Unlocked maps/treasure maps (data is stored in world files and is dynamic)
    • Economy balances (Vault economy; users are encouraged to use economy plugins with built-in cross-server synchronization)

    Compatibility Notes:

    • Modded items (e.g., Arclight) are reported to work in v3.x+ but are not officially supported.
    • Plugin-created items (e.g., SlimeFun, MMOItems) generally sync correctly but should be tested.

  11. Overview of PagineDown library

    PagineDown is a library used to generate paginated chat menu lists formatted with MineDown. It requires Java 11+ and runs on the adventure platform (or platforms with adventure adapters). It is not a standalone library; it must be used in conjunction with MineDown-adventure, and the project must shade MineDown-adventure to function correctly.

  12. Overview of Serial Loops editing suite

    Serial Loops is a cross-platform editing suite (Windows, Mac, and Linux) designed for the Nintendo DS game 'Suzumiya Haruhi no Chokuretsu' (The Series of Haruhi Suzumiya). It provides a set of tools to modify various game assets, including graphics, UI, music, scripts, fonts, and save files.