FabricHub Mod Documentation

This documentation provides a complete guide to configuring and using the FabricHub mod.

0. Installation & Compatibility

Minecraft Version Support: 1.21.x (Any version starting with 1.21) Fabric Loader: 0.16.9 or newer

⚠️ Important Requirement: You must install the Fabric API version that matches your Minecraft version.

• If using Minecraft 1.21.1 -> Install Fabric API for 1.21.1
• If using Minecraft 1.21.8 -> Install Fabric API for 1.21.8
• The mod itself works on all of them, but the API must match the game version.

1. Commands

Player Commands

These commands are available to all players.

• /hub (or /lobby)

  • Description: Teleports you to the server's hub/lobby spawn point.
  • Behavior: Saves your current location before teleporting, allowing you to return later.

• /back

  • Description: Teleports you back to the location you were at before using /hub.
  • Usage: Useful for returning to your survival adventure after visiting the hub.

• /navigator

  • Description: Opens the Server Navigator menu (GUI).
  • Note: You can also use the "Server Navigator" item in your inventory.

• /toggleplayers

  • Description: Toggles the visibility of other players in the hub.
  • Usage: Hides/Shows other players to reduce lag or clutter.

• /register

  • Description: Registers your account (if authentication is enabled).
  • Usage: /register MyName MyPassword123 MyPassword123

• /login

  • Description: Logs you in.
  • Usage: /login MyPassword123

Admin Commands

These commands require Operator (OP) Level 2 permissions.

• /sethub

  • Description: Sets the global Hub spawn point to your current location and rotation.
  • Usage: Stand exactly where you want players to spawn and run the command.

• /sethubradius

  • Description: Sets the radius of the protected hub area.
  • Usage: /sethubradius 150 (Sets protection to 150 blocks from the hub spawn).
  • Effect: Inside this radius, players cannot break blocks, take damage, or lose hunger (depending on config).

---

2. Configuration (config/fabrichub.json)

The configuration file is located at config/fabrichub.json in your server folder. It is automatically generated on the first run.

Hub Settings (hub)

• radius: (Integer) The radius in blocks around the spawn point that is considered "The Hub".
• teleportOnJoin: (Boolean) If true, players are sent to the hub every time they join.
• voidTpEnabled: (Boolean) If true, players falling into the void in the hub world are teleported back to spawn.
• voidTpY: (Double) The Y-level at which the void teleport triggers.

Gameplay Features (gameplay)

• doubleJumpEnabled: (Boolean) Allows players to double-jump in the hub.
• doubleJumpCooldown: (Integer) Ticks between double jumps (20 ticks = 1 second).
• disableDamage: (Boolean) Prevents all damage in the hub.
• noHunger: (Boolean) Prevents hunger loss in the hub.
• protectWorld: (Boolean) Prevents block breaking/placing in the hub.
• disableDrops: (Boolean) Prevents players from dropping items in the hub.
• disablePickups: (Boolean) Prevents players from picking up items in the hub.
• rideablePlayers: (Boolean) Allows players to right-click others to ride them (stacking).
• silkTouchSpawners: (Boolean) Allows players to mine spawners with Silk Touch.
• mobsDropHeads: (Boolean) Adds a chance for mobs to drop their heads when killed.

Hub Items (hubItems)

• giveOnJoin: (Boolean) If true, players receive Hub Items (Navigator, etc.) on join.
• navigatorSlot: (Integer) Inventory slot for the Navigator (0-8 for hotbar).
• visibilitySlot: (Integer) Inventory slot for the Player Hider.

Navigator Menu (navigator)

• enabled: (Boolean) Enables the navigator system.
• title: (String) The title of the chest GUI.
• items: (List) Configure the buttons in the menu. You can add new buttons here!
  • command: The command to run when clicked (e.g., server survival, hub, back).

Authentication (auth)

• enabled: (Boolean) Enables the login/register system.
• minPasswordLength: (Integer) Minimum required characters for passwords.
• maxLoginAttempts: (Integer) Kicks player after this many failed attempts.

Resource Pack (resourcePack)

• enabled: (Boolean) Enables sending a server resource pack.
• url: (String) Direct download link to the .zip file.
• hash: (String) SHA-1 hash of the pack (optional but recommended).
• required: (Boolean) If true, players must accept the pack to play.
• promptMessage: (String) Message shown to the player.

Teleportation (teleport)

• rateLimitEnabled: (Boolean) Limits how many players can teleport at once to prevent lag.
• maxPlayersPerTick: (Integer) Max teleports per tick.
• queueEnabled: (Boolean) Queues teleports if the limit is reached.
• useLastLocation: (Boolean) If true, players are sent to their last known location after login (if not sent to hub).

---

3. Installation

1. Place the .jar file into your server's mods folder.
2. Ensure you have Fabric API installed.
3. Start the server.
4. Edit config/fabrichub.json to your liking.
5. Run /reload or restart the server to apply changes.