NameLayer

From CivWiki
Revision as of 03:48, 28 October 2023 by Tybug (talk | contribs) (headers)
Jump to navigation Jump to search

NameLayer is a common plugin on civ servers which allows for the creation of shared groups. Any player can create a group, and there is no limit on the number of groups a player can be a member of. Each group has a tiered rank structure, with players having varying level of permissions inside a particular group.

Groups interact closely with Citadel, which allows reinforcing a block to a specific group. The group a block is reinforced to informs several other plugins. For instance, Citadel protections can be bypassed by players on their group, snitches and bastions will not affect players on their group, and item exchanges can be locked to a specific group. Groups can also be used to send chat messages visible only to players on that group.

First introduced in Civcraft, NameLayer has been included in every mainline civ server since.

Mechanics

Rank

Groups come with a set of ranks. A widely used set is primary owner > owner > admin > mod > member, but this is not universal across civ servers. Players cannot create, rename, or move the ranks themselves, but they can assign players to different ranks.

Each group can have only one primary owner, though primary ownership can be transferred by the current primary owner. Other ranks have no limit on the number of players in them.

Permissions

Each rank comes with a default set of permissions. The permissions each rank grants can be modified for a particular group.

Base Namelayer Permissions
Permission Description
LIST_PERMS Allows seeing how the permissions are set up for the group
GROUPSTATS Gives access to various group statistics such as member counts by permission type, who owns the group etc
OPEN_GUI Allows opening the GUI for this group
JOIN_PASSWORD perm level given to members when they join with a password
MEMBERS Allows inviting new members and removing existing members
MODS Allows inviting/promoting new members and removing existing mods
ADMINS Allows inviting/promoting new members and removing existing admins
OWNER Allows inviting/promoting new members and removing existing owners
BLACKLIST Allows viewing this groups blacklist, adding players to the blacklist and removing players from the blacklist
PASSWORD Allows viewing this groups password and changing or removing it");
PERMS Allows modifying permissions for this group
DELETE Allows deleting this group
LINKING (on servers that support it) Allows linking this group to another group as a supergroup or a subgroup
MERGE (on servers that support it) Allows merging this group into another or merging another group into this one

Other plugins can add permissions to groups, which are not a part of the base NameLayer plugin. These permissions act the same as the base permissions in that they can be modified on a per-group basis. The permissions provided by the most common plugins are listed below. Note that there may be permissions in this table which are not present on a civ server, and vice versa, depending on which plugins a particular server includes.

Additional Namelayer Permissions
Provided By Permission Description
Bastion BASTION_PEARL Can pearl into bastion fields
BASTION_ALLOW_EXILED Allows exiles inside bastion range
BASTION_PLACE Can place in bastion ranges reinforced to group
BASTION_LIST Can list bastions on group (/bsl)
BASTION_MANAGE_GROUPS
Citadel DOORS Can open and close reinforced doors
ACIDBLOCK Can place acidblocks reinforced to group (/ctacid)
CROPS Can place and destroy crops
INSECURE_REINFORCMENT Can use hoppers to take items out of reinforced containers /ctinsecure
REINFORCEMENT_INFO Can use /cti and see group block reinforced to
BYPASS_REINFORCEMENT Can use /ctb and break reinforcement, returning reinforcement item
REINFORCE Can /ctf, /ctb blocks
CHESTS Can use chests
FactoryMod UPGRADE_FACTORY Can upgrade factories
USE_FACTORY Can use factory reinforced to group
Snitch CLEAR_SNITCHLOG Can clear snitchlog with /jaclear
SNITCH_NOTIFICATIONS Can see chat messageswhen players trigger snitches
SNITCH_IMMUNE Will no longer cause snitch alerts when in range of snitches on group.
READ_SNITCHLOG Can check snitchlogs with /ja
SNITCH_TOGGLE_LEVER Can do /jaToggleLevers 1 to allow snitchs triggering redstone
LIST_SNITCHES can /jalist to see all snitches on group
LOOKUP_SNITCH Can /jalookup a snitch giving coords
RENAME_SNITCH Can rename snitches
Chat READ_CHAT Can read chat messages sent in group
WRITE_CHAT Can type messages in group
Kira KIRA_MANAGE_CHANNEL Can setup Kira relays on discord to relay group messages and alerts

Interface

While groups can be managed entirely via commands, there is also an in-game interface which can be brought up with the /nl command.

The NameLayer interface as it appears in-game.

The first screen of the interface shows rows of chestplates. Each chestplate corresponds to a group, and the type of chestplate shows your permission level in that group. Leather is member, gold is mod, iron is admin, and diamond is owner or primary owner. The enchanted chestplate shows your default group. Clicking on a chestplate will show more options for that group.

Unique Usernames

Although Minecraft allows updating your account name, NameLayer mechanics rely on a player's username being unique. NameLayer will use whatever username you first log in with. Changing your Minecraft account username will not change it on your NameLayer groups.

If a player logs in with a username which is already in use in a NameLayer group on the server, that player's displayed name will have a "1" appended to it.

Command Reference

Command Description
nlcg <group> [password] Creates a group, optionally with password
nlsp <group> <password> Adds password to an existing group
nljg <group> <password> Joins a password protected group
nlag <group> Accepts an invitation to a group
nlbl <group> <player> Blacklists a player in a group
nldg <group> Deletes a group
nlip <group> <player> (PlayerType- default MEMBERS) Invites player to a group with optional rank
nlleg <group> Leaves a group
nllink <super group> <\sub group> Links two groups to each other as nested groups. (unsupported)
nlmg <The group left> <The group that will be gone> Merges two groups together. (Warning : Doing this is not recommended and may eventually cause groups to break)
nlmp <group> <add/remove> <PlayerType> <PermissionType> Modifies the permissions of a group.
nlpp <group> <player> <playertype> Promotes/Demotes a Player in a group
nlrg <group> Rejects an invitation to a group.
nlubl <group> <player> Removes a player from the blacklist for a group
nlrm <group> <member> Removes a member from a group.
nlri <group> <player> Revokes an invite
nlsdg <group> Sets or changes default group
nltaai Toggles the auto-acceptance of invites
nltg <group> <player> Transfers a group to another owner
nlunlink </super group> Unlinks two groups from each other. [Unsupported]
nlun [CONFIRM] Updates account name on the server to the one minecraft account currently has [Unsupported]
nllg Lists all groups player is in. Formatted "<group> : <permission level>"
nlgdg Gets default group
nlgls Gets the amount of groups on server
nlgs <group> Get stats about a group. (Total members and list of members)
nlid Infodump including list of members for each role level in each group
nllci Lists players current active invites.
nllm <group> (PlayerType) List the players with selected role in a group
nllp <group> <PlayerType> Shows permissions for a PlayerType in a group.
nlsbl <group> Shows all blacklisted players for a group