View source for ANEURISM IV/Server administration

{{ANEURISMNav}}

Join your server with its owner account to assign staff and manage access. Open the in-game console with the backquote key (<code>`</code>) or your chosen '''Console''' binding, then enter <code>help</code> to list commands.

The dedicated server's terminal and system journal contain logs. Run the commands below from a connected game client.

== Owner and staff ==

The first host of a new world becomes its owner. A dedicated server takes that account from <code>ANIV_COMMUNITY_OWNER_STEAM_ID</code>. Ownership is saved in <code>aniv.db</code> and can't be assigned with <code>setrank</code>.

{| class="wikitable"
! Role !! Access
|-
| <code>community.owner</code> || Full server administration, including staff assignments.
|-
| <code>community.admin</code> || Server management and moderation. Cannot assign ranks.
|-
| <code>community.moderator</code> || Admin tools for kicking, banning, announcements, and teleporting players.
|-
| <code>community.vip</code> || Reserved-slot access. No staff commands.
|-
| <code>community.user</code> || Ordinary player access. This is the default role.
|}

Staff can act only on players below their own authority. They can't moderate themselves or another staff member of equal authority. Nexus staff ranks don't grant local server powers.

== Assign or remove a rank ==

As the owner, run:

<syntaxhighlight lang="text">
setrank <player|steam-id> <community.admin|community.moderator|community.vip|community.user>
</syntaxhighlight>

Replace the bracketed arguments with the player and role. A SteamID64 also works when the player is offline. Assign <code>community.user</code> to remove a staff or VIP role.

== Bans ==

<syntaxhighlight lang="text">
ban <player|steam-id> [permanent|30m|12h|7d|4w] [reason]
unban <player|steam-id>
</syntaxhighlight>

The duration is optional; omitting it makes the ban permanent. Durations use <code>m</code> for minutes, <code>h</code> for hours, <code>d</code> for days, and <code>w</code> for weeks. The values above are examples. Banning a connected player also disconnects them.

A local unban removes your server's ban. Nexus bans are checked separately. If a player still can't join after an unban, read the rejection message before changing other settings.

== Whitelist ==

<syntaxhighlight lang="text">
whitelist add <player|steam-id>
whitelist remove <player|steam-id>
printwhitelist
</syntaxhighlight>

Use a password for private hosting in this version. The whitelist also checks staff on reconnect, but the command won't let you add yourself or the owner. Enabling it can prevent you from rejoining your own server.

An empty whitelist allows ordinary admission. Adding the first entry enables the whitelist; removing the last entry disables it. If you've enabled it during a session, remove its entries before disconnecting. Ban and password checks still apply.

Owners and administrators can change entries for players below their authority. See [[ANEURISM IV/Troubleshooting#A player cannot join|A player cannot join]] if a whitelist change has an unexpected result.

== Password ==

<syntaxhighlight lang="text">
password [new-password]
</syntaxhighlight>

With a value, this changes the password for new joins. With no value, it removes the current password. Passwords can contain up to 64 characters and must not contain line breaks or control characters.

The console omits password values from its history and audit output. For a dedicated server, also edit <code>ANIV_SERVER_PASSWORD</code> in <code>server.env</code> if you want the change to survive a restart. An in-game host must enter the password when starting the next session.

== Keep administration data ==

Ranks, bans, ownership, and whitelist entries are stored in <code>aniv.db</code>. They survive restarts and gameplay world wipes. Back up the [[ANEURISM IV/Backups and updates|whole data directory]] to keep them with the world.

[[Category:ANEURISM IV]]