ShadowSkyBlock

The island module of the Shadow suite.

Everything money-related in one file, kept out of config.yml so you do not have to hunt for it among unrelated settings.

ShadowSkyBlock ships no economy of its own. Money features need an economy: ShadowEconomy, or Vault with an economy plugin. - ShadowEconomy is used directly whenever it is installed, with or

without Vault.

- Otherwise any economy plugin registered in Vault: EssentialsX, CMI

and the like (see the manual).

With neither, everything below (island bank, money costs and rewards of upgrades/missions/perks) switches itself off in the menus instead of throwing errors. /island suite shows which economy was hooked.

This file ships in English. Its Italian version is esempi/it/generators.yml, next to this one in the plugin folder, and the plugin never reads it: to run the Italian one, copy it over this file and use /island admin reload. The messages and menus follow "messages.language" in config.yml on their own; this file is content you write, so it stays as it is.

The island ore generator.

When lava and water meet inside an island, the block that would normally be cobblestone is replaced with one drawn from this table. Every island has its own "prestige" level: the higher it is, the richer the table of materials. Prestige is bought from the generator menu (/island generator) and counts for every member of the island.

The numbers under "materials" are WEIGHTS and do not have to add up to 100: they are normalised on their own. 50/30/20 and 5/3/2 give the same result. The menu always shows the real percentage it worked out.

How this table is meant to progress: each prestige takes 4 points off cobblestone, gives 2 to the ore the previous prestige unlocked, and lets the new ore in at 2%. The item cost of a prestige always asks for the ore of the prestige BEFORE it - never the one it is about to unlock - so you are never asked for an ore you have no way of getting yet.

Sets how an island's "level" is worked out. The level is shown on the scoreboard (%island_level%), on the leaderboards (/island top) and in /island level, and comes from the points an island collects.

Every time a member places one of the blocks listed below inside their own island, the island earns the points shown; breaking it takes them back (never below zero). Blocks that are not listed are worth 0 points, so they do not move the level at all. The level itself is simply:

level = island_points / points-per-level (rounded down)

NOTE: the running count follows what players place and break, block by block, from the moment the plugin is on. What was already standing before is not in it - which is what /island level is for: it recounts the real blocks of the island and writes the total back (see "island.level" in config.yml for its cooldown, and auto-recalc-minutes to have every island recounted on a timer).

HOW THIS TABLE IS BUILT

Three bands, and they are what makes the level mean something:

1-2   what an island is made of - dirt, sand, cobblestone, planks. It is
      free and endless, so it is worth a point: a level earned this way
      is a level of real building, 100 blocks at a time.
3-10  what somebody had to work for - a furnace, a crafting table, a
      trip to the Nether: worked stone, glass, quartz, obsidian.
20+   what an island keeps rather than spends: the metal blocks, and at
      the top the beacon and netherite, which are a season's work.

Add or remove whatever you like: a block worth 0 is simply left out.

The side panel with the island's statistics.

This file ships in English. Its Italian version is esempi/it/missions.yml, next to this one in the plugin folder, and the plugin never reads it: to run the Italian one, copy it over this file and use /island admin reload. The messages and menus follow "messages.language" in config.yml on their own; this file is content you write, so it stays as it is.

Missions shown in the "Missions" menu (reached from the control panel, /island panel, or /island missions). Add, remove or change as many as you like: the menu adapts itself.

Every mission has:

display:   material/name/lore shown in the menu. Name and lore are text
           a player reads, written right here: this file ships in
           English (see the top of the file for the Italian one).
scope:     who carries the progress:
             PLAYER - every player has their own separate progress
             ISLAND - progress is shared by every member of the island
objective: what has to be done.
  type:    one of the many types available (full list below).
  material: optional - when present it filters for that block/item
            (type: BREAK_BLOCK + material: STONE = stone only).
            Left out, the event counts whatever the material is.
            For HARVEST_CROP and PLANT_SEED it is the crop BLOCK
            (WHEAT, CARROTS, POTATOES, BEETROOTS, NETHER_WART...), for
            FILL_BUCKET/EMPTY_BUCKET the bucket (WATER_BUCKET,
            LAVA_BUCKET), for CRAFT_ITEM/SMELT_ITEM the result.
  custom-name: optional, ONLY for type: CUSTOM_ITEM_OBTAIN - asks for an
            item carrying this exact name (from any item plugin, Oraxen
            for instance) instead of any vanilla material.
  amount:  how many times it has to be done - or how much has to pile
            up, for the "cumulative" types listed below - to finish it.
period:    when the mission starts over (default PERMANENT):
             PERMANENT - done once, stays done
             DAILY     - starts over every day at midnight
             WEEKLY    - starts over every Monday
             MONTHLY   - starts over on the first day of the month
           (midnight of the zone in config.yml, missions.timezone)
levels:    optional, for a PERMANENT mission with several steps: a list of
           { amount, rewards } entries, one per level. Each level pays its
           own rewards when reached; the mission is over after the last.
           With "levels" the objective's "amount" is ignored.
