**Author:** RajaAditya **Website:** [rajaaditya.my.id](https://rajaaditya.my.id) **Version:** 1.0 **API:** Paper 1.21.x --- ## Features ### Personal Milestone - Each player has their own independent personal milestone progress - Multi-level system — all tasks in the current level must be completed before advancing to the next - Each task has its **own reward** granted immediately upon completion - Notification message + firework effect on task completion and level-up ### Island Milestone - Per-island milestone — all island members contribute together - 5 independent categories: **Slayer, Mining, Farming, Woodcutting, Fishing** - Each category has its own level progression - Task rewards are granted to **all online island members** upon completion - Island progress is preserved even if a member leaves the island ### Interactive GUI - Main Menu → choose between Personal or Island Milestone - Personal GUI → shows all tasks and progress for the current level - Island Overview → shows all 5 categories with their current levels - Island Detail → click a category to view its tasks and progress - When **MAX LEVEL** is reached: items change to `GREEN_DYE` with "MAX LEVEL" status ### PlaceholderAPI Support - 6 ready-to-use placeholders for scoreboards, holograms, and more ### Fully Configurable - All messages, tasks, rewards, and GUI elements are configurable without touching any code - `/milestone reload` reloads all config files without restarting the server --- ## Dependencies | Plugin | Required | Purpose | |--------|----------|---------| | [SuperiorSkyblock2](https://github.com/BG-Software-LLC/SuperiorSkyblock2) | **Yes** | Island system | | [PlaceholderAPI](https://github.com/PlaceholderAPI/PlaceholderAPI) | **Yes** | Placeholder support | --- ## Installation 1. Make sure **SuperiorSkyblock2** and **PlaceholderAPI** are already installed and running 2. Place `RA-IslandMilestone.jar` into your `plugins/` folder 3. Restart the server 4. Edit the config files in `plugins/RA-IslandMilestone/` to your liking 5. Use `/milestone reload` to apply config changes without restarting --- ## File Structure ``` plugins/RA-IslandMilestone/ ├── config.yml # General settings (prefix, firework, autosave) ├── messages.yml # All plugin messages ├── milestone.yml # Task, level, and reward definitions ├── gui.yml # GUI layout and appearance └── data/ ├── playerdata/ │ └── [UUID].yml # Personal milestone progress per player └── islanddata/ └── [UUID].yml # Island milestone progress (keyed by island UUID) ``` --- ## Configuration ### config.yml ```yaml settings: prefix: "&8[&bRA-Milestone&8]&r" # true = only track activity inside a SuperiorSkyblock island world # false = track activity anywhere island-world-only: true # Auto-save data every X minutes (0 = disabled) autosave-interval: 10 firework: duration: 30 # Ticks before the firework detonates type: BALL_LARGE # BALL | BALL_LARGE | STAR | BURST | CREEPER colors: - "YELLOW" - "GOLD" trail: true flicker: true ``` --- ### messages.yml All messages displayed by the plugin. Supports `&` color codes. ```yaml personal-milestone: level-complete: "&a&lPERSONAL MILESTONE &7» &eLevel {level} complete! Congratulations, {player}!" task-complete: "&a&lTASK COMPLETE &7» &e{task} &7has been completed!" island-milestone: level-complete: "&b&lISLAND MILESTONE &7» &eCategory {category} Level {level} complete!" task-complete: "&b&lISLAND TASK &7» &e{category} &7- &f{task} &7complete!" commands: no-permission: "&cYou do not have permission to do this!" player-not-found: "&cPlayer &e{player} &cwas not found!" reload-success: "&aPlugin reloaded successfully!" reset-success: "&aData has been reset!" no-island: "&cYou do not have an island!" console-only-gui: "&cThis command can only be used by a player!" invalid-uuid: "&cInvalid UUID: &e{uuid}" invalid-number: "&cLevel must be a number!" invalid-category: "&cInvalid category! Valid: &eslayer, mining, farming, woodcutting, fishing" force-complete-success: "&aForce completed personal level &e{level} &afor &e{player}&a!" set-level-success: "&aSet island &e{uuid} &acategory &e{category} &ato level &e{level}&a!" level-not-found: "&cLevel &e{level} &cwas not found in the config!" help: - "&8&m----&r &bRA-Milestone &8&m----" - "&7/milestone &e- &fOpen the milestone GUI" - "..." ``` **Available placeholders in messages:** | Placeholder | Available In | |-------------|-------------| | `{player}` | personal messages, command feedback | | `{level}` | level-complete, force-complete-success, set-level-success | | `{task}` | task-complete | | `{category}` | island level-complete, island task-complete | | `{uuid}` | invalid-uuid, set-level-success | --- ### milestone.yml The main file for defining all tasks, levels, and rewards. **You can add as many levels as you want.** #### Personal Milestone Structure ```yaml personal: level-1: # Level key (level-1, level-2, etc.) display-name: "Beginner" # Level name shown in the GUI tasks: task-key: # Task key (any unique string per level) type: CREATE_ISLAND # Task type (see Task Types section) target: 1 # Progress target display: "Create Island" # Task name shown in the GUI rewards: # List of console commands; {player} = player name - "give {player} diamond 5" - "eco give {player} 1000" ``` #### Island Milestone Structure ```yaml island: slayer: # Category (slayer/mining/farming/woodcutting/fishing) level-1: display-name: "Beginner Slayer" tasks: slay-sheep: type: SLAY_MOB mob: SHEEP # Entity type filter (Bukkit EntityType name) target: 300 display: "Kill Sheep" rewards: - "give {player} white_wool 32" ``` --- ## Task Types ### Personal Milestone | Type | Extra Field | Trigger | Notes | |------|-------------|---------|-------| | `CREATE_ISLAND` | — | Player creates a new island | One-time task, use `target: 1` | | `HARVEST_CROP` | — | Player breaks a fully-grown crop | All crop types count | | `BREED_ANIMAL` | — | Player breeds an animal | All breedable animals count | | `KILL_HOSTILE` | — | Player kills a hostile mob | All entities implementing `Monster` | --- ### Island Milestone — Slayer | Type | Extra Field | Description | |------|-------------|-------------| | `SLAY_MOB` | `mob: ` | Kill a specific entity type | **Valid `mob` values:** | | | | | | |--|--|--|--|--| | `SHEEP` | `COW` | `PIG` | `CHICKEN` | `RABBIT` | | `ZOMBIE` | `SKELETON` | `CREEPER` | `SPIDER` | `ENDERMAN` | | `BLAZE` | `WITHER_SKELETON` | `DROWNED` | `HUSK` | `STRAY` | | `WITCH` | `PIGLIN` | `HOGLIN` | `PHANTOM` | `GUARDIAN` | | `ELDER_GUARDIAN` | `SHULKER` | | | | --- ### Island Milestone — Mining | Type | Extra Field | Description | |------|-------------|-------------| | `MINE_BLOCK` | `block: ` | Break a specific block type | **Valid `block` values:** | | | | | | |--|--|--|--|--| | `COBBLESTONE` | `STONE` | `GRAVEL` | `SAND` | `COAL_ORE` | | `IRON_ORE` | `GOLD_ORE` | `DIAMOND_ORE` | `EMERALD_ORE` | `LAPIS_ORE` | | `REDSTONE_ORE` | `DEEPSLATE_COAL_ORE` | `DEEPSLATE_IRON_ORE` | `DEEPSLATE_GOLD_ORE` | `DEEPSLATE_DIAMOND_ORE` | | `DEEPSLATE_EMERALD_ORE` | `OBSIDIAN` | `NETHERRACK` | `BASALT` | `BLACKSTONE` | --- ### Island Milestone — Farming | Type | Extra Field | Description | |------|-------------|-------------| | `HARVEST_CROP` | `crop: ` | Break a specific fully-grown crop | **Valid `crop` values:** | | | | | |--|--|--|--| | `WHEAT` | `CARROTS` | `POTATOES` | `BEETROOTS` | | `MELON` | `PUMPKIN` | `NETHER_WART` | `COCOA` | | `SWEET_BERRY_BUSH` | `TORCHFLOWER` | `PITCHER_PLANT` | | --- ### Island Milestone — Woodcutting | Type | Extra Field | Description | |------|-------------|-------------| | `CHOP_LOG` | `log: ` | Break a specific log type | **Valid `log` values:** | | | | | |--|--|--|--| | `OAK_LOG` | `SPRUCE_LOG` | `BIRCH_LOG` | `JUNGLE_LOG` | | `ACACIA_LOG` | `DARK_OAK_LOG` | `MANGROVE_LOG` | `CHERRY_LOG` | | `CRIMSON_STEM` | `WARPED_STEM` | `BAMBOO_BLOCK` | | --- ### Island Milestone — Fishing | Type | Extra Field | Description | |------|-------------|-------------| | `CATCH_FISH` | `fish: ` | Catch a specific fish item | **Valid `fish` values:** `COD`, `SALMON`, `TROPICAL_FISH`, `PUFFERFISH` --- ## Commands | Command | Description | Usage | |---------|-------------|-------| | `/milestone` | Open the main milestone GUI | Player only | | `/milestone reload` | Reload all config files | Player / Console | | `/milestone reset player ` | Reset a player's personal data | Player / Console | | `/milestone reset island ` | Reset an island's milestone data | Player / Console | | `/milestone complete ` | Force complete a personal level | Player / Console | | `/milestone set ` | Set an island category level | Player / Console | > **Tip:** The `` can be found from the file names inside `plugins/RA-IslandMilestone/data/islanddata/` --- ## Permissions | Permission | Default | Description | |------------|---------|-------------| | `milestone.use` | `true` | Open the GUI with `/milestone` | | `milestone.admin.reload` | `op` | Use `/milestone reload` | | `milestone.admin.reset` | `op` | Use `/milestone reset` | | `milestone.admin.give` | `op` | Use `/milestone complete` and `/milestone set` | --- ## PlaceholderAPI This plugin registers a PlaceholderAPI expansion with the identifier `milestone`. | Placeholder | Description | No Island | |-------------|-------------|-----------| | `%milestone_personal_level%` | Player's current personal milestone level | — | | `%milestone_island_slayer_level%` | Player's island Slayer level | `0` | | `%milestone_island_mining_level%` | Player's island Mining level | `0` | | `%milestone_island_farming_level%` | Player's island Farming level | `0` | | `%milestone_island_woodcutting_level%` | Player's island Woodcutting level | `0` | | `%milestone_island_fishing_level%` | Player's island Fishing level | `0` | **Example scoreboard usage:** ``` Personal: %milestone_personal_level% Slayer: %milestone_island_slayer_level% Mining: %milestone_island_mining_level% ``` --- ## Data Format Data is stored as flat-file YAML. **Do not edit these files while the server is running.** ### playerdata/[UUID].yml ```yaml personal-level: 2 tasks: level-1: create-island: 1 harvest-crop: 100 breed-animals: 25 kill-hostile: 50 rewarded-tasks: - "level-1:create-island" - "level-1:harvest-crop" - "level-1:breed-animals" - "level-1:kill-hostile" ``` ### islanddata/[islandUUID].yml ```yaml slayer-level: 2 mining-level: 1 farming-level: 1 woodcutting-level: 1 fishing-level: 1 tasks: slayer: level-1: slay-sheep: 300 slay-cow: 300 mining: level-1: mine-cobblestone: 120 rewarded-tasks: - "slayer:level-1:slay-sheep" - "slayer:level-1:slay-cow" ``` --- ## Plugin API This plugin exposes its internal managers for integration with other plugins. ### Getting the Instance ```java import id.rajaaditya.islandmilestone.RAIslandMilestone; RAIslandMilestone plugin = (RAIslandMilestone) Bukkit.getPluginManager().getPlugin("RA-IslandMilestone"); if (plugin == null) return; // plugin is not active ``` --- ### PersonalMilestoneManager ```java PersonalMilestoneManager pmm = plugin.getPersonalMilestoneManager(); ``` | Method | Return | Description | |--------|--------|-------------| | `getLevelKey(int level)` | `String` | Converts a level number to its config key (`"level-1"`) | | `getLevelDisplayName(int level)` | `String` | Display name of the level from config | | `getTaskTarget(int level, String taskKey)` | `int` | Target progress value for a task | | `getTaskDisplay(int level, String taskKey)` | `String` | Display name of a task | | `getTaskType(int level, String taskKey)` | `String` | Task type string (`CREATE_ISLAND`, etc.) | | `getTaskRewards(int level, String taskKey)` | `List` | List of reward commands for a task | | `getTaskKeys(int level)` | `List` | All task keys defined in a level | | `levelExists(int level)` | `boolean` | Check whether a level is defined in config | | `getMaxLevel()` | `int` | Total number of personal levels in config | | `incrementTask(UUID playerUUID, String taskType, int amount)` | `void` | Increment task progress by type | | `completeCreateIsland(UUID playerUUID)` | `void` | Mark the CREATE_ISLAND task as done | | `forceComplete(UUID playerUUID, int level)` | `void` | Force complete a level and grant all its rewards | **Example:** ```java pmm.incrementTask(player.getUniqueId(), "KILL_HOSTILE", 1); ``` --- ### IslandMilestoneManager ```java IslandMilestoneManager imm = plugin.getIslandMilestoneManager(); ``` Valid categories: `slayer`, `mining`, `farming`, `woodcutting`, `fishing` | Method | Return | Description | |--------|--------|-------------| | `getLevelKey(int level)` | `String` | Converts a level number to its config key | | `getLevelDisplayName(String category, int level)` | `String` | Display name of a category level | | `getTaskTarget(String category, int level, String taskKey)` | `int` | Target progress for a task | | `getTaskDisplay(String category, int level, String taskKey)` | `String` | Display name of a task | | `getTaskType(String category, int level, String taskKey)` | `String` | Task type string | | `getTaskRewards(String category, int level, String taskKey)` | `List` | Reward commands for a task | | `getTaskKeys(String category, int level)` | `List` | All task keys in a category level | | `levelExists(String category, int level)` | `boolean` | Check whether a category level exists in config | | `getMaxLevel(String category)` | `int` | Total levels defined for a category | | `incrementTask(UUID islandUUID, String category, String taskType, String filterValue, int amount)` | `void` | Increment island task progress | | `forceSetLevel(UUID islandUUID, String category, int level)` | `void` | Force set a category level for an island | | `CATEGORIES` | `String[]` | Array of all valid category names | **Example:** ```java // Add SLAY_MOB progress for ZOMBIE in the slayer category imm.incrementTask(islandUUID, "slayer", "SLAY_MOB", "ZOMBIE", 1); // Add MINE_BLOCK progress for DIAMOND_ORE imm.incrementTask(islandUUID, "mining", "MINE_BLOCK", "DIAMOND_ORE", 1); // Pass an empty filterValue to match all tasks of that type imm.incrementTask(islandUUID, "farming", "HARVEST_CROP", "", 1); ``` --- ### DataManager ```java DataManager dm = plugin.getDataManager(); ``` | Method | Return | Description | |--------|--------|-------------| | `getPersonalData(UUID uuid)` | `PersonalData` | Get a player's personal data (loads from file if not cached) | | `loadPersonalData(UUID uuid)` | `PersonalData` | Force load personal data from file | | `savePersonalData(UUID uuid)` | `void` | Save personal data to file | | `resetPersonalData(UUID uuid)` | `void` | Delete a player's personal data | | `getIslandData(UUID islandUUID)` | `IslandData` | Get island data (loads from file if not cached) | | `loadIslandData(UUID islandUUID)` | `IslandData` | Force load island data from file | | `saveIslandData(UUID islandUUID)` | `void` | Save island data to file | | `resetIslandData(UUID islandUUID)` | `void` | Delete an island's data | | `saveAllData()` | `void` | Save all currently cached data to disk | --- ### PersonalData ```java PersonalData data = plugin.getDataManager().getPersonalData(player.getUniqueId()); ``` | Method | Return | Description | |--------|--------|-------------| | `getPlayerUUID()` | `UUID` | The player's UUID | | `getPersonalLevel()` | `int` | Current personal milestone level | | `setPersonalLevel(int level)` | `void` | Set the personal level | | `getTaskProgress(String levelKey, String taskKey)` | `int` | Progress for a specific task | | `setTaskProgress(String levelKey, String taskKey, int value)` | `void` | Set task progress | | `incrementTaskProgress(String levelKey, String taskKey, int amount)` | `void` | Add to task progress | | `getLevelProgress(String levelKey)` | `Map` | All task progress in a level | | `getAllTaskProgress()` | `Map>` | All progress across all levels | | `isTaskRewarded(String levelKey, String taskKey)` | `boolean` | Check if a task's reward has been granted | | `markTaskRewarded(String levelKey, String taskKey)` | `void` | Mark a task as rewarded | | `getRewardedTasks()` | `Set` | All rewarded task entries | --- ### IslandData ```java IslandData data = plugin.getDataManager().getIslandData(islandUUID); ``` | Method | Return | Description | |--------|--------|-------------| | `getIslandUUID()` | `UUID` | The island's UUID | | `getCategoryLevel(String category)` | `int` | Current level for a category | | `setCategoryLevel(String category, int level)` | `void` | Set a category level | | `getCategoryLevels()` | `Map` | All categories and their current levels | | `getTaskProgress(String category, String levelKey, String taskKey)` | `int` | Progress for a specific task | | `setTaskProgress(String category, String levelKey, String taskKey, int value)` | `void` | Set task progress | | `incrementTaskProgress(String category, String levelKey, String taskKey, int amount)` | `void` | Add to task progress | | `getLevelProgress(String category, String levelKey)` | `Map` | All task progress in a category level | | `getAllTaskProgress()` | `Map>>` | All progress across all categories | | `isTaskRewarded(String category, String levelKey, String taskKey)` | `boolean` | Check if a task's reward has been granted | | `markTaskRewarded(String category, String levelKey, String taskKey)` | `void` | Mark a task as rewarded | | `getRewardedTasks()` | `Set` | All rewarded task entries | --- ### Integrating with This Plugin **plugin.yml:** ```yaml depend: [RA-IslandMilestone] # or soft depend if optional: softdepend: [RA-IslandMilestone] ``` **pom.xml** — since the source code is closed, add the JAR as a local dependency: ```xml id.rajaaditya RA-IslandMilestone 1.0 system ${project.basedir}/libs/RA-IslandMilestone-1.0.jar ``` --- ## License Developed by **RajaAditya** — [rajaaditya.my.id](https://rajaaditya.my.id) This plugin is **closed source**. Redistribution without permission is prohibited.