Start here
Getting started
Every Nysxl plugin sits on top of NysxlServerUtils (NSU). NSU gives them their menus, the website editor, scripts, pictures, the resource pack and the economy. Learn NSU first and everything else follows the same pattern.
The plugins
NysxlServerUtilsMenus, GUI editor, scripts, guide book, pictures, resource pack, economy, web page, daily rewards, quests and more./guieditor · /menu · /web
Website editornysxl-gui-editor.pages.dev: menus, Scripts, guide book, resource pack builder, dialogs, machines./guieditor
Staff UtilitiesStaff mode, vanish weights, punishments, tickets, reports, staff chat./staffmode · /ticket
RelicsGenerated relic items with perks, curses, gems, forging and awakening rituals./relics
EstatesTeams, land claims, flags, trust, homes, warps, upkeep and levels./team · /estates
Jobs15 jobs that pay for work, with shifts, contracts, skills, boosters and seasons./jobs
SmartShopAdmin shops with moving prices, chest shops, auction house, buy orders, sell wands./shop · /ah
PPLootChestsPer-player loot chests, loot bags and world drops./lt
SpawnerWorksFuelled spawner cores that make mob drops without spawning mobs./core
Interactable BlocksCustom placeable blocks and furniture with textures, recipes and click actions./iblocks
Install order and requirements
- NysxlServerUtils goes in first. Every other Nysxl plugin lists it under
depend and will not start without it.
- Vault is needed by SmartShop. NSU has its own built-in economy and registers it with Vault, so you don't need EssentialsX economy.
- NuVotifier is needed for vote rewards. Without it
/vote still shows the vote sites, but votes pay nothing.
- Optional: PlaceholderAPI (placeholders in menus), LuckPerms (prefixes and permission groups), WorldGuard, ProtocolLib, Citizens and MythicMobs are all picked up when present.
- Restart the server once. Each plugin writes its default files into
plugins/<Plugin>/ on first start.
Your first ten minutes as owner
- Run
/guieditor. It uploads every plugin's menus and gives you a link to the website editor.
- Change something, press Save, and paste the
/guieditor apply <code> it gives you back in game. A backup is made first.
- Open
/serversettings to change the feature files (daily rewards, quests, levels and so on) from a menu instead of editing YAML.
- Set up the server's web page in
web-stats.yml (host.port and host.public-url), then try /web.
- Run
/screen pack to check the resource pack reaches you. Pictures, screens, dialogs and custom blocks all need it.
- Give your staff group
staffutilities.admin plus the staff permissions they need (see Staff Utilities).
Things that work the same everywhere
| What | How it works |
| Colours | &a, &l and the other & codes work in every message, menu, item name and lore line. |
| Pictures | {img:name} shows a picture uploaded on the website, in any Nysxl text. Players can type it in chat, on signs, in anvils and in books (permission nysxl.images). |
| Times | 45 (seconds), 30m, 12h, 7d, 2w for bans. |
| Money | 2500, 10k, 1.5m. Currencies are NSU currencies; DEFAULT is the main one. |
| Menus | Every plugin's menus are NSU menus. You can restyle them all in the website editor, and players can pick how menus look with /menustyle. |
| Website changes | The website never touches the server directly. It gives you a code, and you run the matching apply command in game. |
| Config files | Every settings file, its defaults, and whether it can be changed in game: see Config files. |
| Reloading | Most plugins have a reload (/guieditor reload, /jobs reload, /lt reload...). Feature files in NSU are read at start-up, so restart after hand-editing them, or edit them in /serversettings. |
Two commands with the same nameBoth NSU and Jobs have /bounty. Whichever registers first gets the plain name; use /nysxlserverutils:bounty or /nysxljobs:bounty to pick one, or turn NSU's off with enabled: false in bounties.yml. The auction house no longer clashes: with SmartShop installed, NSU's own auction house switches itself off and /ah is SmartShop's.
plugins/NysxlServerUtils · required by everything
NysxlServerUtils
The core plugin. It runs every Nysxl menu and connects the server to the website editor. It also has a full set of server features you can switch on or off one at a time.
Every menu from every Nysxl plugin can be edited on the website. You can also make your own menus there. They open with /menu <name> or with their own command.
How to edit a menu
/guieditor (every plugin) or /guieditor <plugin> uploads the menus and sends you a link.
- Edit on the website. Drag buttons around, change items, names and lore, and pick what each click does.
- Press Save, then run
/guieditor apply <code> in game. It lists every change (console commands in red) before you confirm with Apply or /guieditor confirm.
- Undo a bad change with
/guieditor backups and /guieditor restore <backup>.
| Command | What it does | Permission |
/guieditor [plugin] | Upload menus to the website and get a link | nysxl.guieditor |
/guieditor apply <code> | Preview and apply a save from the website | nysxl.guieditor |
/guieditor try <code> | Open the edited menu for yourself without saving it | nysxl.guieditor |
/guieditor confirm · cancel | Confirm or drop a pending apply | nysxl.guieditor |
/guieditor backups · restore <backup> [menu] | List backups; restore all menus or one | nysxl.guieditor |
/guieditor senditem <code> | Send the held item to the website ("Get from game") | nysxl.guieditor |
/guieditor item <name> · items · deleteitem <name> | Save the held item for material: saved:<name>; list; delete | nysxl.guieditor |
/guieditor scripts · testscript <code> | Open the Scripts page; test a script on yourself | nysxl.guieditor |
/guieditor event [what] [id] | Seasonal events made on the website | nysxl.guieditor |
/guieditor region [what] [name] | Mark regions for scripts to use | nysxl.guieditor |
/guieditor autosync <on|off> | Website saves apply by themselves within seconds (backup first) | nysxl.guieditor.autosync |
/guieditor debug [minutes] · log | Trace what menus and scripts do; show the change log | nysxl.guieditor |
/guieditor resetcooldown <player> <id> | Clear a menu or script cooldown for a player | nysxl.guieditor |
/guieditor bugreport [code] | Send a bug report with the server's details | nysxl.guieditor |
/guieditor reload | Reload gui-editor.yml and the menus | nysxl.guieditor |
/menu [player] <menu> [chest|screen|dialog|3d] | Open a menu, optionally for someone else or as a type | nysxl.menu (others: nysxl.menu.others) |
/menustyle [auto|chest|screen|dialog|3d] | Players choose how menus are shown to them (alias /uistyle) | everyone |
/menuviewas <player> <menu> | See a menu exactly as that player sees it (alias /viewas) | nysxl.menus.viewas |
gui-editor.yml
| Key | Default | What it does |
keep-backups | 30 | Menu backups kept. One is made before every apply and restore. |
allow-commands | true | Allow command: actions. They run as the player who clicks, with that player's permissions. |
allow-console-commands | false | Allow console: actions. Applying them also needs nysxl.guieditor.console. |
resource-pack.* | | How NSU sends its pack. See Resource pack. |
Menu files live in plugins/<Plugin>/menus/<id>.yml. Menus made on the website are plugins/NysxlServerUtils/menus/custom-<name>.yml. The full list of menu keys and click actions is on the Website editor page.
Screens (HTML & CSS on maps)
A screen is a page drawn on maps. Players can see it fullscreen with a mouse pointer (open it as a menu, then sneak to leave) or on a wall. You design screens on the website as the Screen (maps) menu type.
| Command | What it does | Permission |
/screen open <menu> [player] | Open a screen fullscreen (for someone else needs admin) | nysxl.screen |
/screen close [player] | Close the fullscreen view | nysxl.screen |
/screen fov <degrees> | Your field of view for fullscreen screens | nysxl.screen.fov |
/screen pointer <speed> | Your mouse pointer speed | nysxl.screen.pointer |
/screen place <menu> [cols rows] [name shared] | Put a screen on the wall you're looking at | nysxl.screen.admin |
/screen remove <name> · list · stats | Manage wall screens | nysxl.screen.admin |
/screen import <code> | Import a screen from the website | nysxl.screen.admin |
/screen pack | Send yourself the resource pack again | nysxl.screen.admin |
/screen reload | Reload screens | nysxl.screen.admin |
Aliases: /screens, /mcgui, /ui.
Dialogs
Dialogs use Minecraft's own dialog window, with body text, text boxes, sliders, switches and choices. You can make them as a menu (type Dialog window) or in the website's Dialogs designer. The designer draws each page as a picture in the resource pack. Values the player enters are %input_<name>%. Each dialog can have its own command.
| Command | What it does | Permission |
/nsudialog list | Every dialog | nysxl.dialogs.admin |
/nsudialog open <id> [player] | Open a dialog | nysxl.dialogs.admin |
/nsudialog info <id> · check | Details; check every dialog for mistakes | nysxl.dialogs.admin |
/nsudialog web · web apply <code> | Open the Dialogs designer; apply its save | nysxl.dialogs.admin |
/nsudialog reload | Reload dialogs.yml and the dialogs/ folder | nysxl.dialogs.admin |
In dialogs.yml, resource-pack.merge-into-main-pack: true (the default) puts dialog pictures into NSU's main pack, so players get one pack.
Event scripts
Scripts are made on the website's ⚡ Scripts canvas by wiring nodes together: When… (an event) → Condition → Action → Menu. They're saved like menus (Save, then /guieditor apply) and take effect straight away.
- Events: game events (join, quit, break or place a block, chat, death, kills, run a command...), other plugins' events (finish a quest, open a crate...), any Bukkit event by its class name, and timers.
- Combos: "Then wait for…" chains events, for example break a block, then sneak within 3 seconds.
- Abilities: a script whose event is ability has no trigger. Jobs, relics, custom blocks and items run it by name (
script:<name>).
- Script commands: a script can add its own
/command.
- Guide lines: give a script a guide line ("Break diamond ore while sneaking for a bonus") and it shows in the guide book under Things to try.
- Testing: the Scripts page's Test button gives
/guieditor testscript <code>, which runs the script on you only.
Scripts are stored in menus/custom-_editor.yml (event_scripts:). Edit them on the website, not in the file.
Guide book
/guidebook (or /guide) gives a book about what the server has. It's built from your current setup, so it stays up to date. It has five parts, and you choose their order and which ones show:
| Part | What it shows |
| Your pages | Pages you write in the guide book editor |
| Getting started | The web page's getting-started commands (guide: in web-stats.yml), clickable |
| Menus | Every menu this reader may open, with its command. Hide one with guide_hidden: true on the menu. |
| Quests | Your quests with the reader's progress |
| Things to try | Every script that has a guide line |
How to edit it
- On the website open Scripts → Guide book → Edit the guide book.
- Set the title and first page, then the sections: turn each one on or off, rename its heading, and drag to reorder.
- Write your own pages. The toolbar adds colours, the reader's name (
%player%), pictures and links. A link is written [text](/command) and runs the command when clicked.
- The preview draws the book the way the game does and warns when a page is over 14 lines. Save and apply as usual.
Pictures with {img:name}
Upload a picture on the website (PNG or JPEG, up to 1024 × 1024 and 2 MB). Then {img:name} shows it as a character in text. It works in messages, menus, item names and lore, scoreboards, boss bars, chat formats and the guide book.
- Players can type
{img:name} in chat, on signs, in anvil renames and in books. This needs nysxl.images, which everyone has unless you take it away.
- Set each picture's size and how high it sits in a line in the website's 🎨 Resource pack builder.
- An unknown name is simply left out. Players without the resource pack see a blank or square.
Pictures are kept in plugins/NysxlServerUtils/assets/, and their sizes in assets/glyphs.yml.
Resource pack
NSU builds one resource pack and sends it itself. It holds screen fonts, dialog pictures, {img} pictures, custom blocks (from Interactable Blocks), and any whole packs you upload.
- Uploading packs: in the 🎨 Resource pack builder, upload a
.zip (up to 40 MB, at most 12 packs). It's kept in plugins/NysxlServerUtils/packs/, and you can also drop zips there yourself. Only the zip's assets/ folder goes in. NSU's own files win, and when two packs have the same file, the first by name wins.
- Sending: the
resource-pack section of gui-editor.yml controls sending. /screen pack sends it again.
| gui-editor.yml key | Default | What it does |
resource-pack.auto-send-on-join | false | Send the pack to every player when they join |
resource-pack.http-port | 0 | Port NSU serves the pack on (0 = off). On a hosting panel (Pterodactyl and similar), add the port to the server first. |
resource-pack.http-host | 127.0.0.1 | Address the pack server listens on |
resource-pack.public-url | "" | The address players download from, if it differs from the server's own |
Chat formats, prefixes and suffixes
| Command | What it does | Permission |
/chatformat [format] [on|off|toggle] | Your chat formats, with buttons to switch them | everyone |
/prefix · /prefix <id> | See and pick a ready-made prefix | nysxl.prefix |
/prefix set <text> · clear | Your own prefix text (colours need nysxl.prefix.colour) | nysxl.prefix.custom |
/prefix … <player> · reload | Change someone else's; reload | nysxl.prefix.others |
/suffix … | The same for suffixes | nysxl.suffix.* |
Chat formats are made on the website as rich text, with colours, gradients, hover text and clickable names. A player gets the highest-priority format they have permission for and have switched on. You can use {player}, {message}, {world}, {prefix} and {suffix}. Ready-made prefixes live in prefixes.yml. If a player has none, their LuckPerms group's prefix is used. Placeholders: %nysxlserverutils_prefix%, %nysxlserverutils_suffix%.
Economy, currencies, tax and treasury
NSU has its own economy, with any number of currencies, and registers it with Vault. Settings are in economy.yml, with optional MySQL in mysql.yml.
| Command | What it does | Permission |
/balance [player] | Your money (aliases /bal, /money) | nysxl.economy.balance (.others) |
/pay <player> <amount> | Send money | nysxl.economy.pay |
/baltop [page] | Richest players | nysxl.economy.baltop |
/eco give|take|set|reset <player> [amount] | Change a balance | nysxl.economy.admin |
/currency get <currency> <player> | Balance in one currency | NysxlServerUtils.currency.use |
/currency pay <currency> <player> <amount> | Pay in a currency | NysxlServerUtils.currency.pay |
/currency set|add|subtract … | Change a currency balance | NysxlServerUtils.currency.admin.<set|add|subtract> |
/currency create <currency> <alias> | Make a new currency | NysxlServerUtils.currency.admin.create |
/tax get rate|paid <currency> | See the tax rate and what's been paid | NysxlServerUtils.tax.use |
/tax set rate <currency> <0-100> · set paid | Set the tax | NysxlServerUtils.tax.admin |
/treasury [goals] | The server treasury and community goals (alias /communitygoals) | nysxl.treasury |
/treasury pay|add|take|goal run|reload | Manage the treasury | nysxl.treasury.admin |
Player features
Each feature has its own file in plugins/NysxlServerUtils/, written with examples the first time. Set enabled: false in the file to switch a feature off. You can edit all of them in game with /serversettings.
| Command | What it does | File |
/daily [claim] | Daily reward and streak (/rewards, /streak) | daily-rewards.yml |
/quests | Daily and weekly quests (/challenges) | quests.yml |
/achievements [player] | Achievements (/ach, /badges) | achievements.yml |
/level [player] · /title [off] | Server level; pick a title (/lvl, /rank) | levels.yml |
/pass [buy] | Battle pass (/bp). Premium needs nysxl.battlepass.premium or buying it. | battlepass.yml |
/prizes | This week's prize boards (/weekly). /prizes award needs nysxl.prizes.admin. | weekly-prizes.yml |
/top [money|streak|quests|bounties|playtime|votes|achievements] | Leaderboards (/lb) | leaderboards.yml |
/events | Scheduled server events and countdowns | events.yml |
/kits [claim <kit>] | Kits. create <id> [cooldown] [permission] and delete need nysxl.kits.admin. | kits.yml |
/crates [open <crate>] | Open crates with keys. give <player> <crate> <n> needs nysxl.crates.admin. | crates.yml |
/mail [send <player> [money] [note]] | Mailbox and sending items or money (/post) | mail.yml |
/trade <player> · accept · deny | Safe trading of items and money | trades.yml |
/ah [sell <price> [time] [buy-now] | claim] | NSU auction house. It's off when SmartShop is installed. | auction-house.yml |
/bounty [player amount] | Put money on a player's head. Part goes to the treasury. | bounties.yml |
/lottery [buy <n>] | Server lottery (/lotto) | community.yml |
/poll · /poll <answer> | Vote in the poll. start [time] <question> | <answer> | …, end and history need nysxl.poll.admin. | community.yml |
/sethome [name] · /home [name] | Homes. nysxl.homes.<n> allows n homes (up to 50). Can include Essentials homes. | community.yml |
/warp [name] · /warps | Go to a warp, or open the warps menu. Can include Essentials warps and spawn. | community.yml |
/setwarp <name> · /delwarp <name> | Set a warp where you stand; remove one (nysxl.warps.admin) | community.yml |
/tpa <player> · accept · deny | Teleport requests. nysxl.teleport.instant skips the warm-up. | community.yml |
/playtime [player] | Hours played. Pays per hour plus milestone rewards. | rewards.yml |
/vote | Vote links and your streak | rewards.yml |
/servermenu | Everything the server has, in one menu (/sm, see the note below) | |
/preferences | Each player's own settings: tips, reminders, screens (/prefs) | |
/guidebook | The guide book (/guide) | editor file |
/sm clashStaff Utilities uses /sm for staff mode, and NSU uses it for /servermenu. Tell players to use /servermenu, and tell staff to use /staffmode.
Feature files in depth
Every feature file is written with working examples the first time the server starts. Rewards are usually money plus actions, and actions are the same menu actions the website uses: giveitem:DIAMOND:2, message:&aHi, broadcast:…, sound:…, crate_key:<crate>, and console:… (only when console commands are allowed). %player% is the player. Days use time-zone (for example Europe/London); if it's blank, the server's own time zone is used.
Daily rewards (daily-rewards.yml)
There's one reward a day. The streak goes up each day in a row and resets if a day is missed. After the last day the rewards start again from day 1, but the streak keeps counting.
remind-on-join: true
rewards:
1: { name: "&aDay 1", icon: BREAD, money: 50, actions: ["giveitem:BREAD:8"] }
7: { name: "&6Day 7", icon: DIAMOND, money: 500, actions: ["giveitem:DIAMOND:3"] }
milestones: # extra once a streak reaches this many days
30: { name: "&d30 day streak", icon: NETHER_STAR, money: 2500 }
Quests (quests.yml)
Each player gets daily-quests (3) new quests every day and weekly-quests (2) every Monday, picked at random from the daily: and weekly: lists. A quest pays out the moment it's finished.
| type | Counts when the player… |
break · place | Breaks or places blocks. The target is a block name, a group like any_log, or any. |
kill · fish · craft | Kills a mob, catches something, or crafts an item |
daily | Claims the daily reward |
auction · bounty · trade | Wins an auction, claims a bounty, or finishes a trade |
sell · buy | Sells to or buys from SmartShop shops |
daily:
zombies: { name: "&2Zombie hunter", type: kill, target: ZOMBIE, amount: 10, money: 150, icon: ROTTEN_FLESH }
weekly:
miner: { name: "&bDeep miner", type: break, target: DIAMOND_ORE, amount: 20, money: 1500, actions: ["giveitem:DIAMOND:2"] }
Achievements (achievements.yml)
An achievement with a counter unlocks when that count reaches needed. The counters are streak, quests, playtime-hours, votes, bounties, trades and kits. Achievements without a counter (first_kit, first_trade, first_vote) are unlocked by the feature itself. broadcast: true announces each unlock.
Levels and titles (levels.yml)
Almost everything players do earns level XP. Levels unlock titles, which players pick with /title.
| Key | Default | What it does |
mode | own | own: XP from the actions below. jobs: the level is the player's NysxlJobs level (jobs-level: total | highest | average). |
actions | logs, ores, crops, mobs, fishing | XP per action: {on: break, blocks: ["#diamond_ores"], xp: 10}. on can be break, harvest, kill or fish. Block tags like #logs work. Placed blocks, spawner mobs and creative mode don't count. |
base · exponent · max-level | 100 · 1.4 · 100 | XP for the next level = base × levelexponent |
xp.* | | XP for quests (40 daily, 150 weekly), daily reward 20, playtime hour 30, vote 25, achievement 75, bounty 50, auction 10, trade 10 |
titles | Newcomer … Mythic | level: "&7Title". Unlocked at that level. |
title-in-name | true | Put the chosen title in front of the player's name |
Battle pass (battlepass.yml)
Pass XP comes from everything that gives level XP. There are 30 tiers by default, at 1000 XP each. Every tier has a free reward and a premium reward. Players get premium through nysxl.battlepass.premium or by buying it with /pass buy (price 50,000; set premium.price: 0 to make it permission-only). To start a new season, change season.id, and everyone goes back to tier 0. After season.ends, rewards can still be claimed but no XP counts. Admins can add XP with /pass addxp <player> <amount> (nysxl.battlepass.admin).
Weekly prizes (weekly-prizes.yml)
Boards count up over the week, and every Monday the top 3 on each board get its prizes. The default boards are earned (money), xp, quests, contracts (job contracts) and bags (loot bags opened). Prizes are action lists, for example console:lootTables giveLootBag epic %player%. /prizes award hands them out early.
Crates (crates.yml)
Each crate has a loot list. Every entry has a name, an icon (the item given, amount of it), optional money and actions, and a weight, which sets how likely it is compared with the others. Keys come from /crates give or the crate_key menu action, so daily rewards and quests can hand them out.
Kits (kits.yml)
kits:
starter: { name: "&aStarter kit", icon: WOODEN_SWORD, items: ["STONE_SWORD 1", "BREAD 16"], once: true }
daily: { name: "&eDaily kit", items: ["COOKED_BEEF 16"], money: 100, cooldown: 24h }
vip: { name: "&6VIP kit", items: ["DIAMOND_SWORD 1"], cooldown: 7d, permission: server.kit.vip }
Hold the exact items you want (enchantments and all) and use /kits create <id> [cooldown] [permission]. Those kits are stored in data/kits.yml instead.
Events and tips (events.yml)
tips are said in chat one at a time, every tips-every-minutes (10). events are timed: days: [SAT, SUN] (or ALL), start: "20:00", minutes: 120. While an event is on, it multiplies quest money (quest-money: 2) and daily money (daily-money: 1.5), and the biggest running event wins. on-start and on-end run actions.
Lottery, polls, homes and teleports (community.yml)
| Key | Default | What it does |
lottery.ticket-price · max-tickets | 100 · 20 | Ticket cost and the most one player can hold |
lottery.every-minutes · tax-percent | 60 · 10 | How often it's drawn; the treasury's cut of the pot |
polls.results-shown-for · history-size | 1d · 50 | How long results are announced; polls kept in history |
homes.max · warmup | 3 · 3 | Homes per player (nysxl.homes.<n> for more); seconds standing still before teleporting |
tpa.request-seconds | 60 | How long a teleport request waits |
Start a poll with /poll start 1d Best biome? | Desert | Jungle | Ocean.
Bounties, mail, trades and the auction house
| File · key | Default | What it does |
bounties.yml · minimum · tax-percent | 100 · 5 | Smallest bounty; the treasury's cut when one is placed |
bounties.yml · confirm-from · broadcast | 1000 · true | Ask "are you sure?" above this amount; announce bounties |
mail.yml · postage · max-letters | 5 · 54 | Cost per letter (to the treasury); mailbox size |
trades.yml · max-distance | 20 | Blocks apart (0 = anywhere, -1 = same world) |
trades.yml · money-tax-percent · request-seconds | 0 · 60 | Treasury cut of traded money; how long requests wait |
auction-house.yml · tax-percent · min-raise-percent | 5 · 5 | Sale tax; smallest raise per bid |
auction-house.yml · default-time · max-time | 1h · 2d | Listing length |
auction-house.yml · snipe-guard-seconds | 30 | A bid in the last 30 s adds time |
Playtime (rewards.yml)
playtime.money-per-hour (50) is paid for every full hour played. playtime.milestones gives extra at set hours, for example 10: ["giveitem:DIAMOND:2"]. Hours played before the plugin was installed don't all pay out at once.
Currencies (economy.yml)
currencies:
DEFAULT: { alias: "$", tax_percentage: 0.0, conversion_rates: {} }
BHC: { alias: "Bounty Hunter Coin", tax_percentage: 5.0, conversion_rates: { DEFAULT: 2.0 } }
DEFAULT is the main money that Vault and most plugins use. Other currencies are used by name; for example, Jobs pays bounties in BHC. tax_percentage is taken on payments in that currency and added to tax_collected.
Ready-made prefixes (prefixes.yml)
List presets under prefixes: and suffixes:, each with text, an optional description and a permission (default nysxl.prefix.preset.<id>). Players see the ones they're allowed to use in /prefix. format: "{prefix}{name}{suffix}" controls the tab list. Menus and scripts can use prefix:use:<id>, prefix:set:<text> and prefix:clear.
Dialog pack (dialogs.yml)
When merge-into-main-pack is off, dialog pictures go out as their own pack, served on port 8163. That pack needs advertised-host (the address players can reach) or a public-url. mode: additional keeps the main pack, and replace sends this pack instead. min-format-major 84 and max-format-major 97 cover game versions 26.1 to 26.3.
Homes, warps & Essentials
NSU can use EssentialsX's homes, warps, spawn and kits, and can copy them (and Essentials mail) into its own. Essentials doesn't have to be installed. While it's running, NSU asks it directly. If it has been removed, NSU reads the files it left in plugins/Essentials (the folder name can be changed). Money and balances are never imported.
| Command | What it does | Permission |
/essentialslink | The "Homes, warps & Essentials" page (alias /esslink). Also a tile on the top row of /serversettings. | nysxl.admin.settings |
/essentialslink import homes|warps|kits|mail | Copy that data into NSU now. Works from the console too. | nysxl.admin.settings |
/warp [name] · /warps | Go to a warp, or open the warps menu. The server menu has a Warps tile too. | everyone (see per-warp permission) |
/setwarp <name> · /delwarp <name> | Set or remove one of NSU's own warps | nysxl.warps.admin |
Live or import
- Live: Essentials data shows next to NSU's own and is read fresh each time. If both have something with the same name, NSU's wins.
- Import: a one-time copy into NSU, so you can remove Essentials afterwards. Shift-click a row's import button on the page, or use
/essentialslink import ….
The settings page
Every setting can be changed on the page, and they're saved to plugins/NysxlServerUtils/essentials-link.yml.
- Status: whether Essentials was found, and how many player files, warps, spawns and kits it has, plus when each import last ran.
- Use Essentials data: the main switch for everything below.
- Blocked worlds, warps and kits: click to block or allow, or type a name. Blocked items are never used or imported. Blocking the warp
spawn hides Essentials' spawn.
| Row | Settings |
| Homes | Use Essentials homes. Most Essentials homes per player (0 = all). Allow importing. Imports obey the home limit. NSU's home limit (community.yml homes.max; nysxl.homes.<n> gives more). Teleport warm-up. Import. |
| Warps | Use Essentials warps. Show Essentials' spawn as the warp spawn. Allow importing. Each warp needs a permission (nysxl.warp.<name>; community.yml warps.per-warp-permission). Open /warp. Import. |
| Kits | Use Essentials kits in /kits. Allow importing. Blocked kits. Import, which copies the kits and every player's claim times. |
| Mail | Allow importing. Import. |
How each kind shows up
- Homes: in
/home, Essentials homes are cyan beds marked "From Essentials". They can't be removed from NSU.
- Warps: NSU now has its own warps. Essentials warps, and its spawn as
spawn, appear alongside them.
- Kits: Essentials kits appear in
/kits marked "From Essentials". They need essentials.kits.<name>. Essentials' delay is used as the cooldown (-1 means once only), and Essentials' last-claim times still count.
- Mail: importing copies unread, unexpired Essentials mail into
/mail as notes marked "From Essentials mail". Each letter is only imported once, so running it again is safe. A full mailbox is reported.
Kit items NSU can read
Item names, Essentials nicknames (diamondsword, steak), name:, lore: (| separates lines, _ is a space), enchantments like sharpness:3, unbreakable:, and Essentials' saved base64 items. Amounts over one stack are split up. /command lines, $money lines and unknown items are skipped. The first 8 skipped lines are listed in chat and the rest go to the console.
GotchasWhen CMI or Essentials is installed, it keeps the plain /warp command, so NSU's is /nysxlserverutils:warp or the Warps tile in the server menu. Importing homes stops at each player's NSU home limit unless you switch that off.
Voting
- Install NuVotifier and connect it to your vote sites. Rewards only arrive through it.
- Add your vote sites in the web page's admin panel (
/web admin). /vote shows those sites with their names. If the panel has none, it shows votes.sites from rewards.yml.
- Set the reward in
rewards.yml: votes.money (100), votes.actions (menu actions such as message: or giveitem:), and a streak bonus votes.streak-bonus (10 per day, up to streak-bonus-max 200).
The server's web page (/web)
A live page about your server that anyone can open: who's online, leaderboards, shops and auctions, bounties, jobs, teams on a map, loot, the treasury, polls, news and a profile for every player. Staff get a private admin view. /web gives players the link.
What the page shows
| Part | What's in it | Turn it off with |
| Header and "Join us" | Server name, tagline, address, Bedrock address and port, Discord invite | Leave the value empty |
| Online now | Players online, TPS and uptime | |
| Leaderboards | Money, streaks, quests, bounties, playtime, votes, achievements, plus job rankings with NysxlJobs | |
| Money | Each player's balance on the boards and their profile | show-balances: false |
| Economy | The treasury, all the money players hold, and the average | show-economy: false |
| Shops and auctions | SmartShop prices and live auctions. Player chest shops include their world and coordinates. | show-shop-locations: false hides where chest shops are |
| Teams map | NysxlEstates teams and their claims on a map | show-estates: false |
| Terrain maps | Map pictures of your worlds behind the claims | show-terrain-maps: false |
| Bounties, lottery, polls | Open bounties, the lottery pot, the current poll, past results | |
| Loot, battle pass, weekly prizes, machines | Parts other plugins and features add when they're installed | That feature's own switch |
| Activity feed | The last 40 things that happened (see the kinds below) | |
| Player profiles | First joined, last seen, playtime, money, team, streaks, votes and achievements | |
| News, calendar, rules, getting started, staff | Whatever you write in web-stats.yml | Leave the list empty |
| Vote links | The same sites as /vote | show-vote-links: false |
| Moderation log | Kicks, mutes and bans from the staff panel | Off unless show-moderation-log: true. Always in the admin view. |
Two ways to host it
Pick one. Option B is the easier one for most servers.
| A. Hosted by your Minecraft server | B. Sent to a website |
| How | NSU runs a small web server on a port of its own and serves the page from the plugin | NSU sends the page's data to a website over https whenever something changes |
| Settings | host.enabled: true, host.port, host.bind, host.public-url | upload: true, upload-url: "https://…" |
| Needs | A free port that players can reach | Nothing open on your server |
| Address | http://your-ip:port unless you put a proxy in front | https on the website |
| Staff logins, ticket replies, vote sites panel, store deliveries | No (the admin view still works through /web admin) | Yes |
Option A: host it on your server
- Get a spare port. On a hosting panel such as Pterodactyl, open the server's Network tab and add an allocation. That port is the one you use.
- In
plugins/NysxlServerUtils/web-stats.yml:
host:
enabled: true
port: 8299 # the port you added
bind: "0.0.0.0" # listen on every address
public-url: "http://play.example.com:8299" # what /web hands out
- Restart the server. Open the address in a browser, and try
/web in game.
- Optional https: if you have a VPS or domain with nginx, put the page behind a subdomain such as
stats.example.com. Use a server block with proxy_pass http://<server IP>:<port>;, get a certificate with certbot, then set public-url to https://stats.example.com. Use a separate subdomain if something else (like BlueMap) already uses the main one.
Option B: send it to a website
- In
web-stats.yml, set upload: true and upload-url to the website, for example "https://nysxl-gui-editor.pages.dev". It must start with https://.
- Restart. NSU makes its own secret token the first time (kept in
data/web-stats.yml, never shown) and starts sending.
/web now gives the website's link for your server. Staff can make logins with /web login.
The page is only sent when something changed. It's checked every every-minutes (1), sent at once when someone joins or leaves, and sent at least every quiet-minutes (15) even when nothing changed.
Commands and permissions
| Command | What it does | Permission |
/web | Link to the server page (alias /serverpage) | everyone |
/web admin | A private link to the admin view. The key in it is made from the server's token, so only staff can get it. Don't share it. | nysxl.web.admin |
/web login | Option B only. Makes your own staff login: click the link and choose a password, or use the 8-letter code under Staff login on the page. It works once, for 15 minutes. | nysxl.web.admin |
/web logout [name] | Switch off your website login. Owners can switch off anyone's. | nysxl.web.admin (others: owner) |
/web update | Send the page now | nysxl.web.admin |
Owners are the names in owners: plus anyone with nysxl.web.owner (ops have it). Owners get an owner login, see every staff login and what each one did, and can switch logins off.
The admin view
- Moderation log: kicks, mutes and bans from the staff panel.
- Tickets: open tickets from Staff Utilities. With option B, staff can reply and close them from the browser and the server picks the replies up.
- Player lookup: records, notes, bans and tickets for players with any history.
- Economy warnings: players whose money grew by more than
warn-money-jump (10,000) in an hour, and big swings in all the money there is.
- Staff stats, player timelines, and an Update now button.
- Vote sites (option B): the sites set here are what
/vote shows.
On purposeThe server page can't give anyone OP or run console commands, not even for owners. A leaked staff login can't take over the server.
Everything in web-stats.yml
| Key | Default | What it does |
enabled | true | Off: no page at all |
host.enabled · port · bind · public-url | see above | Option A |
upload · upload-url | false · "" | Option B (https only) |
server-name · tagline | "My Minecraft server" · "" | The page heading |
every-minutes · quiet-minutes | 1 · 15 | How often to check for changes; the longest gap between sends |
join.address · join.bedrock-address · join.bedrock-port · join.discord | "" · "" · 19132 · "" | The "Join us" box. Leave a value empty to hide it. |
rules | [] | One rule per line |
guide | 5 commands | - { command: "/shop", text: "Buy and sell" }. Also used by the guide book. |
staff | [] | Names listed as staff (online staff are shown either way) |
news | [] | News at the top, newest first |
calendar | [] | Upcoming events with a countdown. Dates are yyyy-MM-dd HH:mm in server time. |
owners | [] | Owner names (see above) |
show-* | see the table above | What the public page reveals |
warn-money-jump | 10000 | Admin view warning threshold |
discord-webhook · discord-kinds | "" · see below | Public activity feed to Discord |
discord-log-webhook · discord-log-kinds | "" · [join, leave] | Staff log to Discord |
Discord webhooks
NSU can post the activity feed to Discord channels. There are two webhooks, and each is optional. Both live in web-stats.yml and are only read when the server starts, so restart after changing them. There's no in-game editor for them yet.
Get a webhook link
- In Discord, open the channel's settings (⚙️) → Integrations → Webhooks → New Webhook.
- Name it if you like, then press Copy Webhook URL.
- Paste it between the quotes:
discord-webhook: "https://discord.com/api/webhooks/…". "" means off. Treat the link like a password: anyone with it can post in that channel.
# Public feed: what players see happening.
discord-webhook: "https://discord.com/api/webhooks/…"
discord-kinds: [level, achievement, jackpot, rare, prize, pass, contract, core, poll] # [] = every kind
# Staff log: joins and leaves, with 🟢 / 🔴 and the online count.
discord-log-webhook: "https://discord.com/api/webhooks/…"
discord-log-kinds: [join, leave]
Posts use the server's name as the sender. Mentions are switched off, so nobody's name in a line can ping @everyone or anyone else.
Every activity kind
| Kind | Posted when | From |
join · leave | Someone joins (and "for the first time!") or leaves | NSU |
level | A server level that's a multiple of 5 or unlocks a title; a job level-up | NSU, NysxlJobs |
achievement | An achievement unlocked, or a weekly machine challenge finished | NSU |
pass | Every 10th battle pass tier, finishing the pass, or unlocking premium | NSU |
prize | The weekly prize winners | NSU |
poll | A poll starts or ends | NSU |
bounty | A bounty is claimed | NSU |
sale | An auction sale or buy in SmartShop (ordinary shop trades are left out) | NSU + SmartShop |
jackpot | A job jackpot payout | NysxlJobs |
contract | A job contract finished | NysxlJobs |
rare | An epic, legendary or mythic loot bag found | PPLootChests |
core | A spawner core dug up with Silk Touch or dropped by a mob | SpawnerWorks |
The default discord-kinds leaves out join, leave, bounty and sale, so the public channel isn't flooded. Add them to the list if you want them.
Webhooks from event scripts
An event script can post its own message with the Discord webhook action on the website's Scripts page. Only real Discord webhook links (discord.com or discordapp.com /api/webhooks/…) are accepted. Colour codes are stripped, and you can set the sender's name.
Web page troubleshooting
| What you see | Fix |
/web says "the page is on port …" with no link | Option A is running but host.public-url is empty. Set it to the address players should open. |
/web says "isn't set up yet" | host.port is 0 and upload is off. Choose option A or B. |
| The link doesn't load (option A) | The port isn't reachable. Add it as an allocation on your panel, check the console says "Server page hosted on port …" (not "couldn't use port"), and make sure nothing else uses it. A port on a different machine (like a VPS) won't reach your Minecraft host unless you proxy to it. |
| Nothing is sent (option B) | upload-url must start with https://, and upload must be true. Restart after changing either. |
/web login says logins are on the website | Staff logins only exist with option B. |
| Discord stays quiet | The link must start with https://, the kind must be in the list (or the list empty), and the server must have been restarted since you pasted it. |
| Something in the page shouldn't be public | Use the show-* switches. The admin view always has everything. |
Staff and admin tools
| Command | What it does | Permission |
/serversettings [file] | Edit feature files in game (/settings) | nysxl.admin.settings |
/staff [player] | NSU's staff panel | nysxl.staff (set in staff.yml) |
/ecoadmin [player] | give|take|set <player> <amount> | Economy admin with a menu | nysxl.ecoadmin |
/timeline <player> | What a player did lately | nysxl.staff |
/ServerAnnouncement | Edit the announcement (%nysxlserverutils_announcement%) | op |
Multiblock machines
Machines are structures players build from blocks. They run on a timer and can have upgrades, books and weekly challenges. Players browse them with /machines [machine]. Admins use /multiblock (/mb, needs nysxl.multiblock.admin):
list · edit · new · copy · give · book · upgrade · blueprint · build · pos1 · pos2 · capture · letters · split · anim · web · stats · reload
How a machine works
- Each machine is a file in
multiblocks/<id>.yml. It has a core block item, which can have its own crafting recipe, and a structure made of letters, with each letter standing for a block.
- Players place the core and build the structure around it. Right-clicking the core shows a hologram of its status and a ghost of any missing blocks.
- Once the structure is complete, clicking it runs actions: commands, menus, messages and sounds. Actions can be set for the whole structure or for one letter's blocks, on right-click, sneak + right-click or left-click. Sneak + left-click always breaks.
- Machines that process items take fuel and have upgrade slots. Upgrade items come from
machine-upgrades.yml: speed (sugar, +20%), output (gold nugget, +10% yield) and efficiency (blaze powder, less fuel). Each can be limited to certain machines.
- Weekly challenges (
machine-challenges.yml) are goals for everything a player's machines make, such as 2000 glass. They reset every Monday and pay money:, level-xp: and actions.
The quickest way to make a machine is to build it, mark it with /mb pos1 and pos2, then /mb capture. Every machine setting can also be changed in game from /mb edit. /mb web opens the website's Machines section, and its save is applied with /mb web apply <code>. Applying new commands that way needs nysxl.multiblock.web.commands. Files: multiblocks/, machine-challenges.yml, machine-upgrades.yml.
Files at a glance
| File | What's in it |
gui-editor.yml | Editor safety, backups and resource pack sending |
menus/ | Website-made menus (custom-*.yml) and the editor file custom-_editor.yml (scripts, guide book) |
assets/ · packs/ | Uploaded pictures and their sizes; extra resource packs |
dialogs.yml · dialogs/ | Dialogs and their pack settings |
economy.yml · mysql.yml | Currencies and the optional database |
prefixes.yml · chat-formats.yml | Ready-made prefixes and suffixes; players' chat format choices |
web-stats.yml | The server web page |
rewards.yml | Playtime and vote rewards |
| Feature files | achievements, auction-house, battlepass, bounties, community, crates, daily-rewards, events, kits, leaderboards, levels, mail, quests, staff, trades, weekly-prizes (all .yml) |
data/ | Saved player data for each feature. Don't edit it while the server runs. |
menu-changes.log | Every apply, restore and saved item |
Gotchas
- Console commands from strangers. An apply code can contain
console: actions, which run with full server rights. Keep allow-console-commands: false unless you need it, and read the apply preview.
- Upload links expire after 2 days. Run
/guieditor again for a fresh one.
- No pack, no pictures.
{img}, screens, dialog pictures and custom blocks all need the resource pack. If they look wrong, try /screen pack and check resource-pack.http-port or public-url.
- Typed input is cleaned. What players type (
%input%, %arg_…%) reaches commands as one plain word. Use %raw_input% only in messages.
- Ports on hosting panels. The web page and the pack server each need a port added to the server's allocations before they work from outside.
nysxl-gui-editor.pages.dev · Cloudflare Pages
Website editor
A website for editing menus, scripts, the guide book, pictures, dialogs, machines and relics without touching a YAML file. Every server running NSU uses it, so there's nothing to set up.
How it connects to the server
- A command in game uploads the current setup and gives you a link (
/guieditor, /nsudialog web, /mb web, /relics admin editor).
- You edit on the website. Unsaved work is kept in your browser, and Ctrl+Z / Ctrl+Y undo and redo.
- Save gives you an apply command with a code. Run it in game, check the preview and confirm. A backup is made first.
The website can't reach your server by itself. Nothing changes until someone with permission runs the apply command. The exception is auto-sync (/guieditor autosync on), which applies saves within seconds.
Sections
| Section | What you do there | Opened by |
| Menus (main page) | Drag-and-drop chest menus, screens and dialog menus, with a real tooltip preview. Import DeluxeMenus files. Use templates (hub, shop, warps, server selector, are-you-sure). | /guieditor |
| 🗺 Map | Every menu as a card, with lines for buttons that open other menus. Drag a card's ● onto another to link them, or press + for a new linked page. | top bar |
| ⚡ Scripts | Node canvas for event scripts: events, conditions, actions, menus, timers, combos, abilities | /guieditor scripts |
| Guide book editor | Title, first page, section order and headings, your own pages, [text](/command) links, and a book preview | Scripts → Guide book |
| 🎨 Resource pack builder | Picture characters (upload, size, height in the line, copy the {img:name} tag) and whole .zip packs merged into NSU's pack | Scripts → More |
| Dialogs | Visual designer for drawn dialogs (cards, rows, text, buttons, switches, several pages) | /nsudialog web |
| Machines | Multiblock machines: structure, upgrades, weekly challenges | /mb web |
| Relics | Relic abilities and the block catalogue | /relics admin editor |
| Server page | The public page and its admin view (vote sites, tickets, staff logins) | /web, /web admin |
| Admin | For the site owner only: servers using the editor, and feature requests. You sign in with the owner's server-page login. | admin.html |
Resource pack builder
Add a picture players can use
- Open Scripts → More → 🎨 Resource pack and upload a PNG.
- Set its height (10 is about a letter's height) and how high it sits (8 lines it up with letters; more lifts it, less drops it). The chat-line preview shows the result.
- Copy the
{img:name} tag. It goes to the server with your next Save, then you apply it.
Merge a whole resource pack
Upload a .zip with an assets/ folder (up to 40 MB, up to 12 packs). Give it a name using letters, numbers, _ or -. It's saved to plugins/NysxlServerUtils/packs/ and merged into NSU's pack, so players still get one pack. Take it out of the pack removes it on the next Save.
Menu reference
Menu settings
| Key | What it does |
title, rows, filler | Title, 1–6 rows, background item (NONE for empty) |
type | chest, hopper, dispenser, dropper, or screen/dialog |
permission | Needed to open it |
open_command, args, args_usage | Website menus only. open_command: [shop] with args: [category] makes /shop tools fill %arg_category%. |
update_interval | Seconds between redraws for everyone viewing |
open_sound, open_actions, close_actions | Run on open and close |
placeholders | Your own placeholders: rank: "%luckperms_prefix%" → %rank% |
lang | Translations, used as {lang:key} by the player's game language |
lists.<id> | One button per online player, world or entry, with pages |
guide_hidden, hidden_menu | Keep it out of the guide book |
Button settings
| Key | What it does |
slot, hidden | Where it goes; hide it |
material | A material, head:<player>, texture:<hash>, base64:<value>, saved:<name> |
name, lore, amount, glow | Its look (:nl: splits a lore line) |
custom_model_data, item_model, tooltip_style | Resource pack models |
view_permission, view_condition | Only shown to some players |
click_permission, click_condition, deny_message | Who may click |
inherit | plugin:menu:button: borrow a plugin's button |
frames, frame_interval | Animation |
actions | Actions for each click type: LEFT, RIGHT, SHIFT_LEFT, SHIFT_RIGHT, DROP, MIDDLE |
Click actions
| Action | What it does |
open:<menu>, back, close, refresh | Move between menus |
command:<cmd>, console:<cmd> | Run as the player; run as console (only if allowed) |
message:, broadcast:, actionbar:, title:a|b, sound: | Tell the player something |
givemoney:<n>, takemoney:<n>, giveitem:MAT:n, takeitem:MAT:n, giveexp | Rewards and costs |
input:<question> | Ask in chat; the answer is %input% |
cooldown:<name>:<time>, once:<name> | Limit how often it can be used |
set:, add:, toggle: | Values remembered per player, shown as %value_<name>% |
connect:<server>, wait:<ticks> | Send to another server; pause |
do:<plugin>.<action>:<input> | An action another plugin offers (listed under From your plugins) |
if: / then: / else: | Checks: perm:, money:, level:, item:, cooldown:, once:, placeholder comparisons, ! for "not", && and || |
LEFT:
- if: "money:100 && perm:shop.buy"
then: ["takemoney:100", "giveitem:DIAMOND:1", "message:&aBought!"]
else: ["message:&cYou need $100.", "sound:ENTITY_VILLAGER_NO"]
Gotchas
- Saves can be up to 4 MB, so large pictures count against that.
- Export links carry your menus and command names. Don't post them publicly.
- Textures you load for the preview stay in your browser and are never uploaded. To give players a pack, use the Resource pack builder.
plugins/NysxlStaffUtils · jar NysxlStaffUtils-2.0
Nysxl Staff Utilities
The staff panel, staff mode with vanish, freezing, muting, warnings that step up to bans, tickets and reports, staff chat, command spy and mining alerts.
Getting started
- Give your staff group
staffutilities.admin. That makes them count as staff: they see tickets, show as online staff, and see each other in staff mode.
- Add the tools each rank needs:
.staffpanel (panel, freeze, mute, history), .staffmode, .punish (warn, kick), .ban, .tickets, .commandspy.
- Set vanish weights so senior staff can hide from junior staff (see below).
- Paste a Discord webhook into
discord.webhook for staff alerts.
Commands
| Command | What it does | Permission |
/ticket [question] | Your tickets, or open one (/tickets, /helpop) | staffutilities.tickets |
/ticket view <id> · rate <id> <1-5> | Read a ticket; rate the help you got | staffutilities.tickets |
/report <player> <what happened> | Report a player. Their recent chat is attached as evidence. | staffutilities.tickets |
/staffpanel [player] | The staff panel, or one player's page (/sp) | staffutilities.admin.staffpanel |
/staffmode | Switch staff mode on or off (/sm) | staffutilities.admin.staffmode |
/freeze <player> | Freeze or unfreeze | staffutilities.admin.staffpanel |
/mute <player> [minutes] [reason] | Mute; run it again to unmute (/unmute) | staffutilities.admin.staffpanel |
/warn <player> <reason> | Warn. Enough warnings trigger the next step automatically. | staffutilities.admin.punish |
/ban <player> [time] [reason] | Ban for good, or for 30m, 12h, 7d, 2w | staffutilities.admin.ban |
/tempban <player> <time> [reason] · /unban <player> | Timed ban; lift a ban | staffutilities.admin.ban |
/history <player> | Their record of warnings, mutes, kicks and bans (/record) | staffutilities.admin.staffpanel |
/alts <player> | Accounts from the same address | staffutilities.admin.staffpanel |
/note <player> <text> · /notes <player> | Private staff notes | staffutilities.admin.staffpanel |
/sc [message] | Staff chat. On its own it toggles staff chat for everything you type. | staffutilities.admin |
/commandspy | See the commands players run (/cmdspy) | staffutilities.admin.commandspy |
The ban, tempban, unban and warn commands also have s-prefixed aliases (/sban, /swarn...) in case another plugin owns the plain name.
Staff mode and vanish
Staff mode saves your inventory and gives you a tool hotbar:
| Slot | Tool | Use |
| 1 | Staff panel (nether star) | Right-click for the panel; right-click a player for their page |
| 2 | Vanish (lime/grey dye) | Hide or show yourself |
| 3 | Random player (ender eye) | Teleport to a random player |
| 4 | Freeze wand (blue ice) | Hit or right-click a player to freeze or unfreeze them |
| 5 | Inspector (chest) | Right-click a player for their inventory; sneak + right-click for their ender chest |
Vanish weights
Give staff staffutilities.vanish.<n>, for example .1 for helpers, .5 for admins and .10 for the owner. A vanished staffer can only be seen by staff whose own weight is at least as high. A bigger number means fewer people can see you. Staff without a weight are 0. Players who aren't staff never see anyone vanished.
ExampleAn admin at weight 5 vanishes. Moderators at weight 1 can't see them, but another admin at 5 and the owner at 10 can. When the owner vanishes at 10, nobody below 10 sees them.
Banned items from bannedBlocks.yml (bedrock, barriers, command blocks, portals...) can't be placed, dropped or taken in staff mode unless you have staffutils.bypass.
Tickets and reports
- Players pick a category when opening a ticket: bug, grief, player report, ban appeal, store, question or other.
/report always uses player.
- Staff with
staffutilities.admin.tickets see and handle everyone's tickets, including ready-made Quick replies (some also close the ticket).
- Unanswered tickets remind online staff every 30 minutes. Tickets waiting on the player close by themselves after 3 days.
- Players whose reports keep turning out to be nothing get marked "often reports nothing". With
block-untrusted-reports they can't report at all.
- Banned players see an appeal code. They can appeal with their name and that code on the website's Rules page.
The staff panel
/staffpanel opens the panel. It has a Staff online list, the ticket queue, and a staff mode switch. /staffpanel <player> (or right-clicking a player with the nether star) opens that player's page:
| Button | What it does |
| Teleport to them · Bring them here | Move to the player, or move them to you |
| Warn · Kick | Click, then type the reason in chat |
| Ban · Unban | Left-click bans for good, right-click bans for a time. Then type the reason. |
| Record | Their warnings, mutes, kicks and bans ("A clean record" if there are none). Staff with .punish can take a line off. |
| Notes | Private staff notes. Click to read or add one. |
| Alts | Accounts that joined from the same address |
| Their tickets | Every ticket this player has made |
| More tools | Inventory, ender chest, heal, game mode and money |
Handling tickets (staff)
- New tickets and reports alert online staff (and Discord, if it's set up). Open the queue from the staff panel.
- Open a ticket to claim it, so other staff know you're on it. Claimed by me filters to your own tickets.
- Reply by typing, or pick a Quick reply from
tickets.quick-replies. Go to where it was made teleports you to the spot the player was standing.
- Close it when it's done. The player can also press My problem's solved, and they're asked to rate the help from 1 to 5.
- For reports, mark whether there was really something wrong. That's how players who keep reporting nothing get flagged.
- Closed tickets keeps them for
keep-closed-days. From there you can reopen or delete them. Staff stats shows how many tickets each staff member handled, and their ratings.
Ban appeals and tickets can also be answered from the website's staff view (/web admin). The appeal code in the ban message ties an appeal to the right ban.
Warnings that step up
In config.yml under warnings.steps, each count of active warnings triggers an action. The defaults are:
warnings:
expire-days: 30 # older warnings stop counting
steps:
3: "mute 60"
5: "tempban 1d"
7: "tempban 7d"
10: "ban" # also: "kick", "command:<console command with {player}>"
Config keys that matter
| Key | Default | What it does |
tickets.max-open-per-player | 3 | Open tickets per player (staff unlimited) |
tickets.keep-closed-days | 30 | How long closed tickets are kept |
tickets.report-cooldown-seconds | 120 | Time between a player's reports |
tickets.remind-minutes · auto-close-days | 30 · 3 | Staff reminders; auto-close |
tickets.categories · quick-replies | | Ticket types and canned replies |
staff-mode.vanish | true | Start staff mode hidden |
frozen.allowed-commands | ticket, msg, r… | What a frozen player can still run |
mute.blocked-commands | msg, tell, me… | What a muted player can't run (chat is always blocked) |
bans.appeal | text with {code} | The message shown to banned players |
alts.alert-banned | true | Alert staff when someone shares an address with a banned player |
command-spy.ignore | login, register… | Never shown by command spy |
mining-alerts.ores · minutes | 8 diamonds in 5 min… | X-ray alerts |
staff-chat.prefix · format | # | Start a line with # to send it to staff only |
discord.webhook · kinds | "" | Alerts to Discord: report, ticket, appeal, escalated, warn, ban, mining, staffchat |
Gotchas
/sm is staff mode here and the server menu in NSU. Staff should type /staffmode.
- Chat logs attached to reports are kept in memory only and are lost on restart.
- To hide one staff member from command spy, give them
staffutilities.commandspy.hidden. To exempt someone from mining alerts, give them staffutilities.miningalerts.exempt.
plugins/NysxlRelics · module nysxl-relics
Nysxl Relics
Generated relic items with stats, perks, drawbacks and hidden curses. Players forge, salvage, socket gems, reforge, cleanse, engrave and awaken them. Each relic has an element (volcanic, frost, void, storm, celestial, blood, necrotic, verdant, chronos, miner) and a rarity from common to mythic.
Getting started
- Players type
/relics for a menu with everything: forge, salvage, gems, inspect, codex, cleanse, reforge, engrave.
- Give a test relic with
/relics admin generate sword volcanic rare.
- Relic parts and whole relics can drop from PPLootChests tables (
relic_parts and relics).
- Edit abilities on the website with
/relics admin editor, then /relics admin apply <code>.
Player commands
| Command | What it does | Permission |
/relics | The relics menu (/relic) | nysxlrelics.use |
/relics forge · salvage | Build a relic from parts; break one into parts | nysxlrelics.forge |
/relics gems | Socket and fuse gems (the lapidary) | nysxlrelics.gems |
/relics inspect | Full details of the held relic | nysxlrelics.inspect |
/relics codex | Traits you've discovered | nysxlrelics.codex |
/relics reforge | Reroll the held relic with a new seed | nysxlrelics.reforge |
/relics cleanse | Remove a revealed curse | nysxlrelics.cleanse |
/relics engrave | Put a motto on a relic | nysxlrelics.engrave |
Admin commands (/relics admin …)
| Command | What it does | Permission |
generate [type] [element] [rarity] [part:look…] [player] | Make a new relic | nysxlrelics.generate |
give <category> [rarity] [player] [seed] | Give a hand-made relic | nysxlrelics.give |
gem <type|traitId> [quality] [player] | Make a socketable gem | nysxlrelics.gem |
part roll [type] [slot] [element] [rarity] [player] · parts | Roll a relic part; list parts | nysxlrelics.admin |
builder [number|new] | In-game trait builder for the held item | nysxlrelics.builder |
editor · apply <code> | Website ability editor; apply its save | nysxlrelics.builder |
save | Save the held generated relic as YAML | nysxlrelics.save |
texture info|reroll|set|flag|export | Inspect and change a relic's look | nysxlrelics.texture |
ledger | Register of relics players own | nysxlrelics.admin |
panel · list · reload | Admin panel; categories and items; reload | nysxlrelics.admin / .list / .reload |
nysxlrelics.admin includes every relics permission.
Config keys that matter
| Key | Default | What it does |
mode | rpg | rpg shows a stat sheet; vanilla-plus keeps lore short |
tooltip | compact | compact or full lore (inspect always shows everything) |
balance.* | see file | PvP and PvE caps: max-hit 30, pvp-multiplier 0.6, boss-multiplier 0.5, crit and life-steal limits. These apply on every hit, so old relics follow new limits too. |
max-curses · max-hidden-curses | 2 · 1 | Curses per relic |
features.* | | Switch off memory, trophies, skills, staff spells or engraving; switch on mutation, battle scars or sensory effects |
rarity-weights · power-budget | | How often each rarity rolls, and how strong it is |
awakening.ritual.* | 900 s | Awakening rituals: a kill milestone, then offerings on pedestals plus a catalyst for each element |
soulbound-mythic | false | Mythic relics stay with you on death |
minions.max-per-player | 6 | Summoned minions alive at once |
editor.port · public-url | 28765 | Where the website ability editor calls back |
Content lives in categories/ (one file per element), traits/, items/ (hand-made relics), parts.yml and textures.yml.
How a relic is made
- Element and rarity. Each relic belongs to an element (its category file) and rolls a rarity using
rarity-weights. Rarity sets its power budget, from 6 for common up to 36 for mythic.
- Traits. The generator spends the budget on traits from the element's
trait-pool. A trait is a perk (good), a drawback (bad, which buys more perks; perk-drawback-ratio sets the balance), or a curse.
- Hidden curses stay secret until they first trigger. Then they're revealed on the item, and players can remove them with
/relics cleanse.
- Stats. Each relic has five stats: might (1–20), haste (0–12), fortune (0–8), guard (0–16) and luck (0–10). The
balance caps limit what they can do in a fight.
- Seeds. Each relic is made from a seed, so the same seed gives the same relic.
/relics reforge rerolls it with a new seed.
- Parts. Modular relics are built from parts: handle, guard, blade or head, and gem. Players combine parts at the forge and break relics back into parts at the salvage station.
Triggers and actions
Each trait fires on a trigger and then runs actions, with a cooldown in ticks.
| Trigger | Fires when the holder… |
hit · kill · damaged | Hits something, kills something, or takes damage |
right_click · sneak_click | Uses the relic, or uses it while sneaking |
break_block · land · held_tick | Mines a block, lands from a fall, or simply holds it (passive) |
Built-in actions include damage, heal, potion, velocity, chain_lightning, frost_freeze, blood_drain, vein_mine, smelt_drops, seismic_slam, summon_minion, stasis_bubble, place_block/remove_blocks (only when block-modifies-world is on) and particle and sound effects. A trait can also run an NSU event script by name.
Gems
Gems socket into relics at the lapidary (/relics gems) and add stats plus an elemental effect. Two gems of the same kind fuse into a better grade.
The six gems are the Ruby of Cinders, Sapphire of the Depths, Topaz of the Tempest, Amethyst of the Void, Emerald of Vitality and Diamond of Sovereignty. Each gives its own main stats, an elemental effect and a tint on the relic. Make one with /relics admin gem <type> [quality] [player].
Grades from lowest to highest: Chipped (×1), Flawed (×1.5), Flawless (×2.2), Perfect (×3.2), Celestial (×5).
Extra systems (features.*)
| Feature | Default | What it does |
memory | on | Relics remember their kills, blocks mined and owner |
trophies | on | Notable kills are listed on the relic |
skills | on | Active abilities on right-click |
staff-spells | on | Relic staffs cast a spell on right-click |
engraving | on | The engraving station (a motto on the item) |
mutation | off | A relic's colour slowly shifts towards how it's used |
battle-scars | off | Killing rival team leaders or surviving near death marks the relic |
sensory | off | Sounds and effects when you switch to a relic |
Content files
A category (categories/volcanic.yml)
id: volcanic
materials: [NETHERITE_SWORD, NETHERITE_AXE, BOW, NETHERITE_PICKAXE]
trait-pool: { meteor_landing: 8, flame_barrage: 8, combustion_strike: 7 } # trait: weight
curse-traits: [blazing_recoil]
rarity-weights: { common: 20, rare: 25, legendary: 10, mythic: 4 }
max-curses: 1
name-parts: { prefixes: [Cinder, Ashen, Magma] }
Anything left out of a category uses the value from config.yml. The ten elements are volcanic, frost, void, storm, celestial, blood, necrotic, verdant, chronos and miner.
A trait (traits/chain_lightning.yml)
id: chain_lightning
display-name: Chain Lightning
role: perk # perk, drawback or curse
power: 12 # what it costs from the budget
cooldown: 80 # ticks
trigger: hit
actions:
- { action: chain_lightning, damage: 9.0, chains: 4, range: 7.0 }
A hand-made relic (items/meteor_pick.yml)
id: meteor_pick
material: NETHERITE_PICKAXE
name: Meteor Pick
category: volcanic
rarity: legendary
traits: [meteor_landing]
stats: { might: 14, fortune: 4, haste: 2 }
Give one with /relics admin give meteor_pick. You can also hold a generated relic you like and run /relics admin save to write it out as a file like this. Hand-made parts go in parts.yml.
How to run an awakening ritual
- The relic must first reach its element's kill milestone (25 for most elements, 50 for chronos, celestial and blood).
- Place the listed offerings on pedestals within 8 blocks. Pedestals are lodestone, chiseled blackstone or quartz, or respawn anchors.
- Bring the catalyst (for example a netherite ingot for volcanic, or a nether star for celestial). The ritual runs in stages for 15 minutes and is announced to the server.
Gotchas
- Relics needs NSU, and it uses PPLootChests, SmartShop, Estates, WorldGuard and PlaceholderAPI when they're present.
- When the server is on a different machine, the website ability editor needs
editor.public-url set to a reachable address.
plugins/NysxlEstates
Nysxl Estates
Teams and land claims. Teams claim land with a shovel, protect it with flags, trust outsiders with chosen access, and share homes, warps, team chat and a bank. Teams level up through upkeep, taxes and XP.
Getting started (players)
/team create <name> starts a team. Invite friends from the team menu (/team). They join with /team accept <team>.
/team getClaimShovel gives the claim shovel. Right-click one corner, then the opposite corner. Left-click to cancel.
- Open
/team to manage members, roles, claims, flags, trust and effects.
/team sethome inside your claim, then /team home.
Commands
| Command | What it does | Permission |
/team | The team menu (/t) | nysxlestates.team.base |
/team create <name> | Start a team | nysxlestates.team.create |
/team accept|deny <team> | Answer an invite | nysxlestates.team.base |
/team info · overview | Your team's details | nysxlestates.team.info |
/team leave · disband | Leave; owners disband | .team.leave · .team.disband |
/team claim | Claim tools and the claim list | team role |
/team getClaimShovel | Get the claim shovel | nysxlestates.team.getClaimShovel |
/team home · sethome | Team home | nysxlestates.team.home |
/team warps · warp <name> · setwarp · delwarp | Team warps (more slots as the team levels) | nysxlestates.team.warp |
/team chat | Toggle team chat | nysxlestates.team.chat |
/team map | A Claim Atlas map showing claims, homes and warps | nysxlestates.team.map |
/team top | Top teams | nysxlestates.team.top |
/team spy · bypass · adminMenu · reloadGUIs | Read team chats; ignore claims; admin menu; reload menus | nysxlestates.admin |
/estates · /estates admin | Estates help; the settings menu | nysxlestates.base · .admin |
/estates voucher <type> <amount> <player> | Give a voucher (claim blocks, protection, XP or bank money) | nysxlestates.admin |
/estates reward <player> <potion> <duration> <amp> <claims> | Give a claim effect reward | nysxlestates.admin |
Claims, flags and access
- Flags are set per claim: PvP, mob spawning, explosions, fire spread, liquid flow, entry, outsider doors, crop trampling, animal damage. In settings, admins choose each flag's default and whether owners may change it.
- Trust gives players outside the team any mix of: build, break, containers, doors, entities, interact, entry, teleport.
- Subclaims are areas inside a claim with their own access.
- Server claims are admin-owned protected areas such as spawn.
- Resizing: drag a claim's corner with the claim shovel.
- Claim effects: paid potion effects inside your claims.
Coming soonSubclaims inside server claims, with access for Everyone or for a permission group (for example, a public market stall area inside spawn). This is being built now and isn't in the current jar yet.
Flags in detail
| Flag | Default | When on |
| PvP | off | Players can fight each other here |
| Monster spawning | on | Hostile mobs spawn naturally |
| Explosions | off | Creepers and TNT can break blocks (in protected claims) |
| Fire spread | off | Fire can spread and burn blocks (in protected claims) |
| Liquids flowing in | off | Water and lava from outside can flow in (in protected claims) |
| Entry | on | Outsiders may walk in. Turning it off keeps non-members out. |
| Doors & buttons for all | off | Anyone may use doors, gates, buttons and levers |
| Crop trampling | off | Farmland can be trampled |
| Animal damage | off | Outsiders can hurt animals and villagers |
Trusting players
From a claim's menu, trust a player who isn't in your team and tick what they may do:
| Access | Lets them |
| Build | Place blocks and use buckets |
| Break | Break blocks |
| Containers | Open chests, barrels, furnaces and other storage |
| Doors & redstone | Use doors, gates, trapdoors, buttons, levers and pressure plates |
| Animals & entities | Use or hurt animals, villagers, item frames and armour stands |
| Other interactions | Anything else, such as bone meal, beds, crafting stations or flint and steel |
| Entry | Come in when the claim's Entry flag is off |
| Teleport in | Arrive by ender pearl or chorus fruit |
The same access list is used for subclaims, so a farm subclaim can allow Break and Containers while the house stays closed.
Ranks
Every team has an owner rank, an admin rank and a default rank for new members, and you can add your own in the roles menu. Each rank has a weight and a set of rights: claim, unclaim, pay for protection, deposit and withdraw from the bank, invite, promote, demote and manage members. The rules are:
- The team owner and server admins (
nysxlestates.admin) can do everything.
- Everyone else needs the right on their rank.
- Nobody can act on a member whose rank weight is equal to or higher than their own.
Editing a menu file can never hand out a right, because every action checks the rank again.
Protection, upkeep and levels
- Protection time. Claims are protected for as long as protection has been paid. The cost is
costPerBlock (0.1) × the claim's area, in claim_currency, both in pluginData.yml. Set always_protected: true to skip paying.
- Upkeep. Each day the team bank pays
upkeep.per-block-per-day for every claimed block. After grace-days unpaid, upkeep.penalty applies: UNPROTECT (claims lose protection) or SHRINK (the newest claim is released). Debt Collectors from Jobs can then recover the debt.
- Taxes. A team can charge members a daily tax into the bank, up to
taxes.max-per-day.
- Levels. Teams earn XP from members' playtime and money deposited. Each level adds claim blocks, warp slots and an upkeep discount.
- Inactive cleanup. When nobody in a team has played for
cleanup.inactive-days (45), cleanup.action applies: UNPROTECT, UNCLAIM or DISBAND.
- Vouchers.
/estates voucher <type> <amount> <player> gives an item that a team member right-clicks to redeem. The types are CLAIM_BLOCKS, PROTECTION_HOURS, TEAM_XP and TEAM_BANK. Vouchers make good vote or crate rewards.
Settings (/estates admin)
Every setting is changed in game from /estates admin and saved straight away to settings.yml. Each feature can be switched off: flags, trust, subclaims, resize, server claims, homes, warps, team chat, upkeep, taxes, levels, inactive cleanup, atlas, claim effects, enter messages, vouchers.
| Key | Default | What it does |
claims.blocks-per-member | 2000 | Claim blocks a team gets per member |
levels.blocks-per-level · warps-per-level | 1000 · 0.5 | What each team level adds |
levels.max-level · xp-base | 50 · 100 | Level curve |
levels.xp-per-member-minute · xp-per-money | 1 · 0.1 | XP from playtime and bank deposits |
levels.upkeep-discount-per-level | 2.0 | % off upkeep per level |
upkeep.per-block-per-day · grace-days | 0.01 · 3 | Daily cost per claimed block, paid from the team bank |
upkeep.penalty | UNPROTECT | What happens when upkeep isn't paid |
taxes.max-per-day | 1000 | Highest daily tax a team can charge members |
warps.base | 1 | Warp slots before levels |
teleport.warmup-seconds · cooldown-seconds | 3 · 30 | Home and warp teleports |
homes.must-be-in-claim | true | Homes only inside your own claim |
cleanup.inactive-days · action | 45 · UNCLAIM | Clean up land of teams nobody has played on |
chat.format | &8[&bTeam&8] … | Team chat look |
Older files: pluginData.yml (costPerBlock, claim_currency, blocksPerClaim), GUIs/ (menu layouts), and Language/ (en, de, es).
Gotchas
- Upkeep is taken from the team bank. A team with an empty bank loses protection after the grace days, so tell players to keep money in it.
- Jobs pays a bonus for working inside your own claim and can send a share to the team bank. Debt Collectors (
/collect) chase teams behind on upkeep.
- Teams and claims appear on the server web page when
show-estates: true.
plugins/NysxlJobs
Nysxl Jobs
Jobs that pay for mining, farming, fishing, hunting and more, with levels, shifts that sell your haul through SmartShop, contracts, skills, perks, daily goals, boosters and seasons. Everything is editable in game.
Getting started
- Players open
/jobs, browse the jobs and join up to 3 (nysxljobs.max.<n> changes this).
- Work earns money and XP. Pay is added up and paid every 5 seconds, with one action-bar summary.
/jobs clockin starts a shift: mined and harvested items are sold for you, and the company keeps 10%.
- Admins change jobs, rewards and every setting in
/jobs admin.
The 15 jobs are alchemist, blacksmith, bounty hunter, builder, chat warden, courier, debt collector, explorer, farmer, fisher, hunter, miner, rancher, town guard and woodcutter (one file each in jobs/).
Commands
| Command | What it does | Permission |
/jobs | Browse jobs (/job) | nysxljobs.use |
/jobs join|leave|info <job> | Join, leave, or read about a job | nysxljobs.use |
/jobs stats [player] | Your levels and earnings (others need admin) | nysxljobs.use |
/jobs top <job> · leaderboards | Rankings | nysxljobs.use |
/jobs clockin · clockout · shift | Shifts and current shift earnings | nysxljobs.use |
/jobs goals · contracts · skills <job> | Daily goals; the contract board; skill points | nysxljobs.use |
/fine <player> | Chat Wardens fine banned words | nysxljobs.use |
/bounty <player> <amount> | list | track <player> | Bounty Hunters (see the note below) | nysxljobs.use |
/collect [team] | Debt Collectors: teams behind on upkeep | nysxljobs.use |
/send <player> [fee] · /send cancel · /deliveries | Courier deliveries | nysxljobs.use |
/jobs admin | Job editor, settings, features, storage | nysxljobs.admin |
/jobs booster <percent> <minutes> | Server-wide pay booster | nysxljobs.admin |
/jobs season end | End the season now and reward the top 3 | nysxljobs.admin |
/jobs import jobsreborn [overwrite] | Bring over Jobs Reborn jobs | nysxljobs.admin |
/jobs reload | Reload settings and jobs | nysxljobs.admin |
Config keys that matter
| Key | Default | What it does |
max-jobs | 3 | Jobs held at once |
default-currency | DEFAULT | NSU currency jobs pay in |
leave.cooldown-minutes · keep-progress | 60 · true | Rejoin wait; keep levels after leaving |
market.percent-of-sell-price | 10 | "Market" rewards pay this % of SmartShop's sell price |
shift.company-cut.percent · pay-wage | 10 · true | The company's cut; also pay normal wages on shift |
shift.required-for-pay | false | Only pay money while clocked in |
anti-exploit.* | on | No pay for placed blocks, AFK fishing or creative mode; diminishing returns; spawner mobs pay 0% |
disabled-worlds | [] | Worlds where jobs never pay |
storage.type | FILES | FILES, SQLITE or MYSQL. Switch it in admin → Settings → Storage. |
supply-orders.* | on | Bonus pay when a shop runs low on an item |
daily-goals.* · contracts.* · skills.* | on | Goals with streaks; timed contracts; skill trees |
estates.own-claim-bonus-percent | 10 | Extra pay inside your own team's claim |
estates.team-bank-share-percent | 0 | Share of pay sent to the team bank |
seasons.length-days | 7 | Season length; the top 3 per job get rewards |
Every job
| Job | Paid for |
| Miner | Stone and ores (BREAK). Rarer ores pay more, up to ancient debris. |
| Woodcutter | Logs (BREAK) |
| Farmer | Fully grown crops, breeding and shearing |
| Rancher | Milking cows and goats, eggs, honey, breeding and shearing. Each animal pays for milking every 5 minutes. |
| Fisher | Fish and treasure. AFK fishing doesn't pay. |
| Hunter | Killing monsters. Spawner mobs pay much less. |
| Builder | Placing blocks and crafting building materials |
| Alchemist | Brewing. Stronger and longer potions pay more, splash +25%, lingering +50%. You must be at the stand. |
| Blacksmith | Anvil repairs and combines, paid per XP level the anvil costs |
| Explorer | New chunks, new biomes and structures (villages, temples, ancient cities…), the first time only |
| Town Guard | Hostile mobs killed inside a claim at night, +50% in another team's town |
| Chat Warden | Fining players who say a banned word (/fine) |
| Bounty Hunter | Collecting bounties (/bounty). Limited to 8 players. |
| Courier | Delivering parcels (/deliveries): the sender's fee plus pay by distance |
| Debt Collector | Recovering unpaid Estates upkeep (/collect). Limited to 6 players. |
A job file (jobs/miner.yml)
name: "&7Miner"
icon: IRON_PICKAXE
description: ["Dig stone and ores.", "Rarer ores pay more."]
currency: "" # empty = default-currency
permission: "" # empty = anyone can join
max-level: 100
xp-base: 50 # XP for next level = xp-base × level ^ xp-exponent
xp-exponent: 1.3
pay-per-level-percent: 1.0 # level 50 pays +49%
take-items: true # on shift, drops are taken and sold
max-players: 0 # optional cap (bypass: nysxljobs.bypass.limit)
actions:
BREAK:
STONE: {money: 0.05, xp: 0.5}
DIAMOND_ORE: {money: 8.0, xp: 25}
IRON_ORE: {market: true, xp: 5} # pays a share of SmartShop's sell price
level-rewards:
10: { money: 500, message: "&7Here's &a500&7." }
25: { money: 2500, commands: ["give {player} diamond_pickaxe 1"] }
Everything here can be edited in game at /jobs admin → the job, including the skill tree. The action types are BREAK, PLACE, CRAFT, HARVEST, BREED, SHEAR, COLLECT, FISH, KILL, BREW, REPAIR, EXPLORE, GUARD, FINE, BOUNTY, DELIVER and COLLECT_DEBT.
Skills, contracts, goals and streaks
- Skill trees (
/jobs skills <job>): each job level gives skill points to spend. Skills can add pay, double drops, potion effects, jackpots (a lucky payout worth 5× normal), vein miner and tree feller (only while sneaking, so normal mining stays normal), and overdrive (sneak + F for +50% pay and haste, every 10 minutes). Some skills are a choice: picking one path locks the other. Resetting costs skills.respec-cost (1000).
- Contracts (
/jobs contracts): a board of 6 timed jobs, refreshed every 2 hours. Take up to 2, finish in 90 minutes, and earn 2× the normal pay and XP on top, plus server level XP.
- Daily goals (
/jobs goals): 3 goals a day from your own jobs. Finishing them all keeps a streak going, worth +10% per day up to +100%.
- Work streaks: keep working without a break of more than 8 seconds and pay rises 2% for every 25 actions, up to +20%.
- Boosters:
/jobs booster 50 30 gives everyone +50% for 30 minutes. Personal boosters stack with it.
- Supply orders: when a SmartShop item falls below 25% of its restock amount, jobs pay +50% for it for 30 minutes.
- Seasons: every 7 days the top 3 earners in each job get
seasons.rewards (5000 / 2500 / 1000 by default), and season stats reset.
- Server levels: 25% of job XP also counts toward NSU levels and the battle pass.
Settings for the special jobs
These files are written into plugins/NysxlJobs/ the first time they're needed.
| File · key | Default | What it does |
chat-police.yml · words | noob 25, idiot 50… | Word and fine. Matching ignores capitals, l33t spelling and stretched letters, and only matches whole words. |
chat-police.yml · fine-window-seconds | 300 | How long after saying it someone can be fined |
chat-police.yml · warden-cut-percent · rest-goes-to | 20 · treasury | The warden's share; the rest goes to the treasury or nowhere |
chat-police.yml · censor | false | Also blank the word out in chat |
chat-police.yml · max-fines-per-player-per-hour | 5 | Protects players from being fined over and over |
bounty.yml · currency | BHC | Bounties are paid in Bounty Hunter Coin |
bounty.yml · hunters-only | true | Only Bounty Hunters can collect |
bounty.yml · expire-days · tax-percent | 7 · 10 | Unclaimed bounties go back to whoever placed them; the treasury's cut |
bounty.yml · claim-cooldown-minutes · track-cooldown-minutes | 60 · 5 | One claim per target per hour; tracking cooldown |
courier.yml · default-fee · minimum-fee | 25 · 10 | Parcel fees |
courier.yml · delivery-minutes · open-days | 30 · 3 | Time to deliver; how long before an untaken parcel goes back |
debt-collecting.yml · collector-cut-percent | 15 | The collector's share |
debt-collecting.yml · max-share-of-balance-percent | 25 | The most taken from one member per visit |
debt-collecting.yml · must-be-on-their-land | true | The collector must stand in the team's claim |
Permissions
| Permission | Default | What it gives |
nysxljobs.use | true | Browse, join and leave jobs, and the job commands |
nysxljobs.admin | op | Edit, reload, see anyone's stats |
nysxljobs.max.<n> | false | Hold n jobs |
nysxljobs.bypass.limit · .bypass.cooldown | op | Join full jobs; skip the rejoin wait |
nysxljobs.fine.exempt | false | Can't be fined by chat wardens |
Gotchas
- /bounty is claimed twice, by NSU's bounties feature and by the Bounty Hunter job. Use
/nysxljobs:bounty for the job's version, or set enabled: false in NSU's bounties.yml.
- Without SmartShop, shifts only work with
shift.fixed-price-fallback: true, and market rewards pay their normal money instead.
- Selling a haul through SmartShop raises stock and lowers the price, so farming one item pays less over time. That's intended.
plugins/NysxlSmartShop · needs Vault
Nysxl SmartShop
Admin shops whose prices move with supply and demand, player chest shops, an auction house, buy orders, sell wands and market events. When SmartShop is installed, it takes over NSU's auction house and its data.
Getting started
/smartshop create adminshop <name>, then /shop edit <name> to add items and prices.
- Players open it with
/shop <name>. They need shop.open plus shop.open.<name>.
- Every option is in
/smartshop settings, and every sale is in /smartshop log.
- Chest shops: sneak and left-click your own chest while holding the item.
Commands
| Command | What it does | Permission |
/shop [shop] | Open shops (/smartshop, /sshop) | shop.open + shop.open.<shop> |
/shop open <shop> [player] | Open a shop, or open it for someone else | shop.open · shop.openfor |
/smartshop create adminshop <name> | Make an admin shop | shop.admin |
/shop edit|delete <shop> | Edit or delete a shop | shop.edit · shop.delete |
/smartshop settings | Every SmartShop option in a menu | smartshop.admin |
/smartshop log [filter] | Transaction log | smartshop.admin |
/shop reload · /shopreload | Reload settings, messages and auction config | shop.reload |
/ah · /ah sell · /ah claim | Auction house; list the held item; collect items and money (/auction, /auc) | auction.GUI |
/ah orders · /buyorders [mine] | Buy orders (/bo) | smartshop.buyorders.use |
/buyorders create [amount price [hours]] | Post what you want to buy | smartshop.buyorders.use |
/ah ban|unban <player> | Stop a player using the auction house | auction.admin |
/sellwand get|create|setItem|addShop|setUses|setUnlimited|setPenalty | Make and hand out sell wands (also in settings) | sellwand.admin |
/categoryGUI create|edit|open <name> | Category menus | category.admin |
/eventEditor open | Market event editor | eventEditor.admin |
Setting up a shop item
In /shop edit <shop>, click an item to open its Item Editor. Left-click raises a number, right-click lowers it, and Q (drop) lets you type an exact value.
| Option | What it does |
| Buy price · Sell price | What players pay, and what they get for selling one |
| Dynamic pricing | The price moves as players buy and sell. Off keeps it fixed. |
| Stock · Infinite | How many the shop holds. Infinite never runs out. Selling to the shop adds stock and buying removes it. |
| Stock price factor | How strongly stock levels push the price up or down |
| Max purchase amount | A limit per player, over a time window you choose (for example 64 every 24 hours) |
| Currency | Which NSU currency this item uses |
| Permission | Only players with it can buy this item |
| Give item on purchase · Run command | Hand over the item, run a command (for ranks, keys and so on), or both |
| Live update | Prices refresh in open menus as they change |
Items can be grouped into category menus (/categoryGUI) that lead to several shops. Players can sell a whole inventory at once from the shop's Sell All window.
Market events
Every 5 to 15 minutes there's a 30% chance an event starts. It picks a shop that allows events and some random items in it, then changes each one for a while: buy price ×, sell price ×, or a one-off stock change. Events are announced in chat and shown on a boss bar (events.bossbar). Design them in /eventEditor open: name, length, which change types are allowed, how big the changes can be, and custom announcement lines using {shopName}, {eventName}, {itemName} and {amount}.
Sell wands
/sellwand create <name>, then /sellwand setItem <name> while holding the item it should look like.
/sellwand addShop <name> <shop> chooses which shops it sells to.
setUses <n> or setUnlimited true. setPenalty <0-1> pays less than selling by hand. Each wand also has a pay multiplier.
- Players right-click a chest with the wand to sell everything in it. With
sellwand.all-containers: true, barrels and other containers work too.
Chest shops
- Hold the item you want to trade and sneak + left-click your own chest, trapped chest or barrel.
- Set the buy and sell prices in the window that opens. A sign shows the shop.
- Customers right-click the sign to trade. The owner gets the management window instead.
- Only the owner (or
smartshop.chestshop.admin) can open, break or extend the chest. Hoppers, pistons and explosions can't touch it.
With Estates, team chest shops can pay into the team bank, and chestshops.require-own-claim limits shops to your own land.
Buy orders
/buyorders create <amount> <price> [hours] posts "I want 64 diamonds at 50 each". The money is held in escrow straight away. Other players fill the order from /buyorders by handing in the items, and get paid from the escrow. The buyer collects the items. Anything unfilled is refunded when the order expires.
Placeholders
| Placeholder | Shows |
%smartshop_buy_<shop>_<page>_<slot>% | An item's current buy price (also _sell_, _stock_, _trend_) |
%smartshop_auctions_active% · _unclaimed% | The player's listings; items waiting to be collected |
%smartshop_auctions_money_<currency>% | Money waiting to be collected |
%smartshop_chestshops% | How many chest shops they own |
%smartshop_event% · %smartshop_event_shop% | The running market event, or "none" |
Settings that matter
These are all in /smartshop settings.
| Key | Default | What it does |
pricing.change-per-unit-percent | 0.01 | How far the price moves for each item bought or sold |
pricing.drift-percent · idle-minutes | 5 · 10 | Prices drift back after 10 quiet minutes |
pricing.max-sell-to-buy-percent | 95 | Sell price can never pass 95% of the buy price |
chestshops.max-per-player · creation-fee · tax-percent | 10 · 0 · 0 | Chest shop limits and fees (smartshop.chestshop.limit.<n> raises the limit) |
chestshops.require-own-claim | false | Chest shops only inside your own Estates claim |
auction.max-listings · max-duration-hours | 10 · 168 | Auction limits (smartshop.auction.listings.<n> raises the listing limit) |
auction.listing-fee-percent · sales-tax-percent | 0 · 0 | Auction fees |
buyorders.max-per-player · fill-tax-percent | 5 · 0 | Buy order limits (smartshop.buyorders.limit.<n>) |
events.min/max-interval-minutes · trigger-chance-percent | 5–15 · 30 | How often market events fire |
treasury.all-admin-shops | false | Admin shop takings go to the NSU treasury |
discord.enabled · webhook-url | false | Post auction sales to Discord |
storage.mysql.* | off | Use MySQL instead of SQLite |
Gotchas
- A shop needs both
shop.open and shop.open.<name>. If players say "no permission", check the second one first.
- Jobs and SpawnerWorks sell through SmartShop's admin shops, so changing a shop's prices changes what they pay.
smartshop.admin includes all the *.admin nodes.
plugins/PPLootChests · v2.0.0
PPLootChests
Per-player loot chests. Each player gets their own roll from the same chest, on their own cooldown. It also has loot bags that drop from blocks and mobs, extra loot in the world's structure chests, and relic drops.
Getting started
/lt create <name> makes a loot table. /lt edit <name> fills it from a menu.
- Look at a chest and run
/lt setBlock <name>. Now every player loots it separately.
- Use
/lt drops <name> to make the table drop as a loot bag from blocks, mobs or structure chests.
/lt admin holds the overview and settings, with teleports to every assigned chest.
Commands (/lootTables, alias /lt)
| Command | What it does | Permission |
/lt create <name> | New loot table | pplootchests.admin.create |
/lt edit <name> | Edit items, chances, cooldown and relic drops | pplootchests.admin.edit |
/lt setBlock <name> | Make the block you're looking at a loot chest | pplootchests.admin.setblock |
/lt remove <name> | Delete a table | pplootchests.admin.delete |
/lt drops <name> | World drops: blocks, mobs, structure chests | pplootchests.admin.drops |
/lt admin · settings | Admin overview; anti-exploit and world loot settings | pplootchests.admin.settings |
/lt getLootBag <name> | Get a loot bag | pplootchests.admin.getLootBag |
/lt giveLootBag <name> <player> | Give one | pplootchests.admin.getLootBag |
/lt dropLootBagAt <name> <x> <y> <z> <world> | Drop one at a spot (good for events) | pplootchests.admin.getLootBag |
/lt reload | Reload loot.yml | pplootchests.admin.reload |
pplootchests.admin includes all of these. Looting needs pplootchests.loot.*, which everyone has. Deny pplootchests.loot.<table> to lock one table.
loot.yml
loot_tables:
common:
cooldown: 180 # seconds, per player
min-items: 3
max-items: 6 # each entry rolls its own 0-100 chance
relic_parts: {chance: 20, min: 1, max: 1, types: [pickaxe], elements: [miner]}
relics: {chance: 2, min: 1, max: 1, rarities: [legendary, mythic]}
drops:
blocks: {COAL_ORE: 1.5}
chests:
- {loot-table: chests/end_city_treasure, chance: 10}
Where a table's loot comes from
| Source | Key | How it works |
| Loot chests | /lt setBlock | Each player rolls the table separately, on their own cooldown (seconds) |
| Blocks | drops.blocks | DIAMOND_ORE: 4.0 is a 4% chance per block mined to drop a loot bag |
| Mobs | drops.mobs · drops.mythic_mobs | % chance per kill (a Warden at 100 always drops one). MythicMobs are listed by their internal name. |
| Activities | drops.activities | % chance for fishing, harvesting, breeding, taming, enchanting, brushing (archaeology), winning a raid (every winner rolls) or earning an advancement |
| Structure chests | drops.chests | A bag (or its items, with drop-items) placed into chests the game fills, for example chests/end_city_treasure |
| World loot | settings.world-loot.rules | Extra items added straight into dungeon, temple and village chests the first time each is opened |
One item entry
loot_definitions:
- {material: DIAMOND, min: 1, max: 3, chance: 25} # 25% to add 1–3 diamonds
Each entry rolls on its own. The chest then keeps between min-items and max-items stacks. In the editor (/lt edit) you can drop in real items with names, enchantments and custom data instead of plain materials.
The ready-made tables
There are tiers common (3 minute cooldown), uncommon, rare, epic and legendary, plus themed tables: miner, farmer, hunter, nether, end, ocean, trial, explorer and adventurer. None of them are placed in the world; assign them to chests or drops yourself.
Loot bags
A loot bag is an item that rolls its table when the player opens it. Bags drop from the sources above and can be handed out with /lt giveLootBag. NSU's weekly prizes and battle pass use bags as rewards (console:lootTables giveLootBag epic %player%).
Team-shared loot
With Estates installed, a table can be team-shared: one roll is shared by the whole team instead of each member getting their own. Turn it on in the loot editor by pressing Q (or F) on the cooldown button. Ctrl+Q there lets you type an exact cooldown.
Settings
| Key | Default | What it does |
settings.anti-exploit.prevent-placed-blocks | true | Player-placed blocks don't drop bags |
settings.anti-exploit.require-player-kill · prevent-spawner-mobs | true | Mob drops only from real player kills, never spawners |
settings.anti-exploit.allow-creative | false | No drops in creative |
settings.world-loot.enabled · rules | false | Add a table's loot to the world's own chests the first time each is opened |
Gotchas
loot.yml is only written when it doesn't exist. Your edits are safe across updates, but new defaults won't appear by themselves.
- Relic drops need NysxlRelics installed.
- Nested
loot_handlers roll extra tables at their own chance, which is useful for rare bonus rolls.
plugins/NysxlSpawnerWorks
Nysxl SpawnerWorks
Spawner cores that make mob drops without spawning mobs. You feed a core fuel and it produces items on a timer. Cores can be stacked, upgraded, sped up with a chamber, and sold through SmartShop. No lag from mob farms.
Getting started
- Get a core:
/spawnercore give, a lucky mob kill, or mining a vanilla spawner with Silk Touch.
- Place it and give it its fuel (for example coal for a skeleton core). A hopper pointing in feeds fuel; a chest touching it collects output.
- Right-click it for the core menu: output, fuel, upgrades and a Sell button.
- Right-click a placed core with another of the same type to stack them (up to 16).
- Build a chamber of copper, iron, gold, diamond or netherite blocks around it for speed.
Commands
| Command | What it does | Permission |
/spawnercore info | The core you're looking at (/core, /cores) | nysxlspawnerworks.use |
/spawnercore list | Your cores | nysxlspawnerworks.use |
/spawnercore give <type> [player] [amount] | Give a core | nysxlspawnerworks.admin |
/spawnercore reload | Reload the config | nysxlspawnerworks.admin |
Limits: 10 cores each by default. nysxlspawnerworks.limit.<n> allows more (the highest number wins), and .limit.unlimited removes the limit (ops have it).
Config keys that matter
| Key | Default | What it does |
settings.production-interval-seconds | 300 | Time per batch |
settings.offline-cap-hours | 8 | Most catch-up when a chunk loads again |
settings.max-stack · output-buffer-stacks | 16 · 6 | Stack size; storage |
idle.slow-after-hours · stop-after-hours | 24 · 72 | Cores slow down, then stop, while the owner is offline |
limits.default · count-stacks | 10 · true | Each core in a stack counts toward the limit |
hoppers.items-per-second | 8 | Hopper speed |
selling.shop · multiplier | "" · 1.0 | Which SmartShop shop buys the output |
upgrades.speed|storage|efficiency | 5 levels each | Upgrade prices and effects |
drops.mob-kills · silk-touch.chance | true · 100 | Other ways to get cores |
chamber.tiers | copper → netherite | Speed, buffer and fuel per tier |
cores.<mob> | | Fuel, outputs, rare outputs and drop chance per core type. Set enabled: false to remove a type. |
Core types and their fuel
| Core | Fuel | Core | Fuel |
| Skeleton | Coal | Zombie | Charcoal |
| Spider · Cave spider | Fermented spider eye | Creeper | Glowstone dust |
| Blaze | Magma cream | Magma cube | Blaze powder |
| Slime · Drowned | Kelp | Witch | Sugar |
| Enderman | Chorus fruit | Guardian | Cod |
| Wither skeleton | Blaze rod | Cow · Sheep | Wheat |
| Chicken | Wheat seeds | Pig | Carrot |
Each core makes its mob's normal drops every batch (for example a skeleton core makes 3 bones and 2 arrows). Rare outputs have a % chance per batch, such as a skeleton skull at 0.5%. Mobs drop their own core rarely, from 0.05% for common mobs down to 0.01% for wither skeletons. A core type looks like this:
cores:
skeleton:
fuel: COAL
fuel-per-interval: 2
drop-chance: 0.05 # % per kill
outputs: { BONE: 3, ARROW: 2 }
rare: { SKELETON_SKULL: 0.5, BOW: 1.0 } # % per batch
Upgrades and chambers
- Speed (5 levels, +10% each, first level 2,500): batches come faster.
- Storage (5 levels, +25% each, first level 2,000): holds more output.
- Efficiency (5 levels, +8% each, first level 3,000): uses less fuel.
- Each upgrade level costs
cost-growth times the last (×1.5–1.6).
- Chambers: surround the core with one block type. Copper ×1.15 speed, iron ×1.3, gold ×1.5 (10% less fuel), diamond ×1.75 (20% less), netherite ×2 (30% less), and each tier also stores more.
Gotchas
- A chamber is only as good as its worst block. One copper block in a netherite chamber makes it a copper chamber.
- The chamber's shape is an NSU multiblock. Change it with
/multiblock edit nysxlspawnerworks:chamber.
- A deleted core type comes back on the next update. Use
enabled: false instead.
plugins/NysxlInteractableBlocks
Nysxl Interactable Blocks
Custom placeable blocks with their own textures, recipes, tools, break rules and click actions. Blocks can also be furniture: a Blockbench model of any shape on a display entity.
Getting started
- On first start the plugin makes an example "Relic Forge" block. Open
/iblocks to see how it's set up.
- Put
.png textures in the plugin's textures/ folder (16×16 matches the game).
- In
/iblocks, choose a block, then Texture. Pick a picture for every side, or for the top, bottom, sides and front.
- Press Build the resource pack. The textures go into NSU's pack, so players still get one pack.
- Set its name, description, recipe, tool, who can break it, and what each kind of click does (open a menu, run a command, run a script).
Commands
| Command | What it does | Permission |
/iblocks | The block editor (/customblocks) | nysxlinteractableblocks.admin |
/iblocks give <block> [player] [amount] | Give a custom block | nysxlinteractableblocks.admin |
/iblocks pack | Rebuild the textures into the resource pack | nysxlinteractableblocks.admin |
/iblocks reload | Reload blocks | nysxlinteractableblocks.admin |
Block settings
| Setting | What it does |
name, lore | How the item looks |
textures.*, look.faces, look.directional, look.turn | Textures per side, and whether it faces the player |
look.furniture, look.model, look.solid | Show a Blockbench model instead of a block. Solid furniture can be stood on. |
recipe, recipe.amount | Crafting recipe |
break.tool, break.tier, break.who, break.drops-itself | Rules for breaking |
| Click actions | What left, right and sneak clicks do |
Options in detail
| Setting | Choices |
| Tool needed | Anything, a pickaxe, an axe, a shovel, a hoe, shears or a sword |
| Tool tier | Any, wood or better, stone or better, iron or better, diamond or better, netherite (gold counts as wood, copper as stone) |
| Who can remove it | Anyone (with the right tool), only while sneaking, only whoever placed it, or only admins |
| Clicks | Right-click, sneak + right-click, left-click, sneak + left-click. Each runs its own list of menu actions, such as opening any plugin's menu, running a command or running an event script. %owner% is whoever placed it. |
| Textures | One picture for all sides, or separate top, bottom, sides and front. "Faces the player" turns the front toward whoever places it. |
| Recipe | A 3×3 grid of materials and how many blocks it makes. An empty grid means no recipe. |
How to make furniture
- Make the model in Blockbench and export it as a Java block/item model
.json into the plugin's models/ folder, with its textures in textures/.
- In
/iblocks, open the block, pick the model and switch on Furniture.
- Choose Solid (a hidden barrier, so players can stand on it and bump into it) or not solid (walk-through). If the model faces the wrong way when placed, add quarter turns.
- Build the resource pack. Breaking and clicking follow the block's own rules and actions.
Gotchas
- Custom blocks use mushroom block looks. Natural mushroom blocks all show the plain look so nobody can fake a custom block.
- Blocks are also available to event scripts as
nysxlinteractableblocks:<key>.
- Players without the resource pack see plain mushroom blocks.
Reference
Config files
Every settings file each plugin writes: what's in it, its defaults, where you can change it, and what to do after editing it by hand. The tables come straight from the plugins' own commented defaults.
in game means there's a menu or command for it. website means the Nysxl website edits it. file only means there's no in-game page yet: open the file, edit it, then reload or restart.
Before you edit a fileA plugin that saves a file while it runs can overwrite your hand edits. Edit, save, then run the reload command (or restart) straight away. Keep two spaces per indent level, and quote text that starts with &, { or %.
Still file only
These have no in-game page yet:
- NysxlServerUtils: achievements, auction-house, bounties, community (apart from homes and warps), crates, daily-rewards, events, kits (the examples), leaderboards, mail, quests, rewards, staff, trades, web-stats, treasury, prefixes, dialogs, mysql, vault-economy, gui-editor, config.yml, ProfileViewerConfig.
- Staff Utilities: config.yml and bannedBlocks.yml (and they need a restart).
- Relics: config.yml, categories, parts and textures.
- Estates: GUIs, Language, effects, teamTierCost, and
always_protected and blocksPerClaim in pluginData.yml.
- Jobs: chat-police, bounty, courier, debt-collecting and messages.
- SmartShop: language.yml and AuctionCategories.yml.
Every file at a glance
NysxlServerUtils plugins/NysxlServerUtils/
Feature files are written with working examples the first time the server starts. If you delete one, it's written again with the defaults.
achievements.yml
Achievements (/achievements). counter + needed: unlocked when that count reaches it (counters: streak, quests, playtime-hours, votes, bounties, trades, kits). Without a counter, a feature unlocks it by its id (first_kit, first_trade, first_vote).
file only Change it: Only in the file. After a hand edit: Restart.
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
broadcast | true | Announce it to everyone in chat. |
achievements.<id> | { name: "&aGeared up", description: "Take your first kit", icon: WOODEN_SWORD, … | Entries keyed by name/number, e.g. first_kit, first_trade, first_vote, streak_7 …. |
auction-house.yml
The auction house (/ah). Sell: /ah sell <starting price> [time like 1h, 30m] [buy-now price] While SmartShop is installed this one always stays off and /ah opens SmartShop's auction house; SmartShop moves anything left here (listings, bids, items waiting) into players' collection boxes.
file only Change it: Only in the file. Not used while SmartShop is installed. After a hand edit: Restart.
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
tax-percent | 5 | Percent of each sale that goes to the server treasury. |
min-raise-percent | 5 | Each new bid is at least this many percent above the last (and at least 1). |
default-time | 1h | |
max-time | 2d | |
max-listings-per-player | 5 | |
snipe-guard-seconds | 30 | Bidding in the last this-many seconds adds time, so nobody wins by bidding at the last moment. |
battlepass.yml
The battle pass (/pass). Pass XP comes from everything that gives server level XP (see levels.yml). Each tier has a free reward, and a premium one for players with the premium permission or who buy it. Rewards are menu actions: givemoney:<n>, giveitem:<ITEM>:<n>, console:<command> (%player% is the player).
in game Change it: /serversettings battlepass After a hand edit: Applies at once from the menu; after a hand edit press Reload from the file there.
The file also has free: and premium:: one list of reward actions per tier (1–30 by default).
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
season.id | season-1 | Change the id to start a new season (everyone starts again at tier 0). |
season.name | "&6&lSeason 1" | |
season.ends | "2027-01-31 23:59" | When it ends (yyyy-MM-dd HH:mm, server time). After that rewards can still be claimed but no XP counts. |
tiers | 30 | |
xp-per-tier | 1000 | |
premium.permission | nysxl.battlepass.premium | |
premium.price | 50000 | Price to buy premium in game; 0 = only with the permission. |
bounties.yml
Bounties (/bounty <player> <amount>): money on a player's head, paid to whoever kills them.
file only Change it: Only in the file. After a hand edit: Restart.
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
minimum | 100 | |
tax-percent | 5 | Percent of each bounty that goes to the server treasury when it's placed. |
broadcast | true | Announce new bounties and claims to everyone (players can turn it off in /preferences). |
confirm-from | 1000 | Ask "are you sure?" for bounties of at least this much. |
The lottery, polls, and homes / teleport requests.
in game file only Change it: homes.max, homes.warmup and warps.per-warp-permission are on /essentialslink. Everything else only in the file. After a hand edit: Restart (the /essentialslink ones apply at once).
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
lottery.enabled | true | |
lottery.ticket-price | 100 | |
lottery.max-tickets | 20 | |
lottery.every-minutes | 60 | How often it's drawn, in minutes. |
lottery.tax-percent | 10 | Percent of the pot that goes to the treasury. |
polls.enabled | true | |
polls.results-shown-for | 1d | How long a finished poll's results are announced: in chat for whoever joins, on /poll and on the website (30m, 12h, 2d; 0 = not at all). /poll resultsfor <time> changes it in game. |
polls.history-size | 50 | How many finished polls /poll history and the website keep. |
homes.enabled | true | |
homes.max | 3 | Homes each player can set (nysxl.homes.<n> gives more). |
homes.warmup | 3 | Seconds standing still before a teleport (0 = straight away). |
warps.enabled | true | |
warps.per-warp-permission | false | Players need nysxl.warp.<name> for each warp. |
tpa.enabled | true | |
tpa.request-seconds | 60 | |
crates.yml
Crates (/crates). Players open them with keys: /crates give <player> <crate> <amount>, or the "crate_key" menu action (so daily rewards and quests can give keys). Each loot entry: name, icon, amount (the icon item is given), money, actions (menu actions), weight (chance).
file only Change it: Only in the file. Keys are given with /crates give. After a hand edit: Restart.
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
crates.<id> | { name, icon, loot } | Entries keyed by name/number, e.g. common, rare. |
daily-rewards.yml
Daily rewards (/daily). One reward a day; the streak goes up each day in a row and starts again if a day is missed. After the last day the rewards go round again from day 1 (the streak keeps counting).
file only Change it: Only in the file. After a hand edit: Restart.
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
time-zone | "" | The time zone days are counted in, e.g. Europe/London or America/New_York (blank = the server's). |
remind-on-join | true | Tell players on join when today's reward is waiting. |
rewards.<id> | { name: "&aDay 1", icon: BREAD, money: 50, actions: ["giveitem:BREAD:8"] } | One entry per day. money is paid through the economy; actions are menu actions (giveitem:DIAMOND:2, message:..., sound:..., console:... when console commands are allowed). Entries keyed by name/number, e.g. 1, 2, 3, 4 …. |
milestones | (section) | Extra once a streak reaches these days. |
milestones.30 | { name: "&d30 day streak", icon: NETHER_STAR, money: 2500, actions: [… | |
essentials-link.yml
What NSU uses from EssentialsX. Change these in game: /essentialslink (or the tile in /serversettings). Essentials doesn't have to be installed: its files in plugins/<folder> are read when it isn't.
in game Change it: /essentialslink (every setting) After a hand edit: Applies at once from the page.
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
folder | Essentials | The Essentials folder inside plugins/. |
homes.use | true | Players' Essentials homes show in /home and work there. |
homes.max | 0 | Most Essentials homes NSU uses per player (0 = all of them). |
homes.import | true | Admins may copy Essentials homes into NSU's own. |
homes.import-obeys-limit | true | Importing stops at each player's NSU home limit. |
warps.use | true | Essentials warps show in /warp and work there. |
warps.import | true | Admins may copy Essentials warps into NSU's own. |
spawn.use | true | Essentials' spawn shows as the warp "spawn". |
kits.use | true | Essentials' kits (kits.yml) show in /kits, and its last-claim times still count. |
kits.import | true | Admins may copy Essentials kits (with players' cooldowns) into NSU's own. |
mail.import | true | Admins may copy unread Essentials mail into /mail (each letter only ever once). |
blocked-worlds | [] | Essentials homes, warps and spawn in these worlds are never used or imported. |
blocked-warps | [] | Essentials warps with these names are never used or imported ("spawn" blocks the spawn). |
blocked-kits | [] | Essentials kits with these names are never used or imported. |
events.yml
Announcements and server events (/events).
file only Change it: Only in the file. After a hand edit: Restart.
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
time-zone | "" | The time zone days are counted in, e.g. Europe/London (blank = the server's). |
tips-every-minutes | 10 | Tips said in chat, one at a time, every this-many minutes (0 = off). |
tips | list of 4 | |
events.<id> | { name, days, start, minutes, quest-money, on-start, on-end } | Timed events. days: MON..SUN (or ALL), start: "HH:MM", minutes: how long. While one is on, quest and daily reward money is multiplied (the biggest event wins). on-start / on-end: menu actions (broadcast:..., console:... when console commands are allowed). Entries keyed by name/number, e.g. double_quests, friday_night. |
kits.yml
Kits (/kits). items: "MATERIAL amount" lines. cooldown: 30m, 24h, 7d ("" = none). once: only ever once. permission: who can take it ("" = everyone). Kits made with /kits create keep the exact items (enchants and all) in data/kits.yml instead.
in game file only Change it: /kits create and /kits delete make and remove kits from what you hold (saved in data/kits.yml). The example kits are only in the file. After a hand edit: Restart.
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
kits.<id> | { name, icon, items, once } | Entries keyed by name/number, e.g. starter, daily, vip. |
leaderboards.yml
Leaderboards (/top). As a wall screen: /screen place leaderboard 4 3
file only Change it: Only in the file. After a hand edit: Restart.
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
refresh-minutes | 5 | How often the money board is worked out, in minutes. |
size | 10 | How many places each board shows. |
levels.yml
Player levels (/level) and titles (/title). Everything players do earns level XP; levels unlock titles.
in game Change it: /serversettings levels After a hand edit: Applies at once from the menu.
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
mode | own | Where a player's level comes from: own - level XP from everything below (and from NysxlJobs, which sends a share of job XP) jobs - the player's level IS their job level (with NysxlJobs): see jobs-level |
jobs-level | total | With mode: jobs, how job levels make one level: total (all added up), highest, or average. |
actions | list of 7 | Your own XP sources (on: break, harvest, kill or fish). Blocks can be names or tags (#logs). Blocks players placed, spawner mobs and creative mode don't count. |
max-level | 100 | |
base | 100 | XP for the next level = base * level ^ exponent (level 1 -> 2 needs 100, level 50 -> 51 about 24,000). |
exponent | 1.4 | |
title-in-name | true | Put the chosen title in front of the player's name (their display name, which chat plugins show). |
xp | (section) | Level XP for things NysxlServerUtils counts itself. Other plugins add their own (job XP, lootbags, cores). |
xp.quest-daily | 40 | |
xp.quest-weekly | 150 | |
xp.daily-reward | 20 | |
xp.playtime-hour | 30 | |
xp.vote | 25 | |
xp.achievement | 75 | |
xp.bounty | 50 | |
xp.auction | 10 | |
xp.trade | 10 | |
titles.<id> | "&7Newcomer" | Titles unlocked at a level. Players pick one with /title. Entries keyed by name/number, e.g. 1, 5, 10, 20 …. |
machine-challenges.yml
Weekly machine challenges: goals for everything a player's machines make, started again every Monday. Finishing one gives its rewards (the owner gets them straight away, or when they next join). item: an item name, "any" (everything), or machine:<id> (everything that machine makes). Rewards: money:<amount>, level-xp:<amount>, message:<text>, console:<command> (%player% is them).
in game website Change it: /serversettings machine-challenges, or the website's Machines section (/mb web) After a hand edit: Applies at once.
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
challenges.<id> | { name, item, amount, rewards } | Entries keyed by name/number, e.g. glass, gravel, ingots, busy. |
machine-upgrades.yml
in game Change it: /serversettings machine-upgrades After a hand edit: Applies at once.
| Key | Default | What it does |
upgrades.<id> | { material, name, lore, speed, yield, fuel, machines } | Upgrade items: put into a machine's upgrade slots (the machine's Processing page sets how many it has). speed / yield: +fractions (0.2 = +20%). fuel: a fraction of fuel use (-0.1 = 10% less). machines: the machine ids it fits (empty = every machine). Entries keyed by name/number, e.g. speed, output, efficiency. |
mail.yml
Mail (/mail send <player> [money] [note...]): sends the item in your hand and/or money.
file only Change it: Only in the file. After a hand edit: Restart.
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
postage | 5 | What each letter costs to send (goes to the treasury). |
max-letters | 54 | The most letters one mailbox holds. |
quests.yml
Quests (/quests). Every player gets a few daily quests (new ones each day) and weekly quests (new ones each Monday), picked from the lists below. Finishing one pays its reward straight away.
file only Change it: Only in the file. After a hand edit: Restart.
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
time-zone | "" | The time zone days are counted in, e.g. Europe/London (blank = the server's). |
daily-quests | 3 | |
weekly-quests | 2 | |
daily.<id> | { name: "&7Quarry worker", type: break, target: STONE, amount: 128, money: 100,… | type: break, place, kill, fish, craft, daily (claim the daily reward), auction (win an auction), bounty (claim a bounty), trade (finish a trade), sell / buy (with SmartShop: sell to or buy from shops) target: a block / item / mob name, or "any". money is paid through the economy; actions are menu actions. Entries keyed by name/number, e.g. stone, logs, zombies, fish …. |
weekly.<id> | { name: "&bDeep miner", type: break, target: DIAMOND_ORE, amount: 20, money: 15… | Entries keyed by name/number, e.g. miner, slayer, trader. |
rewards.yml
Playtime and vote rewards.
in game file only Change it: Vote sites can be set in the web admin panel (upload mode). Everything else only in the file. After a hand edit: Restart.
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
playtime.money-per-hour | 50 | Paid for every full hour played. |
playtime.milestones | (section) | Extra at these hours played (menu actions, e.g. giveitem:DIAMOND:3 or crate_key). |
playtime.milestones.10 | ["message:&a10 hours played! Here's something.", "giveitem:DIAMOND:2"] | |
playtime.milestones.50 | ["broadcast:&6%player% has played for 50 hours!"] | |
votes.sites | list of 2 | Shown by /vote. |
votes.money | 100 | |
votes.actions | ["message:&aThanks for voting!"] | |
votes.streak-bonus | 10 | Extra money per day of the voting streak (capped). |
votes.streak-bonus-max | 200 | |
staff.yml
The staff panel (/staff) and economy admin (/ecoadmin).
file only Change it: Only in the file. After a hand edit: Restart.
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
staff-permission | nysxl.staff | |
economy-permission | nysxl.ecoadmin | |
amounts | [10, 100, 1000, 10000] | Amounts the economy admin's buttons give or take. |
log-size | 500 | Moderation log entries kept. |
trades.yml
Trades (/trade <player>): a window both players fill, swapped when both press Ready.
file only Change it: Only in the file. After a hand edit: Restart.
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
max-distance | 20 | How far apart they can be, in blocks (0 = anywhere, -1 = same world only, any distance). |
money-tax-percent | 0 | Percent of the money in a trade that goes to the server treasury. |
request-seconds | 60 | Seconds a request waits for an answer. |
web-stats.yml
The server's public page: online players, leaderboards, shops, auctions, bounties, jobs, teams, loot, the treasury and player profiles. /web gives the link. Off: no page at all.
file only Change it: Only in the file (news, rules, calendar and vote sites can't be edited in game yet). See the web page guide. After a hand edit: Restart. /web update only sends the page again.
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
host | (section) | Host the page from this server, on its own port (nothing is sent anywhere). On a panel like Pterodactyl, add the port to the server first (Network / allocations), then put it here. |
host.enabled | true | |
host.port | 0 | |
host.bind | "0.0.0.0" | |
host.public-url | "" | The address players open, e.g. "http://play.example.com:8123". Empty: /web shows the port only. |
upload | false | Also send the page to a website of your own that runs the page's /api/stats functions (upload-url, https only). Off by default and no website is built in: the page is hosted here. |
upload-url | "" | |
owners | [] | Staff logins on the website: /web login gives staff with nysxl.web.admin their own login. Owners (these names, or anyone with nysxl.web.owner, which ops have) also see every login and what each one did. |
server-name | "My Minecraft server" | The name shown at the top of the page. |
tagline | "" | A line under the name. |
every-minutes | 1 | How often to check for changes, in minutes (at least 1). The page is sent only when something changed, straight away when someone joins or leaves, and at least every quiet-minutes. |
quiet-minutes | 15 | |
join | (section) | The "Join us" box: how to connect. Leave a value empty to hide it. |
join.address | "" | |
join.bedrock-address | "" | |
join.bedrock-port | 19132 | |
join.discord | "" | |
rules | [] | Rules shown on the page. |
guide | list of 5 | Getting started: commands to try, with what they do. |
staff | [] | Staff listed on the page (online staff are shown either way). |
show-moderation-log | false | Show the staff panel's moderation log (who was kicked, muted...) on the public page. It is always in the admin view (/web admin). |
show-balances | true | Show each player's money on the page and on their profile. |
show-shop-locations | true | Show where player chest shops are (world and coordinates). |
show-estates | true | Show Estates teams and their claims on the page's map. |
show-economy | true | Show the economy: the treasury, all the money players hold, and the average. |
warn-money-jump | 10000 | Admin view: warn when a player's money grows by more than this in an hour. |
news | [] | News at the top of the page, newest first. |
calendar | [] | Coming up: shown as a calendar with a countdown (date as yyyy-MM-dd HH:mm, server time). |
show-vote-links | true | Voting links shown on the page (the same as /vote by default). |
discord-webhook | "" | The activity feed can also go to a Discord channel: paste the channel's webhook URL (Channel settings > Integrations > Webhooks). Empty = off. kinds picks which lines go (empty = all of them). |
discord-kinds | [level, achievement, jackpot, rare, prize, pass, contract, core] | |
discord-log-webhook | "" | Not in the default file: add it. A second Discord webhook for a staff log (🟢 joins, 🔴 leaves, with the online count). |
discord-log-kinds | [join, leave] | Not in the default file: add it. Which activity kinds go to the staff log. |
show-terrain-maps | true | Not in the default file: add it. Map pictures of your worlds behind the teams map. |
weekly-prizes.yml
Weekly prizes (/prizes). Boards count up over the week; every Monday the top players on each board get its prizes (menu actions, %player% is the winner) and the boards start again.
in game Change it: /serversettings weekly-prizes After a hand edit: Applies at once.
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
time-zone | "" | The time zone days are counted in, e.g. Europe/London (blank = the server's). |
boards.<id> | { name, icon, unit, prizes } | Entries keyed by name/number, e.g. earned, xp, quests, contracts …. |
treasury.yml
The server treasury. Every currency's collected tax (tax_collected in economy.yml) is its treasury money. Taxes come from things like taxed shop sales; set each currency's tax_percentage in economy.yml.
file only Change it: Only in the file. Admins pay and add money with /treasury. After a hand edit: /treasury reload.
| Key | Default | What it does |
sink-percent | 30 | How much of each tax is destroyed instead of going into the treasury (0-100). Destroying some keeps money from piling up on the server. |
goal-check-seconds | 60 | How often goals are checked (they're also checked whenever tax comes in). |
announce-at-percent | [25, 50, 75] | Tell everyone when a goal gets this far. |
goals.<id> | { name, description, currency, amount, repeat, cooldown-hours, actions } | Community goals: when the treasury holds the amount, it pays for the goal and runs its actions. Actions: console:<command>, broadcast:<message>, title:<title>|<subtitle>, sound:<SOUND> In actions: %goal% (its name), %amount% (what it cost). Entries keyed by name/number, e.g. job_boost, drop_party. |
prefixes.yml
Player prefixes and suffixes (NysxlServerUtils). /prefix reload after changing this file.
file only Change it: Only in the file. Players pick from the list with /prefix. After a hand edit: /prefix reload.
| Key | Default | What it does |
use-luckperms | true | What a player shows: their own text (/prefix set), else a ready-made one they picked (/prefix <id>), else their LuckPerms group's prefix (use-luckperms), else default-prefix. |
default-prefix | "" | |
default-suffix | "" | |
max-length | 16 | Players' own text: at most this many letters (colour codes don't count), and none of these words. |
blocked-words | [] | |
add-space | true | Put a space between the prefix and the name (and the name and the suffix) automatically. |
tab | (section) | The tab list. format: {prefix} {name} {suffix} {world} {ping}, colours (&a, &#ff8800, <gradient:...>) and PlaceholderAPI placeholders. header / footer: lines shown above and below the list (leave empty to leave them alone), with {online} and {max} too. If CMI also changes tab list names, switch one off (CMI: Settings/TabList.yml UpdateTabListNames: false). |
tab.enabled | true | |
tab.format | "{prefix}{name}{suffix}" | |
tab.refresh-seconds | 5 | |
tab.header | [] | |
tab.footer | [] | |
chat | (section) | Chat: when no chat format from the website applies, messages look like this. {prefix} {player} {suffix} {message} {world}. Set enabled to false to leave chat to another plugin (or switch CMI's off: Settings/Chat.yml ModifyChatFormat.Enabled: false). |
chat.enabled | true | |
chat.format | "{prefix}dd3fc{player}{suffix} &8» &f{message}" | |
prefixes.<id> | { text, permission, description } | Ready-made prefixes players can pick with /prefix <id> (or from a menu: prefix:use:<id>). permission: who can pick it (default nysxl.prefix.preset.<id>; "" for everyone). Entries keyed by name/number, e.g. member, vip, legend. |
suffixes.<id> | { text, description } | Entries keyed by name/number, e.g. star. |
dialogs.yml
Dialog resource pack. Dialogs themselves live in plugins/NysxlServerUtils/dialogs/*.yml (or in another plugin's own dialogs folder, loaded with Dialogs.load).
file only Change it: Only in the file. The dialogs themselves are made on the website (/nsudialog web). After a hand edit: Restart (dialogs themselves: /nsudialog reload).
| Key | Default | What it does |
resource-pack.enabled | true | |
resource-pack.serve | true | Serve the zip from this server. Turn off when public-url points at a file you host somewhere else. |
resource-pack.mode | additional | additional keeps the server's main resource pack. replace sends this pack instead of it. |
resource-pack.send-on-join | true | |
resource-pack.send-with-dialog | true | Also offer the pack when a dialog that uses {glyph:name} is opened. |
resource-pack.required | false | |
resource-pack.prompt | "&6This server uses custom dialog icons." | |
resource-pack.public-url | "" | Full URL of the zip, if a reverse proxy or another host serves it. Leave blank to build http://<advertised-host>:<port>/<token>/nysxl-dialogs.zip |
resource-pack.bind-host | "0.0.0.0" | |
resource-pack.port | 8163 | |
resource-pack.advertised-host | "" | Hostname players can reach. Not the bind address. Required when public-url is blank. |
resource-pack.min-format-major | 84 | 26.1 is format 84. 26.3 is 97.1, and max 97 means any 97.x pack. |
resource-pack.min-format-minor | 0 | |
resource-pack.max-format-major | 97 | |
mysql.yml
MySQL Connection Configuration
file only Change it: Only in the file. Puts everyone's money in a shared database for networks. After a hand edit: Restart.
Keep the real password out of anything you share.
| Key | Default | What it does |
db.enabled | false | Set to true to enable MySQL connection |
db.host | localhost | The hostname or IP address where the MySQL server is running |
db.port | 3306 | The port number to connect with MySQL |
db.name | your_database_name | Your database name |
db.user | your_user_name | Username to connect to the database |
db.password | your_password | Password for the specified username |
db.table | player_currency | Table that stores player balances |
gui-editor.yml
file only Change it: Only in the file. Menus themselves are edited on the website. After a hand edit: /guieditor reload for the editor settings; restart for resource-pack.*, screens.*, menus.* and transitions.
vault-economy.yml
file only Change it: Only in the file. After a hand edit: Restart.
economy.yml
in game file only Change it: /currency create adds a currency and /tax set rate sets its tax. Conversion rates and database use only in the file. After a hand edit: Restart.
config.yml
file only Change it: Not written for you: make plugins/NysxlServerUtils/config.yml yourself and add only the keys you want to change. After a hand edit: Restart.
language.yml
in game Change it: /ServerAnnouncement After a hand edit: Applies at once.
Edited on the website or in game
| File or folder | Change it | What it holds | How |
menus/*.yml | website | Every menu (website menus are custom-<name>.yml; custom-_editor.yml holds scripts, the guide book and seasonal events) | /guieditor, then /guieditor apply |
dialogs/*.yml | website | Dialogs | /nsudialog web, then /nsudialog web apply |
assets/ · assets/glyphs.yml · assets/slices.yml | website | Uploaded pictures, their sizes as text characters, and their stretchable borders | The Resource pack builder and the screen designer |
packs/*.zip | website | Extra resource packs merged into NSU's pack | The Resource pack builder, or drop zips in yourself |
multiblocks/*.yml | in game website | Each machine (the plugin starts with example_forge and example_smeltery) | /mb edit, or /mb web; /mb reload after a hand edit |
ProfileViewerConfig.yml | file only | The buttons on the player profile viewer: material, title, lore, slot, and a command per click type (%player%, %target%) | Only in the file; restart |
Saved data, don't edit: data/, money.yml, treasury-state.yml, prefixes-data.yml, chat-formats.yml (players' format choices), menu-data/ (incl. everyone.yml), menu-links.yml, menu-items.yml (/guieditor item), screens.yml (/screen place), script-powers.yml, script-states.yml, seasonal-events.yml, insights.yml, instances.yml, menu-usage.yml, cache/skins.yml, menu-changes.log.
Staff Utilities plugins/NysxlStaffUtils/
config.yml
NysxlStaffUtils
file only Change it: Only in the file. After a hand edit: Restart (there's no reload command).
Vanish weights are permissions (staffutilities.vanish.<n>), not config.
| Key | Default | What it does |
tickets.max-open-per-player | 3 | Open tickets a player can have at once (0 = no limit). Staff have no limit. |
tickets.keep-closed-days | 30 | Closed tickets are kept this many days, then dropped (0 = kept for good). |
tickets.report-cooldown-seconds | 120 | Seconds between a player's reports (staff aren't limited). |
tickets.untrusted-after | 3 | A reporter whose reports were "nothing wrong" at least this many times, and twice as often as useful, is marked "often reports nothing" for staff (0 = never). block-untrusted-reports: such players can't /report at all. |
tickets.block-untrusted-reports | false | |
tickets.remind-minutes | 30 | Remind online staff about tickets nobody has answered for this many minutes (0 = never). |
tickets.auto-close-days | 3 | Tickets waiting on the player (staff answered last) close by themselves after this many days (0 = never). |
tickets.categories.<id> | { name: "&cBug", icon: REDSTONE } | What a new ticket can be about (players pick one). "player" is used for /report. Entries keyed by name/number, e.g. bug, grief, player, appeal …. |
tickets.quick-replies.<id> | { text } | Ready-made replies for staff ("Quick reply" on a ticket). {player} is their name; close: true also closes it. Entries keyed by name/number, e.g. looking_into_it, need_more_info, fixed, not_a_bug. |
staff-mode.vanish | true | Hide staff in staff mode from players who aren't staff (staffutilities.admin). Vanish weight: give staff the permission staffutilities.vanish.<n> (e.g. .1, .2, .5). A vanished staffer is seen only by staff whose own weight is at least as high, so a bigger number means fewer people can see you. Staff with no such permission are weight 0 (they see weight-0 vanished staff, but not anyone with a higher number). |
frozen.allowed-commands | [ticket, tickets, helpop, msg, tell, r, w] | Commands a frozen player can still use (everything else is blocked). |
mute.blocked-commands | [msg, tell, w, r, me, mail, whisper, reply, say] | Commands a muted player can't use (chat is always blocked). |
warnings.expire-days | 30 | Warnings older than this many days stop counting (0 = they always count). |
warnings.steps.<id> | "mute 60" | What happens when a player reaches this many warnings: "mute <minutes>", "tempban <time>", "ban", "kick", or "command:<a console command, {player} for their name>". Entries keyed by name/number, e.g. 3, 5, 7, 10. |
bans.appeal | "Think this is wrong? Appeal on our website (Rules & Guide) with code… | Shown to banned players when they try to join (leave empty for nothing). {code} is their appeal code: they enter their name and it on the website's Rules page to appeal. |
alts.alert-banned | true | Tell online staff when someone shares an address with a banned player. |
chat-log.lines | 20 | Chat lines and commands kept per player (kept with a report as evidence; not saved over restarts). |
command-spy.ignore | [login, register, l, reg, changepassword] | Commands /commandspy doesn't show. |
mining-alerts.enabled | true | |
mining-alerts.minutes | 5 | Tell staff when a player breaks this many of an ore within the minutes below. |
mining-alerts.ores.DIAMOND_ORE | 8 | |
mining-alerts.ores.DEEPSLATE_DIAMOND_ORE | 8 | |
mining-alerts.ores.ANCIENT_DEBRIS | 4 | |
mining-alerts.ores.EMERALD_ORE | 6 | |
mining-alerts.ores.DEEPSLATE_EMERALD_ORE | 6 | |
staff-chat.prefix | "#" | Start a chat line with this to send it to staff only ("" = off; /sc always works). |
staff-chat.format | "&d[Staff] &f{name}&7: &f{message}" | |
discord.webhook | "" | A Discord channel webhook (Channel settings > Integrations > Webhooks) for staff alerts. Empty = off. |
discord.name | "Staff" | |
discord.kinds | [report, appeal, escalated, ban, mining] | Which alerts go there: report, ticket, appeal, escalated, warn, ban, mining, staffchat. |
lookup.max-players | 500 | Players with a record, notes, ban or tickets sent to the website's staff player lookup (newest first). |
bannedBlocks.yml
file only Change it: Only in the file. A list of item names under BannedBlocks: that staff mode won't let you place, drop or take. After a hand edit: Restart.
Saved data, don't edit: Ticket, punishment, note and chat log data.
Relics plugins/NysxlRelics/
config.yml
NysxlRelics mode: rpg shows a stat sheet. vanilla-plus keeps the lore short. A category file can override mode.
file only Change it: Only in the file. After a hand edit: /relics admin reload.
| Key | Default | What it does |
mode | rpg | |
creativity | 45 | |
block-modifies-world | false | |
max-chain-length | 4 | |
max-curses | 2 | |
max-hidden-curses | 1 | |
perk-drawback-ratio | 0.7 | |
model-data-base | 2600 | |
tooltip | compact | Relic tooltips: compact (rarity, stats, one line per ability, gems) or full (everything). /relics inspect always shows everything. |
balance | (section) | How strong relics can be in a fight. Applied on every hit, so old relics follow them too. |
balance.attack-damage-max | 6 | most extra attack damage a relic adds (a netherite sword does 8) |
balance.elemental-damage-max | 6 | most fire/frost/lightning/void/magic damage added to one hit, together |
balance.crit-chance-max | 25 | % |
balance.crit-power-max | 50 | % extra on a crit |
balance.life-steal-max | 10 | % of damage healed |
balance.damage-multiplier-max | 1.5 | crits, armour penetration and PvE bonus together |
balance.max-hit | 30 | most damage one relic hit can do (0 = no limit); the dragon has 200 health |
balance.boss-multiplier | 0.5 | share of the relic's extra damage that counts on the wither, dragon, warden, elder guardian |
balance.pvp-multiplier | 0.6 | share of the relic's extra damage that counts on players |
balance.part-stat-scale | 1.0 | new parts' numbers times this |
ledger | (section) | The register of relics players have (/relics admin ledger): how often online players are checked. |
ledger.scan-minutes | 5 | |
features | (section) | Optional systems that act on their own. Turn off any your players find confusing. |
features.memory | true | relics remember kills, blocks mined and their owner |
features.trophies | true | notable kills are listed on the relic |
features.skills | true | active abilities on right-click |
features.staff-spells | true | relic staffs cast a spell on right-click |
features.engraving | true | the engraving station |
features.mutation | false | a relic's colour slowly shifts towards how it's used |
features.battle-scars | false | killing rival team leaders or surviving near death marks the relic |
features.sensory | false | sounds and effects when you switch to a relic |
soulbound-mythic | false | Soulbound Mythic Relics on death |
effects | (section) | Visual and Audio effects |
effects.enabled | true | |
effects.passive-particles | true | |
effects.passive-interval-ticks | 10 | |
effects.combat-particles | true | |
effects.sound-feedback | true | |
allowed-triggers | [] | |
blocked-triggers | [] | |
allowed-conditions | [] | |
blocked-conditions | [] | |
allowed-actions | [] | |
blocked-actions | [] | |
theme-tags | [] | |
power-budget.common | 6 | |
power-budget.uncommon | 10 | |
power-budget.rare | 14 | |
power-budget.epic | 20 | |
power-budget.legendary | 28 | |
power-budget.mythic | 36 | |
rarity-weights.common | 45 | |
rarity-weights.uncommon | 25 | |
rarity-weights.rare | 15 | |
rarity-weights.epic | 8 | |
rarity-weights.legendary | 5 | |
rarity-weights.mythic | 2 | |
stats.<id> | { min, max } | Entries keyed by name/number, e.g. might, haste, fortune, guard …. |
pricing.base | 100 | |
pricing.currency | coins | The NSU currency used (DEFAULT is the main money). |
pricing.rarity-multiplier.common | 1 | |
pricing.rarity-multiplier.uncommon | 2.5 | |
pricing.rarity-multiplier.rare | 6 | |
pricing.rarity-multiplier.epic | 14 | |
pricing.rarity-multiplier.legendary | 30 | |
pricing.rarity-multiplier.mythic | 75 | |
name-parts.prefixes | [Ancient, Lost, Bright] | |
name-parts.suffixes | [of the Deep, Relic] | |
awakening | (section) | Pedestal awakening rituals. Put listed items on nearby lodestone, chiseled blackstone/quartz, or respawn-anchor offering pedestals. The relic must also have recorded the category's kill milestone before the ritual can consume the offerings and rare catalyst and begin its timed, server-visible stages. Catalyst is configured separately from materials. |
awakening.ritual.enabled | true | |
awakening.ritual.duration-seconds | 900 | |
awakening.ritual.offering-radius | 8 | |
awakening.ritual.warning-percent | 75 | |
awakening.ritual.broadcasts-enabled | true | |
awakening.ritual.lock-during-ritual | false | |
awakening.ritual.recipes.<id> | { kills, catalyst, materials } | Entries keyed by name/number, e.g. volcanic, miner, void, verdant …. |
editor.bind | 127.0.0.1 | Loopback by default. Point editor.public-url at a reachable base when the browser on https://nysxl-gui-editor.pages.dev should call back. |
editor.port | 28765 | |
editor.expiry-minutes | 15 | |
editor.public-url | "" | |
editor.route | relics/trait-builder | |
minions | (section) | Summoned minions (summon_minion): the most each player can have alive at once. |
minions.max-per-player | 6 | |
categories/*.yml
file only Change it: One file per element. Only in the file (see the Relics page for the format). After a hand edit: /relics admin reload.
traits/*.yml
website in game Change it: The website's Relics editor (/relics admin editor) or the in-game builder (/relics admin builder) After a hand edit: /relics admin apply / reload.
items/*.yml
in game file only Change it: /relics admin save writes the held relic as a file; otherwise edit by hand After a hand edit: /relics admin reload.
parts.yml · textures.yml
file only Change it: Hand-made parts and the looks parts can have. Only in the file (/relics admin texture changes one held relic). After a hand edit: /relics admin reload.
Saved data, don't edit: ledger.yml, pedestals.yml, awakening-rituals.yml.
Estates plugins/NysxlEstates/
settings.yml
in game Change it: /estates admin (every switch and value; saved at once) After a hand edit: Applies at once.
All keys are listed on the Estates page under Settings.
pluginData.yml
in game file only Change it: costPerBlock (protection cost per block, 0.1) and claim_currency in /estates admin; always_protected (false) and blocksPerClaim (2000) only in the file After a hand edit: Restart after a hand edit.
GUIs/*.yml
file only Change it: The team menus' layouts After a hand edit: /team reloadGUIs.
Language/*.yml
file only Change it: Messages in English, German and Spanish After a hand edit: Restart.
effects.yml · teamTierCost.yml
file only Change it: The potion effects teams can put on claims, and what each team tier costs After a hand edit: Restart.
Saved data, don't edit: estatesData.yml (teams and claims).
Jobs plugins/NysxlJobs/
config.yml
NysxlJobs settings. Every value here can also be changed in game with /jobs admin -> Settings.
in game Change it: /jobs admin → Settings and /jobs admin → Features, or /serversettings jobs After a hand edit: Applies at once; /jobs reload after a hand edit.
| Key | Default | What it does |
max-jobs | 3 | How many jobs a player can hold at once. Players with nysxljobs.max.<n> get n instead. |
default-currency | DEFAULT | Currency used by jobs that don't set their own (a NysxlServerUtils currency name). |
payout-interval-seconds | 5 | Earnings are added up and paid every this many seconds, with one action-bar summary. |
leave.cooldown-minutes | 60 | Minutes before a player can join a job again after leaving it. |
leave.keep-progress | true | true: levels are kept if you rejoin later. false: leaving resets the job to level 1. |
leave.xp-penalty-percent | 0 | Percentage of the current level's XP lost when leaving (only when keep-progress is true). |
levels | (section) | Defaults for new jobs made in the editor. Each job can change them. |
levels.default-max-level | 100 | |
levels.default-xp-base | 50 | |
levels.default-xp-exponent | 1.3 | |
levels.default-pay-per-level-percent | 1.0 | |
market | (section) | Market pricing: rewards marked "market" pay a percentage of the item's sell price in NysxlSmartShop. Without SmartShop (or when the item isn't sold there) the reward's normal money is paid instead. |
market.enabled | true | |
market.percent-of-sell-price | 10 | |
market.shop | "" | Which SmartShop shop to use for prices and shift sales. Empty = any shop. Each job can choose its own. |
market.shop-choice | HIGHEST | When several shops buy the same item: HIGHEST sell price, LOWEST, or FIRST (shop order). |
shift | (section) | Shifts: players clock in (/jobs clockin) and the items they mine or harvest are taken and sold for them. Selling through SmartShop raises its stock and lowers its price, so farming one item pays less over time. |
shift.enabled | true | |
shift.pay-wage | true | Also pay the job's normal reward money while on shift (XP is always given). |
shift.required-for-pay | false | Pay job money only while clocked in. Off the clock players still get XP, but no money. |
shift.company-cut | (section) | The "company" keeps a share of what the haul sells for. |
shift.company-cut.enabled | true | |
shift.company-cut.percent | 10 | |
shift.fixed-price-fallback | false | Without SmartShop (or when no shop buys an item), sell at each reward's fixed shift price instead. Off: clock-in is only offered when SmartShop is installed, and unbought items are dropped as normal. |
shift.boss-bar | true | Show a boss bar with the shift's earnings while clocked in. |
anti-exploit.placed-blocks | true | Blocks players placed don't pay when broken (no place-and-break farming). |
anti-exploit.diminishing | (section) | Repeating the same action over and over pays less and less. |
anti-exploit.diminishing.enabled | true | |
anti-exploit.diminishing.window-seconds | 300 | |
anti-exploit.diminishing.free-actions | 256 | |
anti-exploit.diminishing.step-percent | 0.5 | |
anti-exploit.diminishing.floor-percent | 25 | |
anti-exploit.spawner-mobs-percent | 0 | Percentage of normal pay for mobs from spawners (0 = nothing). |
anti-exploit.afk-fishing | true | No pay for fishing without moving or looking around (AFK fishing farms). |
anti-exploit.creative-mode-pays | false | Whether players in creative mode get paid. |
disabled-worlds | [] | Worlds where jobs never pay. |
storage | (section) | Where player progress is kept: FILES (players/<uuid>.yml), SQLITE (jobs.db) or MYSQL (shared between servers). Change it in /jobs admin -> Settings -> Storage, then "Apply and reconnect". The copy buttons there move data across. |
storage.type | FILES | |
storage.table-prefix | "nj_" | |
storage.mysql.host | localhost | |
storage.mysql.port | 3306 | |
storage.mysql.database | nysxljobs | |
storage.mysql.user | root | |
storage.mysql.password | "" | |
boosters | (section) | Boosters: timed pay multipliers, server-wide or personal. Several boosters add their bonuses together. |
boosters.enabled | true | |
supply-orders | (section) | Supply orders: when a shop runs low on an item, jobs pay a bonus for it for a while. |
supply-orders.enabled | true | |
supply-orders.check-minutes | 10 | |
supply-orders.low-stock-percent | 25 | A shop item below this % of its restock amount gets an order. |
supply-orders.bonus-percent | 50 | |
supply-orders.duration-minutes | 30 | |
supply-orders.max-active | 3 | |
supply-orders.random-orders | false | Without SmartShop stock to watch, create orders for random job items instead. |
supply-orders.announce | true | |
market-hints | (section) | Market hints: show shop prices and trend arrows in each job's pay list. |
market-hints.enabled | true | |
market-hints.snapshot-minutes | 10 | |
perks | (section) | Perks: rewards for reaching a level in a job (potion effects, double drops). Set per job in its editor. |
perks.enabled | true | |
daily-goals | (section) | Daily goals: a few goals a day from the player's jobs, with a streak bonus. |
daily-goals.enabled | true | |
daily-goals.goals-per-day | 3 | |
daily-goals.xp-per-goal | 300 | A goal asks for about this much job XP worth of one action. |
daily-goals.money-reward | 250 | |
daily-goals.xp-reward | 150 | |
daily-goals.streak-bonus-percent | 10 | Extra reward per day in a row with every goal done, up to the max. |
daily-goals.max-streak-bonus-percent | 100 | |
estates | (section) | NysxlEstates (only when it's installed). |
estates.enabled | true | |
estates.own-claim-bonus-percent | 10 | Extra pay for working inside your own team's claim. |
estates.team-bank-share-percent | 0 | Share of job pay that goes into the player's team bank instead of to them. |
estates.team-xp-percent | 10 | Job XP also earns this % as team XP. |
seasons | (section) | Seasons: earnings are ranked per job each season; the top 3 get rewards, then season stats reset. |
seasons.enabled | true | |
seasons.length-days | 7 | |
seasons.rewards.<id> | {money: 5000, commands: []} | Entries keyed by name/number, e.g. 1, 2, 3. |
leaderboards.hologram-refresh-seconds | 60 | |
skills | (section) | Skill trees: each job level gives skill points to spend in that job's tree (/jobs skills). |
skills.enabled | true | |
skills.points-per-level | 1 | |
skills.respec-cost | 1000 | Cost to reset a job's skills and get the points back (in the job's currency). 0 = free. |
skills.jackpot-multiplier | 5 | Jackpot skills: a lucky payout is worth this many times the normal pay. |
skills.chain-needs-sneak | true | Vein miner and tree feller only work while sneaking, so normal mining stays normal. |
skills.overdrive | (section) | Overdrive skills: sneak and press swap-hands (F) for a burst of extra pay and XP in that job, plus haste. |
skills.overdrive.cooldown-minutes | 10 | |
skills.overdrive.bonus-percent | 50 | |
contracts | (section) | The contracts board (/jobs contracts): timed jobs for everyone, new ones every refresh-hours. Taking one for one of your jobs and finishing it in time pays a bonus on top of the normal pay: pay-multiplier times what that much work normally pays, plus xp-multiplier times its job XP. target-value is roughly what a contract's work pays normally. |
contracts.enabled | true | |
contracts.board-size | 6 | |
contracts.refresh-hours | 2 | |
contracts.max-active | 2 | |
contracts.time-limit-minutes | 90 | |
contracts.target-value | 1500 | |
contracts.pay-multiplier | 2.0 | |
contracts.xp-multiplier | 2.0 | |
contracts.level-xp | 60 | Server level XP (NysxlServerUtils) for finishing one. |
server-levels | (section) | NysxlServerUtils' server levels and battle pass: job XP counts towards them at this share (0.25 = a quarter). |
server-levels.xp-share | 0.25 | |
streaks | (section) | Work streaks: keep working without a break and the job pays a little more, shown in the payout bar. Every actions-per-step paid actions in a row add percent-per-step, up to max-percent ("In the zone" skills raise the cap). A gap longer than window-seconds ends the streak. |
streaks.enabled | true | |
streaks.window-seconds | 8 | |
streaks.actions-per-step | 25 | |
streaks.percent-per-step | 2 | |
streaks.max-percent | 20 | |
jobs/*.yml
in game Change it: /jobs admin → the job (pay list, levels, rewards, skill tree) After a hand edit: Applies at once; /jobs reload after a hand edit.
chat-police.yml
The chat police. Saying a word below leaves an offence for a few minutes. Anyone working a job that pays for FINE (the Chat Warden job) can fine them with /fine <player>, or by clicking the alert they get.
file only Change it: Only in the file. After a hand edit: /jobs reload.
| Key | Default | What it does |
enabled | true | Off switches the whole feature off. |
fine-window-seconds | 300 | How long after saying it a player can still be fined. |
warden-cut-percent | 20 | The warden keeps this share of every fine. The rest goes to the server treasury (or "nowhere" to remove it from the economy). |
rest-goes-to | treasury | |
currency | DEFAULT | The currency fines are taken in (a NysxlServerUtils currency; DEFAULT is the server's normal money). |
notify-wardens | true | Tell online wardens when someone says a fineable word. |
censor | false | Also blank the words out in chat (***). Off: the message shows as typed, so wardens can see it. |
max-fines-per-player-per-hour | 5 | Nobody can be fined more often than this, and each warden waits this long between fines. |
warden-cooldown-seconds | 20 | |
words | (section) | word: fine. Matching ignores capitals, l33t spelling (n00b) and stretched letters (noooob), and only whole words count, so "class" doesn't match "ass". |
words.noob | 25 | |
words.idiot | 50 | |
words.stupid | 40 | |
words.loser | 30 | |
bounty.yml
file only Change it: Only in the file. After a hand edit: /jobs reload.
| Key | Default | What it does |
currency | BHC | Bounties: /bounty <player> <amount> puts money on someone's head. A Bounty Hunter who kills them collects it. The currency bounties are paid in (a NysxlServerUtils currency). |
minimum | 100 | |
tax-percent | 10 | This share of every bounty placed goes to the server treasury. |
expire-days | 7 | Unclaimed bounties go back to whoever put them up after this many days. |
hunters-only | true | Only players working a job that pays for BOUNTY can collect (false: anyone who kills them). |
claim-cooldown-minutes | 60 | A hunter can only collect from the same player once in this long. |
track-cooldown-minutes | 5 | /bounty track shows the way to a target for a minute; hunters can do it this often. |
courier.yml
file only Change it: Only in the file. After a hand edit: /jobs reload.
| Key | Default | What it does |
currency | DEFAULT | Couriers. /send <player> [fee] opens a parcel to fill; closing it puts it on the delivery board (/deliveries). A Courier takes it, carries the sealed slip to the recipient and right-clicks them to hand it over. |
minimum-fee | 10 | |
default-fee | 25 | The fee when /send doesn't give one. |
delivery-minutes | 30 | A courier has this long to deliver before the parcel goes back on the board. |
open-days | 3 | Parcels nobody takes go back to the sender after this long. |
max-open-per-sender | 3 | How many parcels one player can have waiting at once. |
debt-collecting.yml
file only Change it: Only in the file. After a hand edit: /jobs reload.
| Key | Default | What it does |
collector-cut-percent | 15 | Debt collecting. NysxlEstates teams that miss their daily claim upkeep owe it. A Debt Collector goes to their land and runs /collect <team> to recover it from the members' own balances. The collector keeps this share of what's collected; the rest goes to the server treasury. |
max-share-of-balance-percent | 25 | Nobody loses more than this share of their balance in one visit. |
cooldown-minutes | 60 | Each collector can visit the same team this often. |
must-be-on-their-land | true | The collector has to be standing on the team's claimed land. |
messages.yml
file only Change it: Every message Jobs sends After a hand edit: /jobs reload.
Saved data, don't edit: players/ (or jobs.db / MySQL), data.yml, parcels.yml, bounties-data.yml.
SmartShop plugins/NysxlSmartShop/
settings.yml
in game Change it: /smartshop settings (every option; the old auctionConfig.yml limit is carried over) After a hand edit: Applies at once.
The keys are listed on the SmartShop page under Settings.
shops (database)
in game Change it: Shops, items and prices: /shop edit, /categoryGUI, /eventEditor, /sellwand After a hand edit: Applies at once.
language.yml
file only Change it: Every message SmartShop sends After a hand edit: /shopreload.
AuctionCategories.yml
file only Change it: The auction house's categories and which items go in each After a hand edit: /shopreload.
Saved data, don't edit: The SQLite database (or MySQL) with shops, auctions, buy orders, price history and the transaction log.
PPLootChests plugins/PPLootChests/
loot.yml
PPLootChests default loot. Copied to plugins/PPLootChests/loot.yml only when that file does not exist. Servers that already have a loot.yml keep it. Stop the server and delete the file to regenerate these defaults. Nothing here is assigned to a chest. Use the in-game tools to set lootchests. cooldown is seconds. chance is 0-100 and each entry rolls on its own. The chest then keeps between min-items and max-items stacks. Nested loot_handlers are extra tables rolled at the listed chance. relic_parts (needs NysxlRelics) adds random relic parts on top of a table's items, e.g. relic_parts: chance: 20 # % each time the table is opened min: 1 max: 1 types: [pickaxe, axe] # relic types; leave out for any slots: [head, blade] # handle, guard, blade/head, gem, or a type's own slot names elements: [miner] # volcanic, frost, void, storm, celestial, blood, necrotic, verdant, chronos, miner rarities: [rare, epic] # common up to mythic relics (needs NysxlRelics) adds whole forged relics the same way (no slots), e.g. relics: {chance: 2, min: 1, max: 1, types: [sword], rarities: [legendary, mythic]} Both are also set in game: the loot editor's "Relic drops" button. drops.chests puts the loot bag (or its items, with drop-items) in structure chests the game fills, e.g. drops: chests: - {loot-table: chests/end_city_treasure, chance: 10} - {loot-table: chests/village/*, chance: 2} Also set in game: the table's World Drops > Add a Structure Chest.
in game Change it: Tables: /lt edit, /lt drops. Anti-exploit and world loot: /lt settings After a hand edit: Applies at once; /lt reload after a hand edit.
Written only when it doesn't exist yet, so updates never overwrite your tables.
| Key | Default | What it does |
settings.anti-exploit.prevent-placed-blocks | true | |
settings.anti-exploit.require-player-kill | true | |
settings.anti-exploit.prevent-spawner-mobs | true | |
settings.anti-exploit.allow-creative | false | |
settings.world-loot | (section) | Adds loot to the world's own chests (dungeons, temples, villages, ships...) the first time each one is opened. Each rule rolls one of the loot_tables below into matching chests. loot-tables are vanilla loot table names; * matches anything ("chests/*" is every structure chest). |
settings.world-loot.enabled | false | |
settings.world-loot.rules | list of 2 | |
loot_tables.<id> | { cooldown, min-items, max-items, drops, loot_definitions, loot_handlers, relic_parts, relics } | Your loot tables. The full format is on the PPLootChests page. |
Saved data, don't edit: Chest locations and players' cooldowns.
SpawnerWorks plugins/NysxlSpawnerWorks/
config.yml
All listed outputs are simulated. This plugin never creates mob entities.
in game Change it: /serversettings spawnerworks After a hand edit: Applies at once; /spawnercore reload after a hand edit.
The chamber's shape is an NSU machine: /multiblock edit nysxlspawnerworks:chamber.
| Key | Default | What it does |
settings.production-interval-seconds | 300 | |
settings.offline-cap-hours | 8 | A core catches up on at most this many hours when its chunk loads again. |
settings.output-buffer-stacks | 6 | |
settings.max-stack | 16 | Right-click a placed core with another core of the same type to stack them (output, fuel and storage scale). |
idle | (section) | Cores slow down, then stop, while their owner is offline. |
idle.enabled | true | |
idle.slow-after-hours | 24 | |
idle.slow-rate | 0.5 | |
idle.stop-after-hours | 72 | |
limits | (section) | How many cores each player may own. Give nysxlspawnerworks.limit.<number> for more, or nysxlspawnerworks.limit.unlimited for no limit (the highest number a player has wins). |
limits.default | 10 | |
limits.count-stacks | true | Each core in a stack counts towards the limit, so stacking doesn't get around it. |
hoppers | (section) | A hopper pointing into a core feeds it fuel; any other chest, barrel or hopper touching it collects the output. |
hoppers.enabled | true | |
hoppers.items-per-second | 8 | |
warnings | (section) | Messages to an online owner when a core stops. |
warnings.out-of-fuel | true | |
warnings.full | true | |
selling | (section) | The Sell button in the core menu sells the output through NysxlSmartShop's admin shops. |
selling.enabled | true | |
selling.shop | "" | Leave empty for any shop (the best price wins), or name one shop. |
selling.multiplier | 1.0 | |
upgrades | (section) | Upgrades bought in the core menu. cost is the first level's price; each level costs cost-growth times the last. |
upgrades.enabled | true | |
upgrades.currency | DEFAULT | The NSU currency used (DEFAULT is the main money). |
upgrades.speed | {max: 5, per-level: 0.1, cost: 2500, cost-growth: 1.6} | |
upgrades.storage | {max: 5, per-level: 0.25, cost: 2000, cost-growth: 1.5} | |
upgrades.efficiency | {max: 5, per-level: 0.08, cost: 3000, cost-growth: 1.6} | |
drops | (section) | Ways to get a core besides /spawnercore give. |
drops.mob-kills | true | Killing a mob (one not from a spawner) has each core's drop-chance (percent) to drop that core. |
drops.silk-touch | (section) | Mining a vanilla spawner with Silk Touch drops the core of its mob, when that core type is below. |
drops.silk-touch.enabled | true | |
drops.silk-touch.chance | 100 | |
chamber | (section) | A chamber built around a core speeds it up. Its shape is kept by NysxlServerUtils: change it in game with /multiblock edit nysxlspawnerworks:chamber (or in plugins/NysxlServerUtils/multiblocks/NysxlSpawnerWorks/chamber.yml). The chamber is only as good as the worst tier block in it. |
chamber.enabled | true | |
chamber.tiers.<id> | {block: COPPER_BLOCK, speed: 1.15, buffer: 1.25, fuel: 1.0} | Lowest first. speed divides the time per batch, buffer multiplies the storage, fuel multiplies fuel per batch. Entries keyed by name/number, e.g. copper, iron, gold, diamond …. |
hologram | true | Floating text above each core: its type, chamber and how much it's holding. |
cores.<id> | { fuel, fuel-per-interval, drop-chance, outputs, rare } | Core types. The name is the mob (it also decides the spawner's look and which mob drops it). To remove a type set enabled: false; a deleted type comes back on the next update. outputs are per batch; rare outputs are a percent chance per batch; drop-chance is per kill. Entries keyed by name/number, e.g. skeleton, zombie, spider, creeper …. |
Saved data, don't edit: cores.yml (placed cores).
Interactable Blocks plugins/NysxlInteractableBlocks/
blocks/*.yml
in game Change it: /iblocks (name, recipe, tool, breaking, clicks, textures) After a hand edit: Applies at once; /iblocks reload after a hand edit.
Pictures go in textures/ and Blockbench models in models/; then Build the resource pack or /iblocks pack.
Saved data, don't edit: Placed blocks.
Reference
All permissions
Every permission from every plugin in one list. true means everyone has it, op means only ops, and false means nobody until you grant it.
NysxlServerUtils
| Permission | Default | What it gives |
nysxl.images | true | Type {img:name} in chat, signs, anvils, books |
nysxl.menu | true | /menu <name> |
nysxl.menu.others | op | Open menus for other players |
nysxl.menus.viewas | op | /menuviewas |
nysxl.menustyle.admin | op | Set menu styles for others |
nysxl.screen · .fov · .pointer | true | Open screens; adjust FOV and pointer speed |
nysxl.screen.admin | op | Place, remove, list, reload screens; /screen pack |
nysxl.guieditor | op | Use the website editor |
nysxl.guieditor.all | op | Edit every plugin's menus (otherwise nysxl.guieditor.<plugin>, and .custom for website menus) |
nysxl.guieditor.console | op | Apply saves containing console commands |
nysxl.guieditor.autosync | op | Turn on auto-sync |
nysxl.dialogs.admin | op | /nsudialog |
nysxl.prefix · nysxl.suffix | true | Pick a ready-made prefix or suffix |
nysxl.prefix.custom · .colour · .others | op | Own text; colours; others and reload (same for suffix) |
nysxl.economy.balance · .balance.others · .pay · .baltop | true | Money commands |
nysxl.economy.admin | op | /eco |
nysxl.ecoadmin | op | /ecoadmin |
nysxl.treasury | true | See the treasury and goals |
nysxl.treasury.admin | op | Manage the treasury |
NysxlServerUtils.currency.use · .currency.pay · .currency.admin.* | op | /currency |
NysxlServerUtils.tax.use · .tax.admin | op | /tax |
nysxl.staff | op | /staff, /timeline |
nysxl.admin.settings | op | /serversettings, /essentialslink |
nysxl.web.admin · nysxl.web.owner | op | Web admin view and logins; see every login |
nysxl.poll.admin · nysxl.kits.admin · nysxl.crates.admin · nysxl.prizes.admin | op | Run polls, kits, crates, weekly prizes |
nysxl.battlepass.premium · .admin | op | Premium pass; manage the pass |
nysxl.homes.<n> | grant | n homes (up to 50) |
nysxl.teleport.instant | op | No teleport warm-up |
nysxl.warps.admin | op | /setwarp, /delwarp, and every warp |
nysxl.warp.<name> | grant | Use that warp (only when warps.per-warp-permission is on) |
nysxl.multiblock.admin · .web.commands | op | Machines; apply new machine commands from the website |
Staff Utilities
| Permission | Default | What it gives |
staffutilities.tickets | true | Make tickets and reports |
staffutilities.admin | op | Counts as staff; staff chat |
staffutilities.admin.staffpanel | op | Panel, freeze, mute, history, alts, notes |
staffutilities.admin.staffmode | op | Staff mode |
staffutilities.admin.punish | op | Warn, kick, take lines off a record |
staffutilities.admin.ban | op | Ban, tempban, unban |
staffutilities.admin.tickets | op | Handle everyone's tickets |
staffutilities.admin.commandspy | op | Command spy |
staffutilities.vanish.<n> | false | Vanish weight n |
staffutilities.commandspy.hidden · .miningalerts.exempt | false | Hidden from command spy; no mining alerts |
staffutils.bypass | false | Use banned items in staff mode |
Relics
| Permission | Default | What it gives |
nysxlrelics.use · .list · .inspect | true | The menu, lists, inspecting |
nysxlrelics.forge · .gems · .reforge · .cleanse · .codex · .engrave | true | Player stations |
nysxlrelics.admin | op | Everything, including give, generate, reload, save, builder, gem, texture |
Estates
| Permission | Default | What it gives |
nysxlestates.base · nysxlestates.team.base | true | /estates, /team |
nysxlestates.team.create · .leave · .info · .disband | true | Team basics |
nysxlestates.team.home · .warp · .chat · .map · .top · .getClaimShovel | true | Team features |
nysxlestates.admin · nysxlestates.bypass | op | Admin menu, vouchers, spy; ignore claim rules |
Jobs
| Permission | Default | What it gives |
nysxljobs.use | true | Jobs and job commands |
nysxljobs.admin · .bypass.limit · .bypass.cooldown | op | Admin; join full jobs; skip the wait |
nysxljobs.max.<n> · nysxljobs.fine.exempt | false | Hold n jobs; can't be fined |
SmartShop
| Permission | Default | What it gives |
shop.open + shop.open.<shop> | true | Open a shop |
auction.GUI | true | Auction house |
smartshop.buyorders.use · smartshop.chestshop.create | true | Buy orders; chest shops |
smartshop.chestshop.limit.<n> · smartshop.auction.listings.<n> · smartshop.buyorders.limit.<n> | grant | Raise limits |
smartshop.admin | op | All admin: shop.admin, auction.admin, sellwand.admin, category.admin, eventEditor.admin, chest shop and buy order admin |
PPLootChests, SpawnerWorks, Interactable Blocks
| Permission | Default | What it gives |
pplootchests.loot.* | true | Loot any loot chest |
pplootchests.admin | op | create, edit, setblock, delete, drops, settings, getLootBag, reload, teleport, unassign |
nysxlspawnerworks.use | true | Use cores |
nysxlspawnerworks.admin · .limit.unlimited | op | Give and reload; no core limit |
nysxlspawnerworks.limit.<n> | grant | Own n cores |
nysxlinteractableblocks.admin | op | Make, edit, give and break any custom block |