Setting up a group file

From BZFlagWiki
Jump to: navigation, search

Getting started with group files[edit]

Before one creates a group file, one needs to know what a group file is, and how to use it.

What is a group file?[edit]

The first thing one should clear up is, "what is a global group?".

Simply put, a global group is a group of people that have special permissions. The owner of the group can add or remove people from the group, and then give them special permissions in a group file. These permissions can range anywhere from being able to speak, to all administrator permissions.

Request A Group[edit]

In order to use global groups, one obviously needs a group to add people to. one can request them here on BZBB. Please follow the current naming convention when asking for a group, which works like this: organization.level. For example, if one wants a server called "BZFlagserver", and would like to have cop, admin, and trustedadmin groups, the names of those groups would be BZFLAGSERVER.COP, BZFLAGSERVER.ADMIN, and BZFLAGSERVER.TRUSTEDADMIN.

Possible Permissions[edit]

To give people permissions, one first needs to know which are available. A list of possible permissions are available on the Server Permissions page. One should read through that page, and familiarize oneself with the group permissions, as it will come in handy later.

How does one add people to ones group?[edit]

Once one has had ones group created, one needs to add people to it. This can be done by going to the "User Control Panel" link on BZBB. From there, one must click on "Usergroups" tab, and then click on the side item labeled "Manage groups". This will show all of the groups that one is a leader of. One must click on "Manage users" next to the group one wishes to manage.

It will then list all of the users that are currently in the group. There may be several pages of users depending on how many members exist. One can remove members by placing clicking the check by their name, then selecting "Remove member from group", and clicking "Submit".

To add members to ones group, one must type their names (one per line) in the box at the bottom of the page and click "Submit". If one is unsure of their exact name, one can use the "Find a member" link.

Configuring a server to use groups[edit]

Giving ones groups different permissions[edit]

Once the group files have been created, and one has added people to them, they can now be used on a server.

This is done through the use of a group file, which is a text file. A group file lists the groups one can use at ones server, and their Server Permissions. Here is a sample group file:

EXAMPLE.LEAGUE: talk spawn clientquery adminmessagesend actionmessage poll vote
EXAMPLE.ADMIN: talk spawn clientquery adminmessagesend adminmessagerecieve ban kick antiban antikick actionmessage poll vote
EXAMPLE-LEAGUE.ADMIN: *EXAMPLE.ADMIN

Here's a quick explanation of what these lines do.

EXAMPLE.LEAGUE: talk spawn clientquery adminmessagesend actionmessage poll vote

This allows everyone in the EXAMPLE.LEAGUE group to be able to talk, spawn, use the clientquery command, send admin messages, use /me, to poll, and to vote.

EXAMPLE-LEAGUE.ADMIN: *EXAMPLE.ADMIN

This gives everyone in EXAMPLE-LEAGUE.ADMIN the same permissions as EXAMPLE.ADMIN.

Once one has created ones group file, save it. Remember where the group file is located, since one will need it later.

Making the server use the group file[edit]

One obviously needs to reference to the group file somewhere. This is done through the conf, or configuration file that one uses to run ones server. Open up the conf, and add a line like this, to make the server use the group file:

-groupdb /the/path/to/the/groupfile.txt

The groupfile can have whatever extension one wants, one must just make sure that one has the complete path specified after -groupdb. If there are spaces in the path, it is best to surround it with quotes.

Testing ones groups[edit]

To make sure everything is working properly, one must log into ones server and run the command /groupperms. It will list all the groups, and their permissions currently in use.

Updating group permissions[edit]

If one wants to change the group permissions without restating ones server, ones can simply add the wanted permissions to the group file, save it, and then run a /reload at the server. All group permissions will be reloaded.

See also[edit]