1.x/Permissions

Permissions are essential in controlling each aspect of Citizens. You can use this to fine-tune what functionality you want your users to use. Currently Citizens only works with a SuperPerms plugin such as Permissions EX. These nodes are for use in your permissions.yml provided by your permissions plugin. Refer to your permissions system documentation for exact usage.

Configuration Examples

Very Basic Permissions Configuration

To allow all functionality to citizens, use this permissions node. It grants all functionality to your users.

citizens.*

You may also want to disable the following node as it essentially limit functionality instead of enabling it. See Evil NPCs for more information.

- citizens.evils.immune

Basic Permission Example

Below is an example of a slightly more robust permissions setup, perfect for an RPG-style server in which 'admins' set up NPCs for players to use and interact with. This allows admins complete control over Citizens, while granting regular players only permission to interact with NPC Characters. Refer to your permissions documentation for exact formatting.

admins:
citizens.*

default:
citizens.wizard.use.interact
citizens.quester.use.*
citizens.blacksmith.use.repair
citizens.trader.use.trade
citizens.healer.use.heal

Advanced Permissions

There are literally thousands of way to use permissions. Below we have referenced a complete list of permission nodes that you can grant or deny to players to create specific situations only limited by your imagination.

For example: Players could start out with only quester permissions and use quests to grant the use of other NPC Character types through granting permissions as rewards.

What else? You tell us! Have fun fine-tuning!

Complete list of Permission nodes

For reference, here is a list of all the permission nodes contained in Citizens. For more detail on what each node does, refer to the appropriate sections in Commands or Characters.

# Admin Permissions.
citizens.admin.info
citizens.admin.debug
citizens.admin.reload
citizens.admin.save
citizens.admin.clean
citizens.admin.override.setowner
citizens.admin.override.remove
citizens.admin.notifyupdates

# Basic Permissions.
citizens.basic.create
citizens.basic.use.help
citizens.basic.use.info
citizens.basic.use.list
citizens.basic.use.select
citizens.basic.modify.move
citizens.basic.modify.moveto
citizens.basic.modify.copy
citizens.basic.modify.color
citizens.basic.modify.settext
citizens.basic.modify.addtext
citizens.basic.modify.equip
citizens.basic.modify.talkclose
citizens.basic.modify.lookat
citizens.basic.modify.remove
citizens.basic.modify.setowner

# Basic Permissions that grant extra power.
# Be cautious when granting these permissions.
citizens.basic.use.teleport
citizens.basic.modify.remove.all

# Waypoint Permissions.
citizens.waypoints.edit
citizens.waypoints.modifier.delay

# Character Toggle Permissions
citizens.toggle.help
citizens.toggle.blacksmith
citizens.toggle.healer
citizens.toggle.quester
citizens.toggle.wizard
citizens.toggle.guard
citizens.toggle.trader
citizens.toggle.all

# Limits. Use one.
citizens.npccount.x  # Replace X with number of NPCs.
citizens.npccount.unlimited

# Blacksmith Character. 
citizens.blacksmith.use.help
citizens.blacksmith.use.status
citizens.blacksmith.use.repair

# Guard Character.
citizens.guard.use.help
citizens.guard.modify.type
citizens.guard.use.flags
citizens.guard.modify.flags
citizens.guard.modify.radius
citizens.guard.modify.aggro

# Healer Character.
citizens.healer.use.heal
citizens.healer.use.help
citizens.healer.use.status
citizens.healer.modify.levelup

# Trader Character.
citizens.trader.use.trade
citizens.trader.modify.stock
citizens.trader.use.help
citizens.trader.modify.money
citizens.trader.use.showmoney
citizens.trader.use.list
citizens.trader.modify.unlimited
citizens.trader.modify.stock
citizens.trader.modify.clearstock

# Wizard Character.
citizens.wizard.use.interact
citizens.wizard.use.help
citizens.wizard.use.status
citizens.wizard.modify.unlimited
citizens.wizard.modify.mode
citizens.wizard.use.locations
citizens.wizard.modify.addloc
citizens.wizard.modify.removeloc
citizens.wizard.modify.command

# Quester Character.
citizens.quester.use.help
citizens.quester.modify.quests.assign
citizens.quester.modify.quests.remove
citizens.quester.use.quests.view
citizens.quester.use.quests.help
citizens.quester.use.quests.abort
citizens.quester.use.quests.status

# Evil NPC Nodes.
citizens.evils.immune