CivWiki

Snitch: Difference between revisions

Page Discussion

Snitch (view source)

Revision as of 23:56, 13 December 2023

2,643 bytes added ,  5 months ago
link civ
VisualWikitext
(link civ)
 
(22 intermediate revisions by the same user not shown)
Line 1:
[[File:JukeAlertCheatsheet.png|thumb|350px| A summary of snitch mechanics on [[CivClassic]]. "JukeAlert" singlerefers imageto summarythe 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.
'''Snitches''' are blocks which record the actions of other players in a radius around them. They come in two varieties: noteblocks and jukeboxes. Noteblocks only record player movement, while jukeboxes record all player actions, including breaking blocks and opening chests. Noteblocks and jukeboxes must be [[reinforced]] to turn into snitches. Snitches are managed by the '''JukeAlert''' plugin ([https://github.com/CivMC/JukeAlert source]).
 
Civ servers generally use [[Citadel|reinforced]] noteblocks and jukeboxes as snitch blocks, with each providing different capabilities.
== Creation ==
 
First introduced by [[Civcraft]], snitches have been included in every [[mainline]] civ server since.
To create a snitch, place down a noteblock or jukebox and reinforce it. Snitches have a cube area with an 11 block radius, so a total of a 23x23x23 block area centered on the snitch.
 
== Mechanics ==
Snitches can be given names with the <code>/janame <name></code> command.
 
{{Table alignment}}
== Breaking Snitches ==
<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 ===
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 ==
 
=== Movement ===
Whenever a player not on a snitch's namelayer group (or a player who is on the snitch's namelayer group, but does not have the SNITCH_IMMUNE permission) enters the snitch's area, a notification is sent to the snitch's namelayer group. Players on the namelayer group must have the SNITCH_NOTIFICATIONS permission to see this notification.
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.
Note that throwing an ender pearl into a snitch field will not trigger the snitch, but moving inside afterwards will.
 
=== Actions ===
By default, the notification has the form <code><player> entered snitch at <snitch name> [world <x>,<y>,<z>]</code>.
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.
== Recording Actions ==
 
{| class="wikitable"
Both noteblocks and jukeboxes record movement, but only jukeboxes record other player actions. Whenever a player performs an action - such as breaking a block, opening a chest, killing a mob, mounting a horse, etc - in the radius of a jukebox, a log entry is added to the jukebox.
|+
!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).
|}
 
=== Checking LogsBreaking ===
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.
To read the logs of a jukebox, stand in the radius of the jukebox and use the <code>/jainfo</code> command, which will output the logs to chat. You can also use the <code>/ja</code> command to open a GUI containing the logs. To perform either of these commands, the jukebox must be reinforced to a group you have the <code>READ_SNITCHLOG</code> permission on.
 
== 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"
|+
|+<code>/jainfo</code> parameters
!width="20%"| <code>/jainfo</code> Parameter
!width="30%"| Description
!width="50%"| Example
Line 56 ⟶ 171:
== 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. When you refresh a snitch, the timer on /jalist won't be updated until the daily server restart.
 
== Redstone Interaction ==
{|class="wikitable"
|+Cull times
!| Type
!Domancy time
!| Cull time
|-
| Noteblock
|4 Weeks
| 8 Weeks
|-
| Jukebox
|6 Weeks
| 12 Weeks
|}
 
== Redstone Interactions ==
 
JukeboxSnitches snitcheswith canthe be configuredability to causeemit leversredstone oncan thebe blocksbe onconfigured orto adjacentemit toa theredstone jukeboxpulse sideswhen toit outputrecords a redstonespecific pulseaction. This behavior whichmust isfirst disabledbe byenabled defaultfor cana bespecific enabledsnitch with <code>/jaToggleLeversjatogglelevers</code> (<code>/jatogglelevers 1</code> andto disabledenable, byand <code>/jaToggleLeversjatogglelevers 0</code> into radiusdisable). Then, place a lever on one of the four cardinal faces of the snitch block — i.e., anywhere but top or bottom.
 
The directionface the lever is placed on changes the action typewhich thatwill causescause itthe snitch to triggeremit a redstone pulse.
 
{|class="wikitable"
|+
|+Redstone signal
!| DirectionSnitch face
!| Trigger
|-
Line 96 ⟶ 196:
| 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.
 
== Kira ==
 
[[Kira]] relays can be set up toso automaticallythat send snitchmovement notifications forare 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 usefulused forto managingmanage snitches (1.18+).
 
== CommandsCommand Reference ==
 
{|class="wikitable"
|+ class="nowrap" | Commands
!| UsageCommand
!| FunctionDescription
|-
| <code>/jahelp</code>
| Display JukeAlertthe help menu.
|-
| <code>/ja</code>
| Open the in-game snitch GUIinterface.
|-
| <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.
| Display snitches in a GUI
|-
| <code>/janame <name></code>
| NameSet the name of the closest snitch.
|-
| <code>/jalookup []<x>, <y>, <z></code>
| UseLook up a snitch by its coordinates. toThis will show thewhat namelayergroup the snitch is reinforced to. This command can only be run on snitches on groups you have permissions for.
|-
| <code>/jamute [group]</code>
| Ignore/StopTemporarily ignoringmute aor unmute movement notifications for snitches reinforced to <code>group</code>. LeavingIf the '<code>group'</code> parameteris emptynot willgiven, list theall ignored groups.
|-
| <code>/jaclear</code>
| ClearClears snitch logs from athe nearbyclosest snitch.
|-
| <code>/jatogglelevers <0,1></code>
| Enable (<code>1</Disabledcode>) or disable (<code>0</code>) the lever output functionality of the closest snitch.
|}
 
Tybug
2,232

edits

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