NameLayer: Difference between revisions

link civ
(moar code blocks)
(link civ)
 
(25 intermediate revisions by 2 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.]]
'''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.
{{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]].
Line 14 ⟶ 16:
=== Permissions ===
Each rank comes with a default set of permissions. The permissions each rank grants can be modified for a particular group.
{| class="wikitable mw-collapsible"
|+Base Namelayer Permissions
!Permission
Line 61 ⟶ 63:
|(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 civparticular server includes.
{| class="wikitable mw-collapsible"
|+Additional Namelayer Permissions
!Provided By
Line 68 ⟶ 70:
!Description
|-
|! rowspan="5" |[[Bastion]]
|<code>BASTION_PEARL</code>
|Can pearl into bastion fields
Line 84 ⟶ 86:
|
|-
|! rowspan="8" |[[Citadel]]
|<code>DOORS</code>
|Can open and close reinforced doors
Line 109 ⟶ 111:
|Can use chests
|-
|! rowspan="2" |[[Factory|FactoryMod]]
|<code>UPGRADE_FACTORY</code>
|Can upgrade factories
Line 116 ⟶ 118:
|Can use factory reinforced to group
|-
|! rowspan="8" |[[Snitch]]
|<code>CLEAR_SNITCHLOG</code>
|Can clear snitchlog with /jaclear
Line 141 ⟶ 143:
|Can rename snitches</code>
|-
|! rowspan="2" |[[Chat]]
|<code>READ_CHAT</code>
|Can read chat messages sent in group
Line 148 ⟶ 150:
|Can type messages in group
|-
|![[Kira]]
|<code>KIRA_MANAGE_CHANNEL</code>
|Can setup Kira relays on discord to relay group messages and alerts
|}
 
== InterfaceSpecial groups ==
 
=== Personal group ===
NameLayer can be used entirely via commands, but there is an in-game interface which may be easier to use. use the <code>/nl</code> command to bring up the interface.
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.
[[File:Namelayer Main GUI Example.png|thumb|250px|The NameLayer interface as it appears in-game.]]
 
=== Default group ===
The first screen of the interface shows rows of chestplates. Each chestplate corresponds to a Namelayer group, and the type of chestplate shows your permission level. 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.
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]].
 
=== UniqueGlobal Usernamesgroup ===
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.
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.
 
== Interface ==
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.
[[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 ==
Line 171 ⟶ 184:
{|class="wikitable"
|+ class="nowrap" |
!Category
!width="30%"| Command
! width="30%" | Command
!width="70%"| Description
!Alias
|-
! rowspan="2" |Info
| <code>nlcg <group> [password]</code>
|<code>/help namelayer [page]</code>
| Creates a group, optionally with password
|Lists all NameLayer commands.
|{{n/a}}
|-
| <code>nlsp <group> <password>[[NameLayer#Interface|/nl]]</code>
|Brings up the in-game NameLayer interface.
| Adds password to an existing group
|{{n/a}}
|-
! rowspan="9" |Personal
| <code>nljg <group> <password></code>
| <code>/nllg</code>
| Joins a password protected group
|Lists all groups the player is in.
|<code>/listgroups</code><br><code>/groups</code>
|-
| <code>nlag/nljg <group> <password></code>
|Joins a group. Only groups with a password can be joined with this command.
| Accepts an invitation to a group
|<code>/joingroup</code>
|-
| <code>nlbl/nlleg <group> <player></code>
| Blacklists a player inLeaves a group.
|<code>/leave</code><br><code>/leavegroup</code>
|-
| <code>nldg <group>/nlgdg</code>
|Gets the player's [[#Default group|default group]].
| Deletes a group
|{{n/a}}
|-
| <code>nlip/nlsdg <group> <player> (PlayerType- default MEMBERS)</code>
|Sets Invitesthe player's to[[#Default agroup|default group with optional rank]].
|{{n/a}}
|-
| <code>nlleg <group>/nllci</code>
|Lists the player's pending invititations.
| Leaves a group
|<code>/invites</code><br><code>/listinvites</code>
|-
| <code>nllink/nlag <super group> <\sub group></code>
|Accepts a pending invitation to a group.
| Links two groups to each other as nested groups. (unsupported)
|<code>/join</code><br><code>/accept</code><br><code>/acceptgroup</code><br><code>/acceptinvite</code>
|-
| <code>nlmg/nlrg <The group left> <The group that will be gone></code>
|Rejects a pending invitation to a group.
| Merges two groups together. (Warning : Doing this is not recommended and may eventually cause groups to break)
|<code>/reject</code><br><code>/rejectinvite</code>
|-
| <code>nlmp <group> <add/remove> <PlayerType> <PermissionType>nltaai</code>
|ModifiesToggles the permissionsauto-acceptance of agroup groupinvitations.
|<code>/autoaccept</code>
|-
! rowspan="14" |Management
| <code>nlpp <group> <player> <playertype></code>
| <code>/nlcg <group> [password]</code>
|Promotes/Demotes a Player in a group
| 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>nlrg/nlip <group> <player> [rank]</code>
|Invites a player to a group. <code>[rank]</code> defaults to member.
| Rejects an invitation to a group.
|<code>/invite</code><br><code>/inviteplayer</code>
|-
| <code>nlubl/nlri <group> <player></code>
|Revokes Removesan invitation of a player from the blacklist forto 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>nlri/nlbl <group> <player></code>
| Adds a player to the blacklist for a group.
| Revokes an invite
|<code>/blacklist</code>
|-
| <code>nlsdg <group></code>
| Sets or changes default group
|-
| <code>nltaai</code>
|Toggles the auto-acceptance of invites
|-
| <code>nltg <group> <player></code>
| Transfers a group to another owner
|-
| <code>nlunlink </super group> </sub group></code>
|Unlinks two groups from each other. [Unsupported]
|-
| <code>nlun [CONFIRM]</code>
| Updates account name on the server to the one minecraft account currently has [Unsupported]
|-
| <code>nllg/nlubl <group> <player></code>
| ListsRemoves all groupsa player isfrom in.the Formattedblacklist "<group>for :a <permission level>"group.
|<code>/unblacklist</code>
|-
| <code>nlgdg/nlsbl <group></code>
| GetsLists defaultblacklisted players for a group.
|<code>/showblacklist</code>
|-
| <code><nowiki>/nlmp <group> <add|remove> <rank> <permission></nowiki></code>
| <code>nlgls</code>
| Adds or removes a permission from a rank in a group.
|Gets the amount of groups on server
|<code>/modifyperms</code>
|-
| <code>nlgs/nllp <group> <rank></code>
|Lists permissions of a rank in a group.
| Get stats about a group. (Total members and list of members)
|<code>/permissions</code>
|-
| <code>nlid/nlpp <group> <player> <rank></code>
| InfodumpSets includingthe listrank of membersa for each role levelplayer in eacha group.
|<code>/promote</code><br><code>/promoteplayer</code>
|-
| <code>nllci/nllm <group> [rank]</code><br>
| Lists all members of a group. If <code>[rank]</code> is supplied, lists only members with that rank.
| Lists players current active invites.
|<code>/members</code><br><code>/listmembers</code>
|-
| <code>nllm/nlsp <group> (PlayerType)<password></code>
| ListAdds thea playerspassword withto selectedan role in aexisting group.
|<code>/setpassword</code>
|-
| <code>nllp/nltg <group> <PlayerTypeplayer> </code>
| Transfers primary ownership of a group to another player.
| Shows permissions for a PlayerType in a group.
|<code>/transfer</code><br><code>/transfergroup</code>
|-
| <code>nlsbl/nldg <group></code>
|Shows all blacklisted players forDeletes a group.
|<code>/delete</code><br><code>/deletegroup</code>
|}
 
2,232

edits