Skip to content
Aithor Dev

Config

On this page

config.yml

The main configuration file, at plugins/NationCore/config.yml. Reload with /nc admin reload (live-map changes also need /nc admin map reload to be applied to the map itself).

general

YAML
general:
  language: "en"
Key Default Description
language "en" Language identifier. Messages themselves live in language.yml.

nation.capital

YAML
nation:
  capital:
    default-radius: 50
    protect: true
    claim-cost: 0
Key Default Description
default-radius 50 Default capital radius in blocks from the claim point
protect true Whether capital territory is protected from non-member griefing
claim-cost 0 Cost of claiming the capital, withdrawn from the nation's treasury. 0 is free

nation.territory

YAML
nation:
  territory:
    claim-cost: 25000
    capital-relocate-cost: 50000
    capital-relocate-cooldown-hours: 24
Key Default Description
claim-cost 25000 Cost to claim one chunk of new territory
capital-relocate-cost 50000 Cost of relocating the capital to an already owned chunk
capital-relocate-cooldown-hours 24 Real-time hours between capital relocations

Territory costs are withdrawn from the leader's own Vault balance, not the nation treasury.

integration.factory-tax

Routes FactoryCore tax into nation treasuries. See FactoryCore Tax Routing.

YAML
integration:
  factory-tax:
    enabled: true
    share-percent: 100.0
    max-per-payment: 0.0
    log: true
Key Default Description
enabled true Master switch for accepting routed factory taxes
share-percent 100.0 Percentage of each payment banked into the owning nation's treasury (0–100, clamped)
max-per-payment 0.0 Maximum a single payment may add. 0 disables the cap
log true Log every routed payment to the console

FactoryCore must also enable integration.nation-tax.enabled on its side.

integration.apartment-tax

Identical keys and semantics, for ApartmentCore. Fully independent from factory-tax.

YAML
integration:
  apartment-tax:
    enabled: true
    share-percent: 100.0
    max-per-payment: 0.0
    log: true

integration.land-permit

The sovereignty gate for third-party builds. See Land-Use Permits.

YAML
integration:
  land-permit:
    enabled: true
    kinds:
      factory: true
      apartment: true
    require-leader-online: true
    notify-leader-on-join: true
    notify-applicant: true
    log: true
    request-expiry-minutes: 60
    approval-validity-minutes: 30
    denial-cooldown-minutes: 30
    retain-decided-minutes: 1440
    request-cooldown-seconds: 60
    max-pending-per-player: 3
    max-pending-per-nation: 50
    max-area-chunks: 1024
    deny-multi-nation-overlap: true
    verify-applicant-online: true
    verify-applicant-location: false
    applicant-max-distance: 512
    max-label-length: 32
    bypass-permission: "nation.landpermit.bypass"
    exempt:
      leader: true
      officers: false
      citizens: false

Switches

Key Default Description
enabled true When false, NationCore does not police land at all
kinds.factory true Whether factory builds must ask
kinds.apartment true Whether apartment builds must ask
require-leader-online true Applications can only be filed while the head of state is online. false lets requests queue for an offline leader
notify-leader-on-join true Show the leader their pending queue shortly after they log in
notify-applicant true Let NationCore deliver the refusal/approval text itself, localised from language.yml
log true Write every filed / approved / denied / consumed permit to the console

Lifetimes (minutes)

Key Default Description
request-expiry-minutes 60 How long an unanswered application stays in the queue
approval-validity-minutes 30 How long an approval stays usable. It is a short-lived, single-use capability
denial-cooldown-minutes 30 How long after a rejection before the same player may re-apply for the same area. 0 disables
retain-decided-minutes 1440 How long settled permits are kept for auditing before being pruned

Anti-spam

Key Default Description
request-cooldown-seconds 60 Minimum gap between two applications from the same player
max-pending-per-player 3 Unanswered applications one player may have at a time
max-pending-per-nation 50 Unanswered applications one nation may accumulate

Footprint rules

Key Default Description
max-area-chunks 1024 Largest region NationCore will evaluate. Bigger footprints are refused outright, which caps lookup cost
deny-multi-nation-overlap true Refuse a region straddling two or more nations. false lets the nation owning the centre chunk decide

