Skip to content
Aithor Dev

Quick Start

On this page

Quick Start

A five-minute tour of NationCore for server owners. If you are a player, read Founding Your First Nation instead.

1. Open the hub

Everything starts with one command:

Text
/nc hub

This opens the Nation Hub β€” a list of every nation on the server. From here a player can look at other nations, open their own nation's menu, or create a new nation.

2. Understand the money flow

NationCore uses two separate pots of money:

  • Player balance β€” the normal Vault balance. Used to pay the founding fee, territory claims and election fees.
  • Nation treasury β€” one per nation, stored by NationCore itself. Used to pay executive orders, salaries, research and free-food distributions.

Money moves between them through taxes, donations and salaries. Every movement is written to the nation's transaction log.

3. Pick your balance

The three files you will edit most:

File Controls
config.yml Capital radius and protection, territory claim costs, all integrations, the live map.
nations/*.yaml Founding cost, salaries, election timings, tax phases β€” separately for each government type.
order.yaml Every executive order and office decision: on/off, name, lore, cost, cooldown, duration.

Reload them without a restart:

Text
/nc admin reload

4. Watch the schedulers

NationCore runs several background timers. The most visible ones:

Every What happens
1 minute Election phases, recall petitions, executive-order expiry, office-decision expiry, tax invoice escalation.
1 minute Communist / Monarchy / Caliphate tax phases and food distributions are checked; they only fire when their own interval has elapsed.
30 seconds Research projects tick and complete.
1 hour Politburo and High Council weekly salaries are checked.
24 hours A new tax invoice is issued to every active nation member.
5 minutes All data is saved to disk.

The full list is in Scheduled Tasks.

5. Try the admin tools

Text
/nc admin treasury give <nation> 1000000   # top up a treasury
/nc admin set leader <nation> <player>     # install a head of state
/nc admin research set <nation> <id> 3     # grant a research level
/nc admin npc invite <nation> <name>       # add a test NPC member
/nc admin map status                       # live-map health
/nc admin reload                           # reload config + language

All of these need the nation.admin permission (default: operators only).

6. Optional: turn on the live map

If squaremap is installed, set your public map address in config.yml:

YAML
integration:
  squaremap:
    enabled: true
    web:
      public-url: "https://map.example.com"

Then /nc map gives players a clickable link that opens their capital on the web map. See squaremap Live Map.

Next steps

Search documentation

    Type to start searching.