Snitch: Difference between revisions
link civ
Squareblob (talk | contribs) (Redirected page to Comprehensive Guide:Protection#JukeAlert) Tag: New redirect |
(link civ) |
||
| (26 intermediate revisions by the same user not shown) | |||
Line 1:
[[File:JukeAlertCheatsheet.png|thumb|350px| A summary of snitch mechanics on [[CivClassic]]. "JukeAlert" refers to the name of the snitch plugin.]]
{{Mechanics series}}
A '''snitch''' is a block commonly included in [[Civ]] servers which records nearby player movement or actions. Snitches provide different abilities based on their type. Some can send a message to a [[NameLayer|NameLayer group]] when it detects player movement, allowing for real-time tracking of players. Other snitches can log nearby actions and can be examined after the fact to determine a recounting of events, even if nobody was present at the time.
Snitches are frequently placed in high-traffic areas to provide real-time insight into player movement, and in high-value areas so that any attacks can be traced back to a particular player or group.
Civ servers generally use [[Citadel|reinforced]] noteblocks and jukeboxes as snitch blocks, with each providing different capabilities.
First introduced by [[Civcraft]], snitches have been included in every [[mainline]] civ server since.
== Mechanics ==
{{Table alignment}}
<tabber>
|-|CivMC=
{| class="wikitable defaultcenter sortable"
|+
!Type
!Radius
!Dormant after
!Culled after
![[Snitch#Movement|Detects movement]]
![[Snitch#Actions|Detects actions]]
![[Snitch#Logs|Preserves logs]]
![[Snitch#Redstone Interaction|Emits redstone]]
|-
|Noteblock
|11 blocks
|4 weeks
|8 weeks
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|-
|Jukebox
|11 blocks
|6 weeks
|12 weeks
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|}
|-|CivCraft 1.0=
{| class="wikitable defaultcenter sortable"
|+
!Type
!Radius
!Dormant after
!Culled after
![[Snitch#Movement|Detects movement]]
![[Snitch#Actions|Detects actions]]
![[Snitch#Logs|Preserves logs]]
![[Snitch#Redstone Interaction|Emits redstone]]
|-
|Noteblock
|11 blocks (configurable)
|{{n/a}}
|3 weeks
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|-
|Jukebox
|11 blocks (configurable)
|{{n/a}}
|3 weeks
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|}
</tabber>
=== Creation ===
To create a snitch, place a noteblock or jukebox and [[Citadel|reinforce]] it.
You can give use <code>/janame <name></code> to set the name of the nearest snitch, which will then use that name in its notifications. By default, a snitch's name is empty.
=== Movement ===
When a player enters the radius of a snitch with the ability to detect movement, the snitch will send a message to the [[NameLayer|group]] it is reinforced to. The format of this message varies by server, but is generally <code><player name> entered snitch at <snitch name> [world <x>,<y>,<z>]</code>.
Snitches that track movement will also track if a player logs in or logs out within their radius. This sends a message in the same way player movement does.
=== Actions ===
When a player takes one of a predefined list of actions within the radius of a snitch that can detect actions, the snitch will record that action so it can be viewed later. Unlike movement, the snitch will not broadcast recorded actions in real time.
The following is an complete list of actions which snitches record in their logs.
{| class="wikitable"
|+
!Action
!Description
|-
|<code>BLOCK_BREAK</code>
|A player broke a block.
|-
|<code>BLOCK_PLACE</code>
|A player placed a block.
|-
|<code>DESTROY_VEHICLE</code>
|A player destroyed a vehicle (such as a minecart).
|-
|<code>DISMOUNT_ENTITY</code>
|A player dismounted an entity (such as a horse).
|-
|<code>EMPTY_BUCKET</code>
|A player emptied a bucket (such as placing water).
|-
|<code>ENTER_VEHICLE</code>
|A player entered a vehicle (such as a minecart).
|-
|<code>EXIT_VEHICLE</code>
|A player exited a vehicle (such as a minecart).
|-
|<code>FILL_BUCKET</code>
|A player filled a bucket (such as taking water).
|-
|<code>IGNITE_BLOCK</code>
|A player ignited a block (such as lighting a block with flint and steel).
|-
|<code>KILL_MOB</code>
|A player killed a mob.
|-
|<code>KILL_PLAYER</code>
|A player killed another player.
|-
|<code>MOUNT_ENTITY</code>
|A player mounted an entity (such as a horse).
|-
|<code>OPEN_CONTAINER</code>
|A player opened a container (such as a chest).
|}
=== Breaking ===
When a player breaks a snitch that is not theirs, it will print the name of the group they are reinforced to, along with the primary owner of the group. This provides players a clue as to who had placed the snitch, which might otherwise be very difficult to determine.
This mechanic was first introduced in [[CivClassic]] and is present in every proceeding [[mainline]] server.
== Logs ==
[[File:Jainfo example.png|thumb|<code>/ja</code> as seen in-game. Each block denotes a recorded action.]]
If a snitch preserves logs, you can run <code>/ja</code> to open an interface containing the logs of the nearest snitch. <code>/jainfo</code> can also be used to print the logs of the nearest snitch to the chat (only visible to you). You can run these commands only on snitches reinforced to a group you have permissions on.
<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"
|+
!width="20%"| <code>/jainfo</code> 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.
|}
== Dormancy and Culling ==
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.
== Redstone Interaction ==
Snitches with the ability to emit redstone can be be configured to emit a redstone pulse when it records a specific action. This behavior must first be enabled for a specific snitch with <code>/jatogglelevers</code> (<code>/jatogglelevers 1</code> to enable, and <code>/jatogglelevers 0</code> to disable). Then, place a lever on one of the four cardinal faces of the snitch block — i.e., anywhere but top or bottom.
The face the lever is placed on changes the action which will cause the snitch to emit a redstone pulse.
{|class="wikitable"
|+
!| Snitch face
!| Trigger
|-
| North
| Player entry or login/logout
|-
| East
| Block placement
|-
| South
| Chest opened
|-
| West
| Block break
|}
== Kira ==
[[Kira]] can be set up so that movement notifications are automatically relayed to a discord channel, in addition to being sent to a NameLayer group.
== Mods ==
The [https://github.com/Gjum/SnitchMod/ SnitchMod] mod by [[Gjum|GJum]] can be used to manage snitches.
== Command Reference ==
{|class="wikitable"
|+ class="nowrap" |
!| Command
!| Description
|-
| <code>/jahelp</code>
| Display the help menu.
|-
| <code>/ja</code>
| Open the in-game snitch interface.
|-
| <code>/jainfo [<page number> or 'next'] [censor] [action=<action type>] [player=<username>]</code>
| Print snitch logs in chat.
|-
| <code>/jalist [group]</code>
| Open an interface containing a list of snitches. If <code>group</code> is given, shows only snitches reinforced to that group.
|-
| <code>/janame <name></code>
| Set the name of the closest snitch.
|-
| <code>/jalookup <x>, <y>, <z></code>
| Look up a snitch by its coordinates. This will show what group the snitch is reinforced to. This command can only be run on snitches on groups you have permissions for.
|-
| <code>/jamute [group]</code>
| Temporarily mute or unmute movement notifications for snitches reinforced to <code>group</code>. If <code>group</code> is not given, list all ignored groups.
|-
| <code>/jaclear</code>
| Clears snitch logs from the closest snitch.
|-
| <code>/jatogglelevers <0,1></code>
| Enable (<code>1</code>) or disable (<code>0</code>) the lever output functionality of the closest snitch.
|}
{{Template:Mechanics}}
| |||