Security

Key Default Description
verify-applicant-online true Refuse requests whose applicant is not a verifiable online player. Stops a buggy or hostile partner plugin filing claims for arbitrary UUIDs
verify-applicant-location false Also require the applicant to be physically near the plot
applicant-max-distance 512 The distance used by the check above
max-label-length 32 Longest build label accepted from a partner plugin. Labels are always stripped of colour codes and MiniMessage tags
bypass-permission nation.landpermit.bypass Permission that skips the whole gate

Exemptions

Key Default Description
exempt.leader true The head of state never asks themselves
exempt.officers false Officer / cabinet-level members
exempt.citizens false Ordinary citizens of the owning nation

integration.squaremap

The live web map. See squaremap Live Map for the full walkthrough; this is the key list.

YAML
integration:
  squaremap:
    enabled: true
    web:
      public-url: ""
      link-zoom: 3
    worlds:
      mode: blacklist
      list: []
    hidden-nations: []
    refresh:
      interval-seconds: 10
      instant-territory-updates: true
Key Default Description
enabled true Master switch
web.public-url "" Public address of your squaremap web UI. Enables /nc map links
web.link-zoom 3 Zoom level used by those links
worlds.mode blacklist blacklist draws on every world except those listed; whitelist draws only on those listed
worlds.list [] Bukkit world names
hidden-nations [] Nations (by name or id) that are never drawn
refresh.interval-seconds 10 How often the map is checked for changes. Min 2, max 600
refresh.instant-territory-updates true Push territory and capital changes within about a second

Layers

Key Default Description
layers.territories.label "Nations ({count})" Name in the layer control; {count} is the number shown
layers.territories.show-controls true List the layer so visitors can toggle it
layers.territories.default-hidden false Start with the layer off
layers.territories.priority 20 Position in the control (lower = higher up)
layers.territories.z-index 20 Drawing order (higher = on top)
layers.territories.split-by-government false One toggleable layer per government type
layers.territories.government-labels.* see file Labels for the split layers
layers.capitals.enabled true Draw capital icons and highlighted chunks
layers.capitals.label "Capitals" Name in the layer control
layers.capitals.show-controls true List the layer
layers.capitals.default-hidden false Start with it off
layers.capitals.priority 25 Position in the control
layers.capitals.z-index 250 Drawing order

Style

Key Default Description
style.color-mode GOVERNMENT GOVERNMENT colours by type; NATION gives each nation a unique stable colour
style.government-colors.* see file Hex colour per government type
style.stroke-weight 2 Border line width in pixels. 0 = no outline
style.stroke-opacity 0.9 Border opacity
style.fill-opacity 0.22 Territory fill opacity. 0 = outline only
style.allow-leader-colors true Let heads of state use /nc map color
style.overrides {} Fixed colours per nation, by name or id. These win over everything else

Capitals

Key Default Description
capitals.icon.enabled true Draw the emblem badge at the capital
capitals.icon.size 28 Icon size in pixels
capitals.highlight-chunk.enabled true Outline the capital chunk
capitals.highlight-chunk.color "#FFD700" Highlight colour
capitals.highlight-chunk.stroke-weight 3 Highlight line width
capitals.highlight-chunk.fill-opacity 0.15 Highlight fill opacity

Custom icons go in plugins/NationCore/squaremap/icons/ as capital-republic.png, capital-communist.png, capital-monarchy.png, capital-caliphate.png or capital.png.

Popups

Key Default Description
popup.click-popup true Rich info card on click
popup.hover-tooltip true Compact card on hover
popup.show-treasury true Show the treasury balance
popup.show-online-members true Show the online member count
popup.online-refresh-seconds 60 How often online counts are re-sampled. Min 5
popup.show-diplomacy true Show allies, truces and wars
popup.show-welcome-message true Show the nation's welcome message
popup.max-listed-relations 5 How many relations are listed before "+N more"
popup.welcome-max-length 160 Longest welcome message shown, in visible characters
popup.currency-symbol "$" Currency symbol on the map
popup.date-format "d MMM yyyy" Java DateTimeFormatter pattern for the founding date

Hidden values disappear from the popup entirely, because the template sections around them become empty.

Search documentation

    Type to start searching.