Skip to content

Roles and permissions

A role is a named set of permissions. You give roles to players and users. Takaro then checks those permissions before anyone does something.

  • Player roles control what players can do in game, like using teleports or claiming a VIP reward.
  • User roles control what your team can do in the dashboard and the API, like banning players or installing modules.

Takaro dialog to assign a role to a player, with role, server scope and an optional expiry date.

There are two kinds of permission:

  • Built-in permissions, such as Manage Players, Read Events or Manage Roles. They control the dashboard and the API.
  • Module permissions. Each installed module can add its own. For example, a teleport module can have one permission to use teleports and one to set public teleports.

Some module permissions have a count, for example how many teleports a player may set.

Open Roles in the sidebar.

Takaro Roles page with the roles listed on the left and the Community moderator role open on its Permissions tab, three permissions switched on.

  • The left side lists every role, marked system or custom.
  • All members shows everyone who has any role: players and users, with Scope (Global or Per-server) and how many assignments they have.
  • Click a role to open it. It has two tabs:
    • Permissions: switch permissions on or off. Changes save right away. Permissions are grouped by module, and you can search them.
    • Members: everyone with this role, with Scope, Granted date and Expires date.
  1. On the Roles page, choose New Role.
  2. Enter a Name.
  3. Switch on the Permissions you want.
  4. Choose Create Role.

How many custom roles you can create depends on your plan. When you reach the limit, New Role is disabled.

In the New Role form you can describe the role in plain words instead:

  1. Under Describe the role, write what it should and should not do. For example: “can kick players but not ban them”.
  2. Choose Suggest permissions.
  3. Check the Proposed permissions: what to add, remove or change.
  4. Choose Apply to form, then Create Role.

Nothing is saved until you choose Create Role. Takaro AI never proposes full access (Root), and it leaves out permissions you don’t have yourself. See Takaro AI.

Open the role and use Edit name or Delete role. System roles can’t be renamed or deleted.

You can give a role from several places:

  • A player’s profile: Assign role. See Players.
  • A Players list: the row menu or the bulk bar, Assign Role.
  • Users → All users: Assign role. See Users and invites.
  • An invite link can give roles when someone joins.

From a server’s Players list it looks like this:

When you give a player a role, Server scope decides where it counts:

  • Global (all servers): the role counts on every game server.
  • One server: pick a server. The role counts only there.

Roles add up. A player’s permissions are all their global roles plus their roles on the server they are on.

Example:

  • A player has a global role that allows using teleports.
  • On Server A they also have a role that allows setting teleports.

They can use teleports everywhere, but set them only on Server A.

Set Expires when you give a role. Leave it empty for a permanent role. The role ends by itself on that date. Use this for things like a month of VIP.

  • From a player: open their profile, Roles tab, Remove.
  • From the Roles page: open the role, Members tab, use the row menu.

Takaro creates three roles for every community. They have special meaning.

Role What it is
root Has every permission. You can’t change or delete it. Don’t give it out
User Every user has it
Player Every player has it

None of them can be renamed or deleted. root is fully read-only. You can change the permissions of Player and User: switch a permission on in Player and every player gets it, for example to let everyone use a module’s commands.

A module command can require permissions. Before running it, Takaro checks the player has all of them.

  • A player without them gets a chat message such as: “You need the ‘Economy Utils Manage Currency’ permission to use this command. Please contact an admin if you need access.”
  • Takaro records a command-execution-denied event, so you can see it on the Events page.
  • Players with the Root permission can run any command.

Example: in the economyUtils module, anyone can use /balance, but /grantcurrency and /revokecurrency need the ECONOMY_UTILS_MANAGE_CURRENCY permission.

You can keep Takaro roles and Discord roles in sync. Change a role in one place and it updates in the other.

You need:

  • The Takaro bot in your Discord server, with permission to manage roles.
  • Players and users who connected their Discord account to their Takaro login.
  1. Open the role on the Roles page.
  2. Choose Edit name.
  3. Pick the Discord server, then the Linked Discord Role ID from the list. You can also choose Enter an ID manually.
  4. Choose Save.

If your plan doesn’t include Discord role linking, the dialog tells you.

  1. Go to Settings → General and open the Discord section.
  2. Turn on Discord Role Sync Enabled.
  3. Under Discord Role Sync Prefer Discord, choose which side wins:
    • Takaro wins: Takaro roles overwrite Discord roles.
    • Discord wins: Discord roles overwrite Takaro roles.

Only linked roles sync. System roles (root, User, Player) never sync.

For the full setup, see the Discord integration guide.