|
| 1 | +# Installation |
| 2 | + |
| 3 | +## Table of Contents |
| 4 | + |
| 5 | +- [Prerequisites](#prerequisites) |
| 6 | +- [Download Nightly Build](#download-nightly-build) |
| 7 | +- [Build from Source](#build-from-source) |
| 8 | +- [Installation](#installation-1) |
| 9 | +- [Configuration](#configuration) |
| 10 | +- [Features](#features) |
| 11 | +- [Troubleshooting](#troubleshooting) |
| 12 | + |
| 13 | +--- |
| 14 | + |
| 15 | +## Prerequisites |
| 16 | + |
| 17 | +- [Paper](https://papermc.io/) Minecraft server 1.21.11 |
| 18 | +- Java 21 or newer |
| 19 | + |
| 20 | +## Download Nightly Build |
| 21 | + |
| 22 | +Download pre-built JARs from GitHub releases. |
| 23 | + |
| 24 | +### Setup |
| 25 | + |
| 26 | +1. Download the latest release: |
| 27 | + ```bash |
| 28 | + curl -L -o VanillaPlus.jar https://github.com/XodiumSoftware/VanillaPlus/releases/download/nightly/VanillaPlus.jar |
| 29 | + ``` |
| 30 | + |
| 31 | +2. Place the JAR in your server's `plugins/` directory |
| 32 | + |
| 33 | +## Build from Source |
| 34 | + |
| 35 | +Build the plugin using Gradle. |
| 36 | + |
| 37 | +### Prerequisites |
| 38 | + |
| 39 | +- [JDK 21](https://adoptium.net/) or newer |
| 40 | +- [Git](https://git-scm.com/) |
| 41 | + |
| 42 | +### Setup |
| 43 | + |
| 44 | +1. Clone the repository: |
| 45 | + ```bash |
| 46 | + git clone https://github.com/XodiumSoftware/VanillaPlus.git |
| 47 | + cd VanillaPlus |
| 48 | + ``` |
| 49 | + |
| 50 | +2. Build the plugin: |
| 51 | + ```bash |
| 52 | + ./gradlew shadowJar |
| 53 | + ``` |
| 54 | + |
| 55 | +3. The output JAR is at: |
| 56 | + ``` |
| 57 | + build/libs/VanillaPlus-*.jar |
| 58 | + ``` |
| 59 | + |
| 60 | +### Run a Test Server |
| 61 | + |
| 62 | +To quickly test the plugin: |
| 63 | + |
| 64 | +```bash |
| 65 | +./gradlew runServer |
| 66 | +``` |
| 67 | + |
| 68 | +This automatically downloads Paper 1.21.11 and starts a local test server with the plugin. |
| 69 | + |
| 70 | +## Installation |
| 71 | + |
| 72 | +1. Place `VanillaPlus.jar` in your server's `plugins/` directory |
| 73 | +2. Start or restart the server |
| 74 | +3. The plugin will enable automatically |
| 75 | + |
| 76 | +## Configuration |
| 77 | + |
| 78 | +VanillaPlus uses **compile-time configuration** — there are no config files to edit. All settings are hardcoded in the source code. |
| 79 | + |
| 80 | +To customize the plugin, you must: |
| 81 | + |
| 82 | +1. Fork the repository |
| 83 | +2. Edit the `Config` objects in each module |
| 84 | +3. Rebuild the plugin |
| 85 | + |
| 86 | +### Module Configuration Location |
| 87 | + |
| 88 | +Each module has a nested `Config` object, for example: |
| 89 | + |
| 90 | +```kotlin |
| 91 | +// In src/main/kotlin/org/xodium/vanillaplus/modules/PlayerModule.kt |
| 92 | +object Config { |
| 93 | + const val ENABLED = true |
| 94 | + // ... other settings |
| 95 | +} |
| 96 | +``` |
| 97 | + |
| 98 | +## Features |
| 99 | + |
| 100 | +VanillaPlus enhances base gameplay with custom enchantments, items, and mechanics. |
| 101 | + |
| 102 | +### Enchantments |
| 103 | + |
| 104 | +Eleven custom enchantments are available: |
| 105 | + |
| 106 | +| Enchantment | Slot | Description | |
| 107 | +|-------------|------|-------------| |
| 108 | +| Verdance | Main Hand | Enhances hoe abilities | |
| 109 | +| Tether | Main Hand | Applies to tools and weapons | |
| 110 | +| Nimbus | Saddle | Happy Ghast harness enhancement | |
| 111 | +| Earthrend | Main Hand | Pickaxe special ability | |
| 112 | +| Embertread | Feet | Foot armor enhancement | |
| 113 | +| **Blaze Rod Spells** | | | |
| 114 | +| Inferno | Main Hand | Fire spell | |
| 115 | +| Skysunder | Main Hand | Lightning spell | |
| 116 | +| Witherbrand | Main Hand | Wither spell | |
| 117 | +| Frostbind | Main Hand | Ice spell | |
| 118 | +| Tempest | Main Hand | Wind spell | |
| 119 | +| Voidpull | Main Hand | Teleportation spell | |
| 120 | +| Quake | Main Hand | Earth spell | |
| 121 | + |
| 122 | +### Mana System |
| 123 | + |
| 124 | +Blaze Rod spells share a single mana pool: |
| 125 | + |
| 126 | +- **Maximum**: 100 mana |
| 127 | +- **Regeneration**: Automatic over time |
| 128 | +- **Display**: Boss bar shows current mana |
| 129 | +- **Refill**: Use "Potion of Arcane Restoration" |
| 130 | + |
| 131 | +### Wand Mechanics |
| 132 | + |
| 133 | +Blaze rods with spell enchantments function as wands: |
| 134 | + |
| 135 | +- **Left-click**: Cast selected spell |
| 136 | +- **Right-click**: Cycle through available spells |
| 137 | +- **Compatible**: All seven spells can be on one wand |
| 138 | + |
| 139 | +### Custom Items |
| 140 | + |
| 141 | +- **Potion of Arcane Restoration**: Refills mana to maximum |
| 142 | + - Brew: Awkward Potion + Blaze Rod |
| 143 | + - Color: Purple (`#832466`) |
| 144 | + |
| 145 | +### Recipes |
| 146 | + |
| 147 | +Custom crafting and brewing recipes: |
| 148 | + |
| 149 | +- Chainmail armor crafting |
| 150 | +- Diamond recycle (smelting) |
| 151 | +- Mana potion brewing |
| 152 | +- Custom paintings |
| 153 | +- Rotten flesh to leather |
| 154 | +- Log crafting improvements |
| 155 | + |
| 156 | +## Troubleshooting |
| 157 | + |
| 158 | +### "Plugin disabled itself" |
| 159 | + |
| 160 | +- Verify server version is Paper 1.21.11 |
| 161 | +- Check console for version mismatch errors |
| 162 | +- Update your server or use a compatible plugin version |
| 163 | + |
| 164 | +### "Enchantments not showing" |
| 165 | + |
| 166 | +- Enchantments are registered during server startup |
| 167 | +- Check console for bootstrap errors |
| 168 | +- Ensure you're using Paper (not Spigot or Bukkit) |
| 169 | + |
| 170 | +### Build fails |
| 171 | + |
| 172 | +- Verify Java 21 is installed and active: |
| 173 | + ```bash |
| 174 | + java -version |
| 175 | + ``` |
| 176 | +- Make sure `JAVA_HOME` is set correctly |
| 177 | +- Try cleaning the build: |
| 178 | + ```bash |
| 179 | + ./gradlew clean |
| 180 | + ./gradlew shadowJar |
| 181 | + ``` |
| 182 | + |
| 183 | +### Ktlint errors |
| 184 | + |
| 185 | +The project uses ktlint for code style. Fix formatting: |
| 186 | + |
| 187 | +```bash |
| 188 | +./gradlew ktlintFormat |
| 189 | +``` |
| 190 | + |
| 191 | +### Mana bar not appearing |
| 192 | + |
| 193 | +- Must have a Blaze Rod with spell enchantments in main hand |
| 194 | +- Mana bar appears only when holding a valid spell wand |
| 195 | + |
| 196 | +--- |
| 197 | + |
| 198 | +<p align="right"><a href="#readme-top">▲</a></p> |
0 commit comments