Snitch: Difference between revisions
start rewrite snitch page
(elaborate on renaming) |
(start rewrite snitch page) |
||
Line 1:
[[File:JukeAlertCheatsheet.png|thumb|350px| A summary of snitch mechanics on [[CivClassic]]. "JukeAlert"
A '''snitch''' is a block commonly included in civ servers which records nearby player movement or actions. Snitches provide different abilities based on their variant. Some will send a message to a [[NameLayer|NameLayer group]] when it detects player movement, allowing for real-time tracking of players. Other snitches will 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.
== Creation ==▼
Historically, [[Citadel|reinforced]] noteblocks and jukeboxes have been used as snitch blocks, each providing different capabilities.
First introduced by [[Civcraft]], snitches have been included in every [[mainline]] civ server since.
==
{| class="wikitable"▼
!Variant
|-▼
|Radius
|11 blocks (cube)
|11 blocks (cube)
|Dormancy Time
|4 weeks
|6 weeks
|-
|8 weeks
|12 weeks
|-
|Detects movement
|Y
|Y
|-
|Detects actions
|N
|Y
|-
|Preserves logs
|N
|Y
|}
▲=== Creation ===
Snitches have a unique interaction with [[NameLayer]] - once broken, they will print the name of the group they are reinforced to, along with the primary owner of the group. This is to allow players to determine who (perhaps with malintent) placed snitches on their land. This does not occur when culled snitches are broken.▼
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.
== Recording 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 can vary depending on the server, but it generally has the form <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.
When a player takes one of a predefined list of actions within the radius of a snitch that can detect cations, the snitch will record that action so it can be viewed later. Unlike movement, the snitch will not broadcast actions in real time.
The following is an incomplete list of actions which snitches can log.
▲== Recording Actions ==
{| class="wikitable"
|+
!Name
!Description
|-
|
|A player broke a block.
|-
|
|A player opened a chest.
|-
|
|A player killed a mob (or another player).
|-
|
|A player mounted a horse.
|}
=== Breaking ===
▲
This mechanic was first introduced in [[CivClassic]].
=== Checking Logs ===▼
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
Line 56 ⟶ 109:
== 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
▲{|class="wikitable"
▲|+Cull times
▲|-
▲| Noteblock
▲|-
▲| Jukebox
▲|}
== Redstone
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.
Line 101 ⟶ 139:
== Kira ==
[[Kira]]
== Mods ==
The [https://github.com/Gjum/SnitchMod/ SnitchMod] mod by [[Gjum|GJum]] can be
==
{|class="wikitable"
|+ class="nowrap" |
!|
!|
|-
| <code>/jahelp</code>
| Display
|-
| <code>/ja</code>
| Open the in-game snitch
|-
| <code>/jainfo [<page number> or 'next'] [censor] [action=<action type>] [player=<username>]</code>
Line 124 ⟶ 162:
|-
| <code>/jalist [group]</code>
|
|-
| <code>/janame <name></code>
|
|-
| <code>/jalookup
|
|-
| <code>/jamute [group]</code>
|
|-
| <code>/jaclear</code>
|
|-
| <code>/jatogglelevers <0,1></code>
| Enable (<code>1</
|}
| |||