CivWiki

NameLayer: Difference between revisions

Page Discussion

NameLayer (view source)

Revision as of 15:34, 25 October 2023

311 bytes removed ,  6 months ago
rewrite namelayer page
VisualWikitext
(rewrite namelayer page)
Line 1:
'''NameLayer''' is a common plugin on civ servers which allows for the creation of shared '''groups'''. Any player can create a group, and any player can be a member of as many groups as they want. Each group has a tiered rank structure, with players having varying level of permissions inside a particular group.
'''NameLayer''' ('''NL''') is an [https://github.com/CivMC/NameLayer open source] plugin which manages the creation of '''NameLayer Groups''', or simply '''groups'''. In conjunction with other plugins, Namelayer groups allow sharing [[reinforcements]] (and reinforced [[factories]]), [[bastions]], [[snitches]], group restricted [[Item Exchange|item exchange]]s and sending [[Chat|shared chat messsages]]. Members of a group are assigned one of four different ranks: member, mod, admin, or owner. Additionally, players can be blacklisted from groups.
== Rank ==
 
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 [[Chat|only certain players can see]].
Namelayer groups has four different ranks that members are be assigned to: member, mod, admin, and owner. There is also the primary owner role, which can only be held by one member at a time.
== Mechanics ==
 
=== Rank ===
Each rank guarantees a set of permissions for assigned players. By default higher ranks have more permissions but this can be altered. Additionally permissions may be guaranteed to all non-blacklisted players. Those with the appropriate permission and the primary owner may also alter which permissions are assigned to each rank through either the [[NameLayer#GUI|NameLayer GUI]] or the <code>/nlmp</code> command
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.
== GUI ==
 
=== Permissions ===
Namelayer can be used entirely via commands, but it also offers a GUI which can be easier to use. Use the <code>/nl</code> command to bring up the Namelayer GUI.
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 mw-collapsed"
|+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 civ server includes.
{| class="wikitable mw-collapsible mw-collapsed"
|+Additional Namelayer Permissions
!Provided By
!Permission
!Description
|-
| rowspan="5" |[[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
|
|-
| rowspan="8" |[[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
|-
| rowspan="2" |[[Factory|FactoryMod]]
|UPGRADE_FACTORY
|Can upgrade factories
|-
|USE_FACTORY
|Can use factory reinforced to group
|-
| rowspan="8" |[[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
|-
| rowspan="2" |[[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
|}
 
== GUI ==
[[File:Namelayer Main GUI Example.png|thumb|250px|The GUI opened by typing '/nl'.]]
 
NameLayer can be used entirely via commands, but there is a GUI which may be easier to use. use the <code>/nl</code> command to bring up the GUI.
The first screen of the Namelayer GUI 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, which is the group used by [[Citadel]] commands when a group is not specified.
 
[[File:Namelayer Main GUI Example.png|thumb|250px|The GUI opened by typing '/nl'.]]
Even though an account can be Owner of any number of NameLayer groups, an account can only be ''Primary Owner'' of up to 15 groups;
after that, group creations and Primary Owner transfers to that account are denied, until groups are either transferred to another account or deleted.
 
The first screen of the Namelayer GUI 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]].
One can get around this limit by owning multiple accounts and adding the actively used accounts as Owner (instead of Primary Owner, which is one of the alt accounts).
 
== Unique Usernames ==
Line 25 ⟶ 164:
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.
 
== CommandsCommand Reference ==
 
{|class="wikitable"
Line 121 ⟶ 260:
| /nlsbl <group>
|Shows all blacklisted players for a group
|}
 
== Permissions ==
Each plugin that uses NameLayer provides it's own set of permissions to manipulate a groups permissions you can use <code>/nlmp</code> or the [[NameLayer#GUI|GUI]]
 
The permissions provided by NameLayer itself are:
{{glossary}}
{{term|LIST_PERMS}}
{{defn|Allows seeing how the permissions are set up for the group}}
{{term|GROUPSTATS}}
{{defn|Gives access to various group statistics such as member counts by permission type, who owns the group etc}} <!--TODO: verify what exactly this means-->
{{term|OPEN_GUI}}
{{defn|Allows opening the GUI for this group}}
{{term|JOIN_PASSWORD}}
{{defn|<!--not sure how this works(TODO:find out :p) but-->perm level given to members when they join with a password}}
{{term|MEMBERS}}
{{defn|Allows inviting new members and removing existing members"}}
{{term|MODS}}
{{defn|Allows inviting/promoting new members and removing existing mods"}}
{{term|ADMINS}}
{{defn|Allows inviting/promoting new members and removing existing admins}}
{{term|OWNER}}
{{defn|Allows inviting/promoting new members and removing existing owners}}
{{term|BLACKLIST}}
{{defn|Allows viewing this groups blacklist, adding players to the blacklist and removing players from the blacklist}}
{{term|PASSWORD}}
{{defn|Allows viewing this groups password and changing or removing it");}}
{{term|PERMS}}
{{defn|Allows modifying permissions for this group}}
{{term|DELETE}}
{{defn|Allows deleting this group}}
{{term|LINKING}}
{{defn|(on servers that support it) Allows linking this group to another group as a supergroup or a subgroup}}
{{term|MERGE}}
{{defn|(on servers that support it) Allows merging this group into another or merging another group into this one}}
{{glossary end}}
<!--TODO: split this table into the appropriate page for each plugin-->
{|class="wikitable"
|+ class="nowrap" | Namelayer Permissions (ordered as they appear in the GUI)
!width="30%"| Permission Name
!width="70%"| Function
|-
| BASTION_PEARL
| Can pearl into bastion fields
|-
| BASTION_ALLOW_EXILED
| Allows exiles inside bastion range
|-
| DOORS
| Can open and close reinforced doors
|-
|CLEAR_SNITCHLOG
| Can clear snitchlog with /jaclear
|-
|SNITCH_NOTIFICATIONS
| Can see chat messageswhen players trigger snitches
|-
|READ CHAT
| Can read chat messages sent in group
|-
|ACIDBLOCK
| Can place acidblocks reinforced to group (/ctacid)
|-
|CROPS
| Can place and destroy crops
|-
|UPGRADE_FACTORY
| Can upgrade factories
|-
|MEMEMANA_WITHDRAW
| Can withdraw mana
|-
|SNITCH_IMMUNE
| Will no longer cause snitch alerts when in range of snitches on group.
|-
|BASTION_PLACE
| Can place in bastion ranges reinforced to group
|-
|WRITE_CHAT
| Can type messages in group
|-
|READ_SNITCHLOG
| Can check snitchlogs with /ja
|-
|USE_FACTORY
| Can use factory reinforced to group
|-
|INSECURE_REINFORCMENT
| Can use hoppers to take items out of reinforced containers /ctinsecure
|-
|SNITCH_TOGGLE_LEVER
| Can do /jaToggleLevers 1 to allow snitchs triggering redstone
|-
|BASTION_LIST
| Can list bastions on group (/bsl)
|-
|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
|-
|LIST SNITCHES
| can /jalist to see all snitches on group
|-
|BASTION_MANAGE_GROUPS
|
|-
|LOOKUP_SNITCH
| Can /jalookup a snitch giving coords
|-
|RENAME_SNITCH
| Can rename snitches
|-
|CHESTS
| Can use chests
|-
|KIRA_MANAGE_CHANNEL
| Can setup Kira relays on discord to relay group messages and alerts
|}
 
Tybug
2,232

edits

Retrieved from "https://civwiki.org/wiki/Special:MobileDiff/62660"