GSRI Zeus Manager

What is GSRI Zeus Manager

GZM is an addon providing a set of functions allowing to handle who may become Zeus on your server.

With GZM enabled, you can simply stop thinking about placing game master modules in your missions. Authorization is handled at server level instead of mission, and can be updated live without the need for a mission restart.

• No more copy/paste a pile of curator modules with players id as owners when creating a mission
• No more mission modification + upload + restart to add/revoke a player's Zeus access
• No more grant/revoke server admin privileges to zeuses when relying on #adminLogged

See How to use this addon to get a full description of the features.

Rules and standards

The following documents provide additional information on rules and standards applying to this project :

• MIT license
• GSRI code of conduct
• GSRI standard contribution guide

GZM is also available on :

• Steam Workshop
• Official BI Forums

Credits

This project has been entirely developped from scratch by [-GSRI-] Cheitan. If you are willing to submit your modification of the tool as a pull-request, we will be glad to mention your name and work in this section.

How to use this addon

Requirements

GZM requires CBA to run. Do not forget to install both mods on your clients and server as well. GZM is interacted with in-game's text chat, which is only available in multiplayer games. This means GZM cannot be used in single-player scenarios.

Features

GZM stores a whitelist of players allowed to become curators on the server. The whitelist is stored in the server profile and is persisted accross missions and server restart. The authorization process is handled at server level, which means that any whitelisted player may become a curator on any mission run on this server. The stored data in the whitelist is, for each authorized player, his·her steamID (see getPlayerUID) and a nickname in order to ease whitelist's reviewing and revoking process.

When an authorized player request Zeus privileges, a custom Game Master module is created and linked. This means that you may still rely on manually placed modules with player ID, slot name, and/or #adminLogged features in parallel : GZM will ignore third party modules.

Usage

The addon uses in-game chat commands to manage both the whitelist and curator slots assignment:

• #gzm help lists all commands and usage
• #gzm whitelist lists all players in the curator whitelist
• #gzm promote <nickname> <steamID> adds a player's steamID to the curator whitelist under the provided nickname.
• #gzm revoke <nickname> removes an authorized steamID from the curator whitelist based on the provided nickname.
• #gzm [request|release] assigns to or unassigns yourself from a curator slot

Zeus players

First, ask a server administrator to promote you. Once promoted, you may use #gzm request to become a curator on the mission.

If you don't need the curator slot anymore, you can #gzm release your slot.

Mission editors

There is nothing to do ! GZM rely on server's profileNamespace, which means any mission run on an already-configured server will benefit from it.

If you want to use GZM when testing your mission, remember it uses game chat, which is only available in multiplayer mode. You will consequently need to preview in multiplayer.

Server owners / admins

Logged admins are the only players allowed to modify the curators whitelist using #gzm promote and #gzm revoke commands. Being a logged admin does not grant privilege to become curator by itself, you must add yourself to the whitelist.

To allow players to become logged admins on your server, add their player id to the admins property of your server.cfg file. All players in this list may become logged admins using the #login command in the chat. Only add trustworthy people to this list, as logged admins can harm your server: #lock, #kick, #shutdown ...

Sharing profile with multiple server instances is not supported because BI does not provide a command to reload the profile files. Using the same profile would provoke confusion and data loss on the whitelist. If you have multiple servers, you have to manage a separate profile and whitelist on each server.

Security notes: You could also rely on passwordAdmin instead of admins though this is not recommended: passwords are way easier to steal than steam accounts. We also strongly recommend players with admin privileges on any server to enable Steam Guard two-factor authentication on their account to prevent unauthorized access.

How to get help

You can ask for support on our discord server