nysxl
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

Install order and requirements

  1. NysxlServerUtils goes in first. Every other Nysxl plugin lists it under depend and will not start without it.
  2. Vault is needed by SmartShop. NSU has its own built-in economy and registers it with Vault, so you don't need EssentialsX economy.
  3. NuVotifier is needed for vote rewards. Without it /vote still shows the vote sites, but votes pay nothing.
  4. Optional: PlaceholderAPI (placeholders in menus), LuckPerms (prefixes and permission groups), WorldGuard, ProtocolLib, Citizens and MythicMobs are all picked up when present.
  5. Restart the server once. Each plugin writes its default files into plugins/<Plugin>/ on first start.

Your first ten minutes as owner

  1. Run /guieditor. It uploads every plugin's menus and gives you a link to the website editor.
  2. Change something, press Save, and paste the /guieditor apply <code> it gives you back in game. A backup is made first.
  3. Open /serversettings to change the feature files (daily rewards, quests, levels and so on) from a menu instead of editing YAML.
  4. Set up the server's web page in web-stats.yml (host.port and host.public-url), then try /web.
  5. Run /screen pack to check the resource pack reaches you. Pictures, screens, dialogs and custom blocks all need it.
  6. Give your staff group staffutilities.admin plus the staff permissions they need (see Staff Utilities).

Things that work the same everywhere

WhatHow 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).
Times45 (seconds), 30m, 12h, 7d, 2w for bans.
Money2500, 10k, 1.5m. Currencies are NSU currencies; DEFAULT is the main one.
MenusEvery 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 changesThe website never touches the server directly. It gives you a code, and you run the matching apply command in game.
Config filesEvery settings file, its defaults, and whether it can be changed in game: see Config files.
ReloadingMost 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.