Comprehensive Guide:Protection: Difference between revisions

From CivWiki
Jump to navigation Jump to search
Content added Content deleted
(ref to namelayer)
(ref to snitch)
Tag: Replaced
Line 15: Line 15:


== JukeAlert ==
== JukeAlert ==
''Record the actions of other players in an area using snitches {[https://github.com/CivClassic/JukeAlert source], [https://github.com/CivClassic/AnsibleSetup/tree/master/templates/public/plugins/JukeAlert config]}''
[[File:JukeAlertCheatsheet.png|thumb|350px| JukeAlert single image summary]]


See [[Snitch]].
=== Creating a snitch ===

Snitches are triggered when a player enters the 11 block square shaped radius around the snitch block. Players with namelayer permission <code>SNITCH_NOTIFICATIONS</code> on the group the snitch is reinforced to receive a chat message in the format <code>* <player> entered snitch at <snitch name> [world <x>,<y>,<z>]</code>. To create a snitch place a reinforced noteblock or jukebox. The snitch name can be set using the <code>/janame <name></code> command. Both noteblocks and jukebox snitches output chat messages on player entry yet jukebox snitches have the additional functionality of logging the entry in addition to block placement, block breaks and interactions with entities (Such as opening chests, killing mobs and mounting horses)

=== Checking snitches===

Jukebox logs can be checked by players who have the permission <code>READ_SNITCHLOG</code>. Standing within snitch range (11 block raduis) and typing <code>/jainfo</code> prints logs in chat while <code>/ja</code> opens a GUI containing logs. Both commands display the same information. <code>/jainfo</code> can take additional parameters in the syntax <code>/jainfo [<page number> or 'next'] [censor] [action=<action type>] [player=<username>]</code>. These parameters can be combined in any order.

{|class="wikitable"
|+<code>/jainfo</code> parameters
!width="20%"| Parameter
!width="30%"| Description
!width="50%"| Example
|-
| <code><page number> or next</code>
| View older entries. It can either be a page number or the keyword <code>next</code>. <code>next</code> will print the next page.
| <code>/jainfo 3</code> will print the 3rd page.
|-
| <code>censor</code>
| Censor coordinates from the logs. This is useful for posting snitch evidence publicly.
| <code>/jainfo censor</code> will print <code>Falvyu Block Break 1 [*** *** ***]</code> instead of <code>Falvyu Block Break 1 [1562 13 178]</code>
|-
| <code>action=<action type></code>
| Filter by action type.
| <code>/jainfo action="block break"</code> will only print entries where a block has been broken. Note that double quotes are only mandatory if the action has a space in it.
|-
| <code>player=<username></code>
| Filter by player name.
| <code>/jainfo player=RaiderCC1</code> will only print entries for 'RaiderCC1'. Note that this is case insensitive and will also print partial matches. <code>/jainfo player=raider</code> will therefore print entries for 'RaiderCC1' and any other player who has the word 'raider' in their name.
|}

=== Culling and dormancy ===

Snitches need to be periodically refreshed by a player entering the snitch field who is on the snitch group with the namelayer <code>LIST_SNITCHES</code> permission. Snitches that are not refreshed will first become dormant and lose all functionality but once refreshed will become functional again, if a dormant snitch isn't refreshed however after more time it will become culled. A culled snitch has no functionality but also can't be refreshed, functionality can only be regained by breaking and replacing the snitch block. You can use /jalist to see if your snitches have become dormant or how long is left until a snitch becomes dormant or culled. When you refresh a snitch, the timer on /jalist won't be updated until the daily server restart.

{|class="wikitable"
|+Cull times
!| Type
!Domancy time
!| Cull time
|-
| Noteblock
|4 Weeks
| 8 Weeks
|-
| Jukebox
|6 Weeks
| 12 Weeks
|}

=== Lever trigger ===

Jukebox snitches can be configured to cause levers on the blocks on or adjacent to the jukebox sides to output a redstone pulse. This behavior which is disabled by default can be enabled with <code>/jaToggleLevers 1</code> and disabled by <code>/jaToggleLevers 0</code> in radius of snitch.

The direction the lever is placed on changes the action type that causes it to trigger.

{|class="wikitable"
|+Redstone signal
!| Direction
!| Trigger
|-
| North
| Player entry or login/logout
|-
| East
| Block placement
|-
| South
| Chest opened
|-
| West
| Block break
|}

Nearby levers will be turned on for a duration of approximately 750ms. This duration can vary due to server lag. Levers that have already been enabled by players will also be turned off after 750ms.

=== Mechanics ===
* Breaking a snitch will print the namelayer group it is reinforced to along with the owner of the namelayer. This does not apply to culled snitches.
* Pearling in a snitch field will not trigger the snitch but moving inside will.

=== Commands ===

{|class="wikitable mw-collapsible mw-collapsed"
|+ class="nowrap" | Commands
!| Usage
!| Function
|-
| <code>jahelp</code>
| Display JukeAlert help
|-
| <code>ja</code>
| Open snitch GUI
|-
| <code>/jainfo [<page number> or 'next'] [censor] [action=<action type>] [player=<username>]</code>
| Print snitch logs in chat.
|-
| <code>jalist [group]</code>
| Display snitches in a GUI
|-
| <code>janame <name></code>
| Name snitch
|-
| <code>jalookup []</code>
| Use coordinates to show the namelayer the snitch is reinforced to
|-
| <code>jamute [group]</code>
| Ignore/Stop ignoring a group. Leaving the 'group' parameter empty will list the ignored groups.
|-
| <code>jaclear</code>
| Clear snitch logs from a nearby snitch
|-
| <code>jatogglelevers <0,1></code>
| Enable/Disabled the lever output functionality
|}

=== Tips ===

* It is recommended to name snitches appropriately to locate snitches more easily. A good naming pattern can be <code>[group name]<location></code>
* The [https://github.com/iykHvfIvfR/Snitch-Master Snitch Master mod] is recommended when managing snitches. (1.12 only)
* It is advised to configure a Kira relay to send snitch messages to a discord channel.


== Vault ==
== Vault ==

Revision as of 18:13, 9 July 2022

Mechanics that protect structures and items.

Citadel

See Citadel.

Namelayer

See NameLayer.

Bastion

See Bastion.

JukeAlert

See Snitch.

Vault

See Vault

Notes


References