NameLayer: Difference between revisions
link civ
Squareblob (talk | contribs) (Redirected page to Comprehensive Guide:Protection#Namelayer) Tag: New redirect |
(link civ) |
||
| (47 intermediate revisions by 3 users not shown) | |||
Line 1:
[[File:Namelayer Main GUI Example.png|thumb|250px|The overview screen in the in-game NameLayer interface, as shown by <code>[[NameLayer#Interface|/nl]]</code>. Each chestplate is a group, and the material is the player's rank in that group.]]
{{Mechanics series}}
'''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, [[Snitch|snitches]] and [[Bastion|bastions]] will not affect players on their group, and [[Item Exchange|item exchanges]] can be locked to a specific group. Groups can also be used to send chat messages visible [[Chat|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.
{| class="wikitable"
|+Base Namelayer Permissions
!Permission
!Description
|-
|<code>LIST_PERMS</code>
|Allows seeing how the permissions are set up for the group
|-
|<code>GROUPSTATS</code>
|Gives access to various group statistics such as member counts by permission type, who owns the group etc
|-
|<code>OPEN_GUI</code>
|Allows opening the GUI for this group
|-
|<code>JOIN_PASSWORD</code>
|perm level given to members when they join with a password
|-
|<code>MEMBERS</code>
|Allows inviting new members and removing existing members
|-
|<code>MODS</code>
|Allows inviting/promoting new members and removing existing mods
|-
|<code>ADMINS</code>
|Allows inviting/promoting new members and removing existing admins
|-
|<code>OWNER</code>
|Allows inviting/promoting new members and removing existing owners
|-
|<code>BLACKLIST</code>
|Allows viewing this groups blacklist, adding players to the blacklist and removing players from the blacklist
|-
|<code>PASSWORD</code>
|Allows viewing this groups password and changing or removing it");
|-
|<code>PERMS</code>
|Allows modifying permissions for this group
|-
|<code>DELETE</code>
|Allows deleting this group
|-
|<code>LINKING</code>
|(on servers that support it) Allows linking this group to another group as a supergroup or a subgroup
|-
|<code>MERGE</code>
|(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.
{| class="wikitable"
|+Additional Namelayer Permissions
!Provided By
!Permission
!Description
|-
! rowspan="5" |[[Bastion]]
|<code>BASTION_PEARL</code>
|Can pearl into bastion fields
|-
|<code>BASTION_ALLOW_EXILED</code>
|Allows exiles inside bastion range
|-
|<code>BASTION_PLACE</code>
|Can place in bastion ranges reinforced to group
|-
|<code>BASTION_LIST</code>
|Can list bastions on group (/bsl)
|-
|<code>BASTION_MANAGE_GROUPS</code>
|
|-
! rowspan="8" |[[Citadel]]
|<code>DOORS</code>
|Can open and close reinforced doors
|-
|<code>ACIDBLOCK</code>
|Can place acidblocks reinforced to group (/ctacid)
|-
|<code>CROPS</code>
|Can place and destroy crops
|-
|<code>INSECURE_REINFORCMENT</code>
|Can use hoppers to take items out of reinforced containers /ctinsecure
|-
|<code>REINFORCEMENT_INFO</code>
|Can use /cti and see group block reinforced to
|-
|<code>BYPASS_REINFORCEMENT</code>
|Can use /ctb and break reinforcement, returning reinforcement item
|-
|<code>REINFORCE</code>
|Can /ctf, /ctb blocks
|-
|<code>CHESTS</code>
|Can use chests
|-
! rowspan="2" |[[Factory|FactoryMod]]
|<code>UPGRADE_FACTORY</code>
|Can upgrade factories
|-
|<code>USE_FACTORY</code>
|Can use factory reinforced to group
|-
! rowspan="8" |[[Snitch]]
|<code>CLEAR_SNITCHLOG</code>
|Can clear snitchlog with /jaclear
|-
|<code>SNITCH_NOTIFICATIONS</code>
|Can see chat messageswhen players trigger snitches
|-
|<code>SNITCH_IMMUNE</code>
|Will no longer cause snitch alerts when in range of snitches on group.
|-
|<code>READ_SNITCHLOG</code>
|Can check snitchlogs with /ja
|-
|<code>SNITCH_TOGGLE_LEVER</code>
|Can do /jaToggleLevers 1 to allow snitchs triggering redstone
|-
|<code>LIST_SNITCHES</code>
|can /jalist to see all snitches on group
|-
|<code>LOOKUP_SNITCH</code>
|Can /jalookup a snitch giving coords
|-
|<code>RENAME_SNITCH
|Can rename snitches</code>
|-
! rowspan="2" |[[Chat]]
|<code>READ_CHAT</code>
|Can read chat messages sent in group
|-
|<code>WRITE_CHAT</code>
|Can type messages in group
|-
![[Kira]]
|<code>KIRA_MANAGE_CHANNEL</code>
|Can setup Kira relays on discord to relay group messages and alerts
|}
== Special groups ==
=== Personal group ===
Each player is automatically given a ''personal group'' upon joining the server for the first time, whose name is the same as the player. A personal group is no different from a normal group, except that it is automatically created for players.
By default, a player's personal group is also their default group.
=== Default group ===
Each player has a ''default group'', which is the group used by commands when no group is specified. This is the player's personal group by default, but can be changed with the <code>/nlsdg</code> command, or from [[NameLayer#Interface|the interface]].
=== Global group ===
A ''global group'' is a group intended to provide a global chat, effectively bypassing the [[Chat|distance restriction of chat messages]]. This group is usually called <code>!</code> or <code>g</code>.
The concept of a global group was first introduced in [[Devoted]], where the global group was player-owned and managed, requiring players to join with a publicly shared password. On [[CivClassic]] and proceeding mainline server, global chat was cemented as a gameplay mechanic, with the group being owned by the server and players automatically added to it when they first join.
== Interface ==
[[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.
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 the player's [[NameLayer#Default group|default group]].
The first <code>/nl</code> 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.
== Command Reference ==
{|class="wikitable"
|+ class="nowrap" |
!Category
! width="30%" | Command
!width="70%"| Description
!Alias
|-
! rowspan="2" |Info
|<code>/help namelayer [page]</code>
|Lists all NameLayer commands.
|{{n/a}}
|-
|<code>[[NameLayer#Interface|/nl]]</code>
|Brings up the in-game NameLayer interface.
|{{n/a}}
|-
! rowspan="9" |Personal
| <code>/nllg</code>
|Lists all groups the player is in.
|<code>/listgroups</code><br><code>/groups</code>
|-
|<code>/nljg <group> <password></code>
|Joins a group. Only groups with a password can be joined with this command.
|<code>/joingroup</code>
|-
|<code>/nlleg <group></code>
|Leaves a group.
|<code>/leave</code><br><code>/leavegroup</code>
|-
|<code>/nlgdg</code>
|Gets the player's [[#Default group|default group]].
|{{n/a}}
|-
|<code>/nlsdg <group></code>
|Sets the player's [[#Default group|default group]].
|{{n/a}}
|-
|<code>/nllci</code>
|Lists the player's pending invititations.
|<code>/invites</code><br><code>/listinvites</code>
|-
|<code>/nlag <group></code>
|Accepts a pending invitation to a group.
|<code>/join</code><br><code>/accept</code><br><code>/acceptgroup</code><br><code>/acceptinvite</code>
|-
|<code>/nlrg <group></code>
|Rejects a pending invitation to a group.
|<code>/reject</code><br><code>/rejectinvite</code>
|-
|<code>/nltaai</code>
|Toggles the auto-acceptance of group invitations.
|<code>/autoaccept</code>
|-
! rowspan="14" |Management
| <code>/nlcg <group> [password]</code>
| Creates a group. If <code>[password]</code> is not supplied, only players with an invitiation can join.
|<code>/create</code><br><code>/creategroup</code>
|-
|<code>/nlip <group> <player> [rank]</code>
|Invites a player to a group. <code>[rank]</code> defaults to member.
|<code>/invite</code><br><code>/inviteplayer</code>
|-
|<code>/nlri <group> <player></code>
|Revokes an invitation of a player to a group.
|<code>/revoke</code><br><code>/revokeinvite</code>
|-
| <code>/nlrm <group> <member></code>
| Removes a member from a group.
|<code>/remove</code><br><code>/removeplayer</code>
|-
| <code>/nlbl <group> <player></code>
| Adds a player to the blacklist for a group.
|<code>/blacklist</code>
|-
| <code>/nlubl <group> <player></code>
| Removes a player from the blacklist for a group.
|<code>/unblacklist</code>
|-
| <code>/nlsbl <group></code>
| Lists blacklisted players for a group.
|<code>/showblacklist</code>
|-
| <code><nowiki>/nlmp <group> <add|remove> <rank> <permission></nowiki></code>
| Adds or removes a permission from a rank in a group.
|<code>/modifyperms</code>
|-
|<code>/nllp <group> <rank></code>
|Lists permissions of a rank in a group.
|<code>/permissions</code>
|-
| <code>/nlpp <group> <player> <rank></code>
| Sets the rank of a player in a group.
|<code>/promote</code><br><code>/promoteplayer</code>
|-
| <code>/nllm <group> [rank]</code><br>
| Lists all members of a group. If <code>[rank]</code> is supplied, lists only members with that rank.
|<code>/members</code><br><code>/listmembers</code>
|-
| <code>/nlsp <group> <password></code>
| Adds a password to an existing group.
|<code>/setpassword</code>
|-
| <code>/nltg <group> <player></code>
| Transfers primary ownership of a group to another player.
|<code>/transfer</code><br><code>/transfergroup</code>
|-
| <code>/nldg <group></code>
| Deletes a group.
|<code>/delete</code><br><code>/deletegroup</code>
|}
{{Template:Mechanics}}
| |||