NameLayer: Difference between revisions

From CivWiki
Jump to navigation Jump to search
Content added Content deleted
(add interface image)
(reword caption)
Line 154: Line 154:


== Interface ==
== Interface ==
[[File:Namelayer group management.png|thumb|The group screen in the <code>/nl</code> interface. Each chestplate is a member of the group, and the chestplate material is that member's rank in the group. Various group management and display options are shown in the top and bottom rows respectively.]]
[[File:Namelayer group management.png|thumb|The group screen in the <code>/nl</code> interface. Each chestplate is a member of the group, with rank shown by the chestplate's material. Various group management and display options are shown in the top and bottom rows respectively.]]
While groups can be managed entirely via commands, there is also an in-game interface which can be brought up with the <code>/nl</code> command.
While groups can be managed entirely via commands, there is also an in-game interface which can be brought up with the <code>/nl</code> command.



Revision as of 20:22, 29 October 2023

The overview screen in the in-game NameLayer interface, as shown by /nl. Each chestplate is a group, and the material is the player's rank in that group.

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

The group screen in the /nl interface. Each chestplate is a member of the group, with rank shown by the chestplate's material. Various group management and display options are shown in the top and bottom rows respectively.

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

In this interface, the material of a chestplate correspond to a player's rank in a group. Leather is member, gold is mod, iron is admin, and diamond is owner or primary owner. An enchanted chestplate denotes that group as the player's default group.

The first /nl screen is the overview screen, which shows all groups the player is a member of. Chestplate material denotes the player's rank in that group. Clicking on a chestplate will bring up the group screen.

The group screen shows all members of that group and their respective ranks.

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

Category Command Description
Info /help namelayer [page] Lists all NameLayer commands.
/nl Brings up the in-game NameLayer interface.
Personal /nllg Lists all groups the player is in.
/nljg <group> <password> Joins a group. Only groups with a password can be joined with this command.
/nlleg <group> Leaves a group.
/nlgdg Gets the player's default group.
/nlsdg <group> Sets the player's default group.
/nllci Lists the player's pending invititations.
/nlag <group> Accepts a pending invitation to a group.
/nlrg <group> Rejects a pending invitation to a group.
/nltaai Toggles the auto-acceptance of group invitations.
Management /nlcg <group> [password] Creates a group. If [password] is not supplied, only players with an invitiation can join.
/nlip <group> <player> [rank] Invites player to a group. [rank] defaults to member.
/nlri <group> <player> Revokes an invitation of a player to a group.
/nlrm <group> <member> Removes a member from a group.
/nlbl <group> <player> Adds a player to the blacklist for a group.
/nlubl <group> <player> Removes a player from the blacklist for a group.
/nlsbl <group> Lists blacklisted players for a group.
/nlmp <group> <add|remove> <rank> <permission> Adds or removes a permission from a rank in a group.
/nllp <group> <rank> Lists permissions of a rank in a group.
/nlpp <group> <player> <rank> Sets the rank of a player in a group.
/nllm <group> [rank] Lists all members of a group. If [rank] is supplied, lists only members with that rank.
/nlsp <group> <password> Adds a password to an existing group.
/nltg <group> <player> Transfers primary ownership of a group to another player.
/nldg <group> Deletes a group.