RPG Mounts Framework

An advanced, high-performance, and fully configurable mount system designed to bring immersive, category-specific riding physics to your Minecraft world. Whether you want to traverse deep oceans on aquatic beasts, scale mountains, or fly through the skies, RPG Mounts Framework provides the complete engine to create, manage, and ride custom mounts.

Featuring dynamic visual UI screens and in-game creator tools for server operators

🎮 Player Features

📖 1. RPG Mounts Bestiary (Codex)

Unlock, record, and summon your mounts from a premium, dark-themed bestiary interface.

• 3D Rotating Viewports: Interact with a live 3D preview of each mount.
• Unlock Progress: Undiscovered mounts show up as mysterious dark silhouettes with general lore descriptions until you unlock/tame them.
• Summon & Dismiss: Instantly call your active mount to your side (Green button) or send them back to the stable (Red button) with one click.
• Waypoints Color Inheritance: If RPG Waypoints and Compass is installed, the bestiary and Interfaces automatically inherits its active UI border, slot, and background theme colors!

🎒 2. Mount Gear & Cargo Storage

Equip your mount with specialized accessories to improve performance and carry inventory.

• Saddle & Armor Slots: Equip saddles to control riding, and armor (such as horse armor) to increase your mount's defensive values.
• Sliding Cargo Panel: Equipping chests, barrels, or shulker boxes onto the mount slides open an extra cargo storage grid. Grid sizes scale dynamically based on the container type.
• Enhancer Sockets: Slot custom admin-created enhancer gems to apply specific buffs (like speed boosts or health recovery) to your mount.

🌊 3. Habitat-Specific Riding Physics

Traverse your world using physics tailored to the mount's habitat.

• Ground Mounts: High-speed land traversal, smooth step-height increases, and customizable jump limits.
• Aquatic Mounts: True 3D underwater navigation. Rise and descend smoothly inside fluids using the Jump key (Spacebar) to swim up, and the Sprint key (Ctrl) to dive.
• Flying Mounts: Pitch/yaw-based flight controls, complete vertical hovering, and smooth banking rotations that roll the model visually into sharp turns.
• Stamina Rules: Active traversal consumes stamina over time, which automatically triggers speed penalties when depleted, encouraging players to rest their mount.

⚡ 4. Periodic Kinematic Speed Pulsing

Simulate natural movement beats during flight and swimming.

🛠️ Admin Features

🖥️ 1. In-Game Mount Creator

Design and customize new mount templates directly inside the game using an expansive, dynamically scaling GUI editor.

• Flexible Model Integrations: Configure any model type! Supports standard Vanilla mobs (e.g. horses, wolves), GeckoLib animated JSON models, and custom Java classes (With instructions for MCModels as well!).
• Visual Seating Editor: Position riding seats visually using X/Y/Z offset coordinates, and assign multiple passenger seats (with a toggle to show/hide riders).
• Sound & Particle Registers: Map custom ambient, step, hurt, and death sounds (supports standard resource locations like minecraft:entity.wolf.growl), and define summon particle triggers.
• Auto-Scaling viewports: The creator UI reads model geometries dynamically, automatically auto-scaling and centering even the largest models so they never clip outside the preview screen.

🗄️ 2. Asynchronous SQLite Engine

Built to ensure zero lag, even on high-population servers.

• Asynchronous Database Queue: Tames, bestiary discoveries, gear, and stats are saved to a localized world SQLite database via a separate, single-threaded queue to prevent server main thread freezes.
• Dual-Layer Caching: Mount details are loaded into memory on login for instantaneous GUI popups, with scheduled dirty-write flushes happening in the background.
• Orphan Recovery Policy: If a custom template is removed, the engine automatically reconciles orphaned tames, mapping them back to the closest active parent template or base type without crashing the game.

🔧 3. Configuration & Commands

Administrators can configure mod settings inside the server_config.json file or use in-game commands (Permission Level 2 required):

💬 Command Reference

Player Commands

All players can execute the following commands to summon and manage active tames: /rpg_mounts summon <instance_id> - Summons one of your unlocked mounts by its instance ID. /rpg_mounts dismiss - Dismisses your active summoned mount.

/rpg_mounts whistle - Recalls your active mount to your current coordinate.

/rpg_mounts status - Shows details of all your unlocked mounts.

Admin Commands

Administrators (Permission level 2/Operator required) can execute the following commands to configure mounts: /rpg_mounts admin admin-mode - Toggles admin mode on/off (Changes the UI from the waypoints and compass).

/rpg_mounts admin config-editor - Opens the main configuration editor GUI.

/rpg_mounts admin creator-ui - Opens the visual Mount Creator editor GUI.

/rpg_mounts admin enhancer-creator - Opens the Enhancer Creator GUI.

/rpg_mounts admin ability-creator - Opens the Ability Creator GUI.

/rpg_mounts admin add-mount <player> <mount_id> - Unlocks a mount template for a specific player.

/rpg_mounts admin remove-mount <player> <instance_id> - Removes an unlocked mount from a player.

/rpg_mounts admin scale-mount <mount_id> <scale> - Overrides the visual scale of a mount template.

/rpg_mounts admin create-enhancer <category> <type> <value> - Spawns a custom enhancer item (defense, movement, damage, or ability) with the given modifier value.

/rpg_mounts admin create-enhancer ability grant_ability <ability_name> - Spawns an enhancer item that grants a specific custom mount ability.

/rpg_mounts admin load-mount <mount_id> - Dynamically loads a mount template from the unpacked configuration folder.

/rpg_mounts admin unload-mount <mount_id> - Unloads a mount template, removing it from the templates registry.

/rpg_mounts admin create-mount <mount_id> - Creates a new blank mount JSON template.

/rpg_mounts admin edit-mount <mount_id> <property> <value> - Edits individual JSON template parameters (e.g. name, modelType, maxHealth, movementSpeed).

/rpg_mounts admin delete-mount <mount_id> - Deletes a mount template and its config files.

/rpg_mounts admin pack-mount <mount_id> - Packs a mount template directory into a shareable ZIP inside the packs folder (config\RPG Mounts\Mounts\Packed).

/rpg_mounts admin load-packed-mount <mount_name> - Unpacks and registers a zipped template from the packs folder.

📌 Dependencies & Installation

• Fabric: Requires Architectury API and Fabric API.
• Forge: Requires Architectury API.