Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Table of Contents
- Creating Groups
- Listing Groups
- Ranks or PlayerTypes
- Inviting People to a Group
- Transferring a Group
- Removing People from a Group
- Listing People in a Group
- Merging Groups
- Disabling or Deleting Groups
- Linking and Unlinking Groups
- Setting or Changing Default Group
- List of Commands
/nlcg group-name to create a group that you can add reinforcements. Creating the group makes you the group owner.
/nlcg group-name to create a group that you can add reinforcements to that is also private. A private group means that only members of the group can access it. Creating the group makes you the group owner.
Note: By default,
/nlcgwill create a private group unless otherwise specified.
Private groups restrict access to those who are members of the group and have the permissions for them.
All the above is all fine and dandy, but what if you want to make a mailbox?
The mailbox needs to be reinforced so a griefer can't break it easily, but publicly accessible. Adding everyone in the city to my personal mailbox group is too cumbersome. The solution is publicly reinforce it.
/nlcg group-name public to create a public group. This will allow anyone to access the container while not allowing them to bypass reinforcements if they try to break the container.
Password Protected Groups
Though restricting access through a private group is safer, it may not always be very convenient. An alternative is to make a create private group with a password. Instead of manually adding people to the group, you give your friend a password and they add themselves to the group.
/nlcg group-name private password123 to create a group with a password
If you already have a private group and would like to add a password to it, use
/nlsp <group> <password>.
Note: Password groups are very insecure, but work great with ItemExchange. Using ItemExhange, you can setup shops with that offer reduced prices for people in a group. You can use the group password as a promotion code so that those interested can enjoy a reduced price, while you enjoy increased business. TODO: Explain how to do this. Jawa is a jerk.
Joining Passworded Groups
/nlj group-name password123 to join a passworded group.
You can list your groups with
OP, or console can run this command
/nllg <playername> to list the groups for that player, it will give all groups in one command
Nested groups can be listed in an indented hierarchy using
/nllsg [group]. If no group is passed to the command, then all your groups will be listed. If a group is passed, then the hierarchy for just that group will be listed.
Ranks or PlayerTypes
PlayerTypes are the ranks in a citadel group. Owner is the highest rank and member the lowest. Owners have all permissions and can always edit permissions for other groups (even if they try to remove perms permission from owners).
- Owner - DOORS, CHESTS, BLOCKS, ADMINS, MODS, MEMBERS, PASSWORD, SUBGROUP, PERMS, DELETE, MERGE LIST_PERMS, TRANSFER, CROPS, GROUPSTATS, LINKING
- Admins - DOORS CHESTS BLOCKS MODS MEMBERS PASSWORD LIST_PERMS CROPS GROUPSTATS
- Moderators - DOORS CHESTS BLOCKS MEMBERS CROPS
- Members - DOORS CHESTS
|DOORS||Can open and close reinforced doors|
|CHESTS||Can open and close reinforced chests|
|BLOCKS||Can reinforce blocks to the group or bypass existing reinforced blocks|
|ADMINS||Can add or remove admins|
|MODS||Can add or remove mods|
|MEMBERS||Can add or remove members|
|PASSWORD||Can add or remove password to the group|
|SUBGROUP||Can add subgroup|
|PERMS||Warning: Can modify the permissions a PlayerType has|
|DELETE||Can delete the group|
|JOIN_PASSWORD||Can specify which PlayerType a player will be, when they join with a password|
|MERGE||Can merge groups with another group they have MERGE permissions on|
|LIST_PERMS||Can list the permissions of any PlayerType|
|TRANSFER||Can transfer the group from one OWNER to another person. Does not affect other owners on the group|
|CROPS||Allows access to reinforced crops|
|GROUPSTATS||Allows access to use GroupStats Command|
|LINKING||Can nest and un-nest the group|
Note: An owner can always edit permissions, even if they remove perms permission for playertype owners.
Editing PlayerType Permissions
You can list the permissions of a PlayerType with
To add a permission to a PlayerType type
/nlmp group-name add PlayerType permission-name.
You can also remove a permission from a PlayerType with
/nlmp group-name remove PlayerType permission-name.
Example: `/nlmp Dr_Jawa_Farm add members crops
This will allow members on the group to harvest crops that are reinforced to this group.
Inviting People to a Group
In order to add someone to a group you must invite them and specify their rank/permission level (member, mod, admin, or owner).
/nlip group-name player-name player-type to invite someone to the group.
Revoking an Invitation
/nlri group-name player-name to revoke someone's invitation.
Joining a Group
The invited player will have to type
/nlag group-name to accept the invitation.
Leaving a Group
/nlleg group-name to leave the group.
Promoting Demoting a Player
/nlpp group-name player-name player-type
Transferring a Group
If you own a group and would like to transfer ownership type
/nltg group-name player-name and it will transfer your ownership to that person. If there are multiple owners, then the other owners will not be affected.
Removing People from a Group
/nlrm group-name player-name to remove someone from the group.
Listing People in a Group
You can list the people in a group with
/nllm group-name or you could can show a specific player type with
/nllm group-name player-type. This will list all members including those inherited from super-groups. To list the people in the group excluding inherited members, use
Valid PlayerTypes: members, mods, admins, owners
If you have multiple groups you would like to merge than you can do so with
/nlmg group-one group-to-merge-into-group-one.
Disabling or Deleting Groups
If you would like to temporarily disable a group, then type
/nldig group-name. To enable the group again, type
/nldig group-name to toggle it. Any reinforcements on this group will be inaccessible until the group is enabled. This is an admin command only.
If you would like to delete a group then type
/nldg group-name. The group's reinforcement will stay on the map but no one will be able to access them.
Warning: Any reinforcements made on a deleted group will be inaccessible once the group is deleted. Use with caution.
Linking and Unlinking Groups
Groups can be nested using the
/nllink <super-group> <sub-group> command, and then un-nested using
/unlink <super-group> <sub-group>. Sub-groups will inherit all of the members from the super-group, meaning all of the super-group members can access the sub-group as if it were an extension of the super-group. However, upon unlinking the members from the super-group will be removed and the sub-group members will go back to how they were. A group may have only one super-group, but can have many sub-groups.
For player-type ranks, the higher ranks will override lower ranks in the inheritance chain. For instance, if Player1 is mod in a GroupA and a member in GroupB, then making GroupA the super-group of GroupB mean that Player1 becomes a mod in GroupB. However, if GroupB is the super-group GroupA instead, then his player-type in these two groups does not change.
Setting or Changing Default Group
If you want to set a default group for using citadel reinforce or fortification mode
Run the command
To change your default group use the same command
To get your current default group use
/nlgdg and it will return your current default group
List of Commands
Note: <> = required,  = optional
|Command and Usage||Description|
||Creates a group, default is private unless public is specified|
||Deletes a group|
||Invite player to the group, default is member unless another rank is specified|
||Revoke Player's invitation to a group|
||Join a password protected group|
||Accept the invite the group|
||Leave a group group|
||Lists nested groups|
||List group types (private and public)|
||List all group invitations|
||Promote/Demote Player's rank within group|
||Remove a player from a group|
||Transfer ownership of a group to a player|
||Add a password to a group|
||Grant a permission to a rank within a group|
||Remove a permission from a rank within a group|
||List the people in a group|
||List the people in a group excluding inherited members|
||List the people in a group for a specific player type|
||List the permissions a rank has within a group|
||Link two groups together|
||Unlink two groups from each other|
||Toggle auto acceptance of invites|
||Set or Change Default Group|
||Returns current default group|