rewards:   rewards handed out ONCE on completion. Every reward has a
           "type":
             MONEY   - { type: MONEY, amount: 500 }        (needs ShadowEconomy, or Vault with an economy plugin)
             COMMAND - { type: COMMAND, command: "..." }   (run from the console, %player% replaced)
             MESSAGE - { type: MESSAGE, text: "..." }
             ITEM    - { type: ITEM, material: DIAMOND, amount: 3 }
           Any reward may also carry "description": the line the menu
           shows for it (needed for COMMAND rewards, which cannot describe
           themselves).

Objective types available (type):

BREAK_BLOCK, PLACE_BLOCK, PLANT_SEED, HARVEST_CROP, FISH_CATCH,
CRAFT_ITEM, SMELT_ITEM, ENCHANT_ITEM, TAME_ANIMAL, BREED_ANIMAL,
SHEAR_SHEEP, FILL_BUCKET, EMPTY_BUCKET, EAT_FOOD, KILL_MOB, KILL_PLAYER,
DIE, JUMP, SHOOT_ARROW, HIT_ARROW_TARGET, OPEN_CONTAINER, RIDE_ENTITY,
SLEEP_IN_BED, PURCHASE_UPGRADE, INVITE_MEMBER, CUSTOM_ITEM_OBTAIN
- "cumulative" (amount adds up the real value, not always +1):
DEAL_DAMAGE, TAKE_DAMAGE (damage points), WALK_DISTANCE, SWIM_DISTANCE,
ELYTRA_DISTANCE (blocks travelled), GAIN_EXPERIENCE (experience points),
LEVEL_UP (levels gained), DEPOSIT_BANK_MONEY (coins deposited)

The missions below are a full first season: they start on day one (a cobblestone generator, a wooden pickaxe, the first crops) and lead a player through the whole island - farming, mining, mobs, fishing, the bank, the upgrades. Rewards grow with the effort. Keep, cut or rewrite.

This file ships in English. Its Italian version is esempi/it/player_upgrades.yml, next to this one in the plugin folder, and the plugin never reads it: to run the Italian one, copy it over this file and use /island admin reload. The messages and menus follow "messages.language" in config.yml on their own; this file is content you write, so it stays as it is.

Personal perks (temporary boosts). Unlike island upgrades, these belong to the single player who bought them - or was given them - and the other members of the same island do NOT get them unless they buy or receive their own. You can buy one for yourself (cost-self), for every member of your island at once (cost-team, usually dearer), or gift one to a named player (same price as cost-self).

Every perk has:

display:           material/name/lore shown in the menu. Name and lore
                   are text a player reads, written right here: this
                   file ships in English (see the top of the file for
                   the Italian one).
effect:            a Minecraft PotionEffectType (JUMP_BOOST, SPEED,
                   HASTE, REGENERATION, FIRE_RESISTANCE, WATER_BREATHING,
                   NIGHT_VISION, SATURATION, LUCK, STRENGTH, RESISTANCE,
                   SLOW_FALLING, DOLPHINS_GRACE, ABSORPTION, and so on)
amplifier:         the level of the effect (0 = level I, 1 = level II, ...)
duration-seconds:  how long it lasts (86400 = one day)
cost-self / cost-team: same format as upgrades.yml -> cost

