Documentation
Full docs:
xcutiboo.github.io/MythicRod
Install
- Drop MythicRod-Paper-2026.1.0.jar in plugins/.
- Start the server. config.yml and drops.yml get generated on first run.
- Edit config.yml or drops.yml, then run /mythicrod reload to apply.
Configuration
- config.yml. Top-level toggles: sounds, particles, statistics, biome-drops, permissions, debug, delivery-mode, language, stats-save-interval-seconds, rod luck multipliers.
- drops.yml. Drop categories with weighted entries. Each entry can declare biomes, permission, custom name, lore, enchantments, glow, item flags, custom-model-data, and a Nexo id.
- lang/. Locale yaml files. en_US and ja_JP ship in the jar. Drop more files in plugins/MythicRod/lang/ to add languages.
Commands
See the overview tab.
Permissions
See the overview tab.
Developer API
Add the JitPack repo and depend on mythicrod-api:
Code (Text):
repositories {
maven("https://jitpack.io")
}
dependencies {
compileOnly("com.github.xcutiboo:MythicRod:v2026.1.1")
}
Look the API up through Bukkit's services manager. The mythicrod-paper module ships a tiny helper:
Code (Text):
import io.xcutiboo.mythicrod.api.MythicRodAPI;
import io.xcutiboo.mythicrod.paper.api.MythicRodServices;
MythicRodAPI api = MythicRodServices.require(); // throws if MythicRod is not loaded
MythicRodServices.find().ifPresent(api -> { /* optional integration */ });
What the API gives you
- createRod(tier). One-call rod creation. Tier: basic, advanced, legendary, mythic.
- previewEligibleDrops(uuid, biomeKey). What the player would roll at that biome, after permission and biome filters.
- External drop providers. registerExternalDropProvider / unregisterExternalDropProvider / get / list.
- Stats lookup. Async getPlayerStats(uuid), getTopPlayers(statType, limit), flushAllStats().
- Item factory. createItem(identifier, amount).
Events
- MythicRodBiteEvent. Fires when a fish bites a MythicRod-tagged rod. Cancellable. Use it for skill-check minigames.
- MythicRodRewardRollEvent. Fires after eligible drops are picked but before the reward is built. Bias selection with setLuckMultiplier or forceDrop.
- MythicRodFishCatchEvent. Fires after selection. Cancellable. Mutable reward ItemStack.
- MythicRodStatsUpdateEvent. Read-only. Per-catch stat snapshot.
- MythicRodReloadEvent. Fires after a config and drop reload finishes.
PlaceholderAPI tokens
- %mythicrod_total% lifetime catches
- %mythicrod_common% / _uncommon% / _rare% / _legendary% per-tier catches
- %mythicrod_rod_tier% selected rod tier (basic, advanced, legendary, mythic)
- %mythicrod_version% running plugin version
Runtime notes
- Paper 1.21+ or Folia is the supported runtime.
- Spigot might still run it. Untested. Some Adventure, Brigadier, or Folia paths may misbehave.
- Java 21+.