> For the complete documentation index, see [llms.txt](https://donkolia.gitbook.io/minesantum/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://donkolia.gitbook.io/minesantum/santumhorses.md). # SantumHorses {% embed url="" %} **SantumHorses** is an advanced Minecraft server plugin that revolutionizes the mount system, turning horses into loyal companions with upgradeable stats, dynamic inventories (saddlebags), and combat skills. Everything is fully customizable ## ✨ Main Features * **Ownership System and Active Horse:** Tame a horse to make it yours. You can only have one "active" horse at a time. The horse is linked to you * **Remote Call:** Use `/shorses call` to make your horse come to you from anywhere, as long as it isn't scared by nearby monsters (Bravery System) * **Despawn and Safe Storage:** You can despawn your horse when you don't need it with `/shorses despawn`. Its health, saddlebags, and stats are saved in a fast and lightweight SQLite database * **Upgradeable Stats (RPG):** Open an interactive GUI menu by Shift + Right Clicking your horse with a saddle. Upgrade its attributes in exchange for money or custom conditions: * ⚡ **Speed:** Increases its movement speed * 🦘 **Jump:** Improves its maximum jump height * ❤️ **Max Health:** Increases its endurance in combat * 🦁 **Bravery:** Prevents it from getting scared when called if there are enemies nearby * **Dynamic Saddlebags (Inventory):** The horse has its own inventory that no one can steal if it's locked. You can upgrade its capacity (9, 18, 27, and up to 36 slots) through commands or conditions in the config * **Combat Skills:** * 💥 **Heavy Charge:** Press the **F key** (swap hands) while riding on the ground to dash forward, charging and damaging entities in your path * **Sacrifice Healing:** You can heal your horse by sacrificing your own health (hearts) from the interface * **Secure Locking System:** Toggle between locked and unlocked horse in the interface. If locked, no other player can ride it or steal from its saddlebags * **Powerful Action and Condition Engine:** * Native support for **PlaceholderAPI** * Support for **Native Math** in conditions (e.g., `%player_level%-1 >= 10`) * Execute custom actions if the player meets or fails the requirements (Messages, Centered Messages, Console Commands, Player Commands, etc.) ## 📜 Commands | Command | Description | Permission | | ------------------------------------- | ------------------------------------------------ | ------------------------- | | `/shorses call` | Summons your active horse to your location | `santumhorses.call` | | `/shorses despawn` | Saves your horse in the database and despawns it | `santumhorses.despawn` | | `/shorses upgradeinv <9\|18\|27\|36>` | Upgrades the horse's saddlebag capacity | `santumhorses.upgradeinv` | | `/shorses reload` | Reloads the `config.yml` and `stats.yml` files | `santumhorses.admin` | *Aliases: You can use `/santumhorses` or `/shorses`* ## 🔐 Permissions * `santumhorses.*` - Grants access to all plugin commands * `santumhorses.call` - Allows calling the horse * `santumhorses.despawn` - Allows despawning the horse * `santumhorses.upgradeinv` - Allows upgrading the horse's saddlebags * `santumhorses.admin` - Allows using admin tools (reload config) ## ⚙️ Configuration Files The plugin is fully customizable through two main files generated in its folder: ### 1. `config.yml` * Contains global settings, such as enemy radius and locking options. * All plugin messages (Supports `&` color codes) * Configuration for the logic engine of `call-horse`, `upgrade-inv`, and `push-power` (Heavy Charge) with customizable conditions and actions ### 2. `stats.yml` * Full control over the attributes GUI (speed, jump, health, bravery) * Configure how much upgrades cost, who can downgrade them, and what actions (take money, give items, run commands) are executed with each click ## 💻 Optional/Supported Dependencies * [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) - Recommended to use player variables (`%player_name%`, `%vault_eco_balance%`, `%player_level%`) in your conditions and messages * \[Vault] - You can use Vault's PlaceholderAPI variables to charge money for calling or upgrading ## 📊 PlaceholderAPI Variables The plugin exposes the following variables that you can use in menus, holograms, scoreboards, or even within the plugin's own configuration: * `%santumhorses_speed%` - Current speed level of your active horse * `%santumhorses_speed_min%` - Minimum possible speed level * `%santumhorses_speed_max%` - Maximum possible speed level * `%santumhorses_jump%` - Current jump level of your active horse * `%santumhorses_jump_min%` - Minimum possible jump level * `%santumhorses_jump_max%` - Maximum possible jump level * `%santumhorses_health%` - Current max health of your active horse * `%santumhorses_health_min%` - Minimum possible max health * `%santumhorses_health_max%` - Maximum possible max health * `%santumhorses_bravery%` - Current bravery of your active horse * `%santumhorses_bravery_min%` - Minimum possible bravery * `%santumhorses_bravery_max%` - Maximum possible bravery *(If the player does not have an active horse, the variables will return `0`)* **Author:** DonKolia --- # 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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://donkolia.gitbook.io/minesantum/santumhorses.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.