Docs

First server step by step

This guide takes a freshly installed server to a playable one: ranks, mines, pickaxe, economy and a private mine. Every step links to the page with all the details.

Do everything as op or with pulseprison.admin.

1. Choose language, storage and modules

In config.yml:

  • language.default: the language for players who did not pick one. See Languages.
  • storage.type: json for a single server, mysql to share data between several. See Storage.
  • modules: turn off what you won't use or what another plugin already handles. See Modules.

Restart after changing modules or storage.

2. Define the currencies

currencies.yml ships with money, tokens, gems and shards. Change names, symbols and formats, or add your own. See Currencies.

If you already use another economy, let PulsePrison be the Vault economy, or create a currency with provider: vault.

3. Build the rank ladder

Edit ranks.yml: each rank has a cost, blocks mined and pickaxe level requirements, and commands to run on rankup. The sell price of every block is in prices.yml. See Ranks and Prices.

Test the ladder with /rankup info and /ranks.

4. Build the rank mines

For every rank:

text
/mine pos1                          standing on one corner of the mine
/mine pos2                          standing on the opposite corner
/mine create a A                    creates mine "a" for rank A; the spawn is your position
/mine composition a add STONE 80
/mine composition a add COAL_ORE 20
/mine setdelay a 300                reset every 5 minutes
/mine setpercent a 60               or when 60% is mined

Players see them in /mines. See Mines.

5. Check the pickaxe and enchants

Every player gets their pickaxe on join. Try it:

  • Right click with the pickaxe opens the enchant menu.
  • /prisonadmin pickaxe me level set 50 levels you up to test high level enchants.
  • /prisonadmin enchant me all set max gives you everything maxed.

Prices, max levels and chances are in enchants.yml. See Pickaxe and Enchants.

6. Create the private mine type

Private mines need at least one type with its structure. pmines/types/default.yml already exists, but the structure is built and read on the server:

/pmineadmin setup default overwrite

Follow Creating a private mine type. Once it is saved, players create theirs with /pmine.

7. Configure progression

You don't need to touch everything. The defaults work and can be tuned later:

If you wantEdit
More player levelslevels.yml (Levels)
Permanent upgradesattributes.yml (Attributes)
Goals with rewardsmilestones.yml (Milestones)
Items for crates or a storeboosters.yml, crystals.yml, armors.yml, placeables.yml, skins.yml
Passive incomeautominers.yml, afk-blocks.yml, robots.yml

Every reward uses the same actions and every bonus adds to the same stats.

8. Connect the rest of the server

  • Scoreboard, TAB and holograms: install PlaceholderAPI and use the placeholders.
  • Crates, votes and store: hand out items and rewards with console commands such as /booster give, /crystals give, /placeables give, /skins give, /pet give or /economy give.
  • Spawn areas: with WorldGuard, allow area enchants with /rg flag <region> pulseprison-enchants allow, or limit AFK blocks to regions.

9. Reload and test

/prison reload reloads config.yml, the number format, currencies, levels and menus. Progression and content systems have their own reload, for example /booster reload or /pmineadmin reload (full list in Staff commands). For modules, storage, enchants and any other file, restart.

Before opening, test with an account without staff permissions: mine, sell, rank up, open every menu and create a private mine.

First server step by step | PulsePrison Core Docs