The perks below cover the whole day of a skyblock player: getting around (jump, speed, slow falling), working (haste, night vision, water breathing, dolphin's grace), fighting (strength, resistance, regeneration, absorption) and living (saturation, fire resistance, luck). Prices climb with how much the perk changes the game.

Roles you can give to island members. The island owner ALWAYS holds every permission, so there is no need (and no way) to list them here.

Every role has:

display-name: the name shown in menus and messages. It is text a player
               reads, so the roles below take theirs from the language
               file (roles.<role>.display-name in lang/<language>.yml),
               in the server's language. Write one here to use your own
               instead: it wins, in every language. A role you add
               yourself needs one, or it shows its id. Colour codes with
               "&" work (&e = yellow).
priority:      ordering in the menus only (higher = further up)
permissions:   what this role is allowed to do, out of:
  BREAK_BLOCKS      - break blocks
  PLACE_BLOCKS      - place blocks
  USE_BUCKET        - use buckets (water/lava/milk)
  USE_CONTAINERS    - open chests/barrels/furnaces/other containers
  USE_DOORS         - open doors/trapdoors/gates
  INTERACT_REDSTONE - use levers/buttons/pressure plates
  PVP               - hit other players on the island
  DAMAGE_ANIMALS    - hit animals/passive mobs on the island
  INTERACT_ENTITIES - interact with entities (villagers, panels...)
  INVITE_MEMBERS    - invite new members
  KICK_MEMBERS      - kick members out
  MANAGE_ROLES      - change another member's role
  MANAGE_UPGRADES   - buy and manage island upgrades
  MANAGE_SETTINGS   - change the island rules (mob griefing, spawning,
                       PvP, fire, time, weather...)
  SET_HOME          - move the island's teleport point
  DELETE_ISLAND     - delete the island

Add or remove roles freely: the roles menu shapes itself around whatever is in this file.

What goes into the starter chest of a new island. It applies both to the built-in generation (IslandGenerator, when you are not using schematics) and to ANY schematic picked from the menu: once the schematic is pasted, the plugin looks for the FIRST chest near the island's spawn point and fills it with these items (a schematic made for skyblock usually already has an empty chest inside, waiting to be filled).

Every entry is a Minecraft material plus an amount.

This file ships in English. Its Italian version is esempi/it/upgrades.yml, next to this one in the plugin folder, and the plugin never reads it: to run the Italian one, copy it over this file and use /island admin reload. The messages and menus follow "messages.language" in config.yml on their own; this file is content you write, so it stays as it is.

Upgrades a player can buy from the "Upgrades" menu (reached from the control panel, /island panel, or /island upgrades). Add, remove or change as many as you like, and give each one AS MANY LEVELS as you like: the menu adapts itself both to the number of upgrades and to the number of levels of each.

Every upgrade has:

display:  material/name/lore shown in the menu. Name and lore are text a
          player reads, written right here: this file ships in English
          (see the top of the file for the Italian one).
type:     what it does when it goes up a level. Possible values:
            RADIUS         - grows the island's protected radius by "amount" blocks
            MEMBER_LIMIT   - raises the member limit by "amount"
            BLOCK_LIMIT    - raises by "amount" how many blocks of the listed
                             "materials" the island may hold. Needs:
                               materials:  [ PISTON, STICKY_PISTON ]
                               base-limit: 64        (what an island starts with)
                             A block no upgrade lists has no ceiling at all.
                             The count starts the day the ceiling exists:
                             what was already on the island is not counted.
            CROP_BOOST     - crops grow faster: "amount" is the extra
                             percentage (100 = twice as fast, 50 = one and a
                             half). Works on every crop with growth stages.
            XP_BOOST       - members gain "amount"% more experience while
                             on their own island
            MOB_DROP_BOOST - mobs killed by a member on the island drop
                             "amount"% more (100 = double drops)
            SPAWNER_BOOST  - the island's spawners spawn faster: "amount" is
                             the extra percentage (100 = twice as often,
                             200 = three times). Vanilla spawners and
                             ShadowSpawners stacks alike.
levels:   one entry per level (1, 2, 3, ...). Every level has:
  amount: what THAT level adds - not a hand-written running total: if
          level 1 gives +10 and level 2 gives +15, a player who reaches
          level 2 has been given +25 altogether
  cost:   what buying that level takes. "money" needs an economy:
          ShadowEconomy, or Vault with an economy plugin. "items" can
          also ask for a CUSTOM item (from any plugin, Oraxen for
          instance) by adding "custom-name" with the exact name shown
          on the item.
  duration: OPTIONAL. Makes the level temporary: "2h", "90m", "3d",
          "1h30m" or a plain number of seconds. When it runs out the
          upgrade drops back to level 0 and can be bought again - a
          "boost" rather than a permanent purchase. Buying the next
          level while one is still running renews the clock. Left out,
          the level is forever.
  rewards: EXTRA rewards handed out on reaching that level, on top of
           the effect itself. Same format as missions.yml.
There is no level "after the last one": once a player has bought the
highest level defined here, the upgrade reads as maxed out.

WHAT THE FREE VERSION GETS

Upgrades work without a licence, up to a ceiling: the first few upgrades in this file are active and each can be bought up to a certain level. The exact numbers are printed in the console at start-up, and anything left out is named there too - a limit nobody tells you about reads as a bug. The menu still shows the levels beyond it, so a player can see where the road goes; it is the purchase that stops. A licence key lifts both ceilings.

Every message a player reads, editable without touching the code.

The plugin's own language: English is the default, and lang/it.yml holds the Italian (set "messages.language: it" in config.yml to use it). Translating the plugin means copying this file and rewriting the values - never the keys.

Minecraft colour codes: & followed by a character (&a = green, &c = red).

How the plugin's menus look: the size of every menu, and the slot and material of every entry. Change these to make the menus your own without touching a line of code. Every menu fills its empty slots with "filler" for a clean border: leave it be, or change it to suit your own look.

TITLES, NAMES AND LORE ARE NOT IN THIS FILE

They are text a player reads, so they live in the language file (lang/<language>.yml, the one "messages.language" in config.yml picks) under the same path, and the menus change language with the rest of the

plugin:
  menus.island-panel.title                -> the title of "island-panel"
  menus.island-panel.items.members.name   -> the name of its "members" entry
  menus.island-panel.items.members.lore   -> its lore
  menus.common.back.name                  -> the buttons under "common"

To use your own text instead, write "title", "name" or "lore" right here, under that menu or entry, as "filler" below does: what you write in this file wins over the language file, in every language. "lore: []" means no lore at all.

Everything else in this file - keys, slots, materials - stays English.

Every menu is drawn inside a coloured frame of stained glass, with the content in the middle: the colours come from a built-in palette, one per menu. To pick your own, add "frame" and "accent" (two stained glass panes) under that menu:

frame: LIME_STAINED_GLASS_PANE
accent: GREEN_STAINED_GLASS_PANE