Kira: Difference between revisions

184 bytes added ,  5 months ago
add mechanics category box
(rewrite intro, move to separate page)
 
(add mechanics category box)
 
(5 intermediate revisions by the same user not shown)
Line 1:
{{Mechanics series}}
'''Kira''' is a plugin ([https://github.com/CivMC/Kira source]) which allows creating relays of in-game events, such as [[snitchSnitch]] messages, to a discord server. It is primarily to allow players to view snitch hits in real-time, even when not in game.
 
== Overview ==
 
Kira allows you to create relays for snitch hits, [[NameLayer]] group chat messages and global player login/logout messages.
 
The commands can be issued in any Discord channel that Kira can read (e.g., <code>!kira help</code>), or sent via direct message (without the prefix, e.g., just <code>help</code>).
Line 11 ⟶ 12:
Before using Kira, you must link your discord account to your minecraft account. To do so, run <code>/discordauth</code> in game, then run <code>!kira auth [token]</code> with the resulting token in any discord server Kira is in.
 
== InCommand Game commandsReference ==
 
=== In-game ===
* /deletediscordchannel
{| class="wikitable"
* /discordauth - Creates auth code
|+
* /linkdiscordchannel
!Command
* /syncdiscordchannel
!Description
 
|-
== Discord commands ==
* |<code>/deletediscordchannel</code>
| -
|<code>/discordauth</code>
|-
* |<code>/linkdiscordchannel</code>
|-
* |<code>/syncdiscordchannel</code>
|}
 
=== Discord commands ===
{| class="wikitable"
|+
|+Kira commands<ref>Kira help command</ref>
!Command
!Description
!Example
|-
|<code>!kira help</code>
|Shows help
|-
|''formatting''| <code><nowiki>!kira apitoken <SNITCH|CHAT|SKYNET></nowiki></code>
| Generates a token for use with Kiras API
|
|-
| <code>!auth [code]</code>
| Allows linking your discord account to an ingame account. Run '/discordauth' ingame to get a code.
|-
|<code>!kira getchannels </code>
|Shows all relays owned by you
|-
|<code>!kira createrelayconfig [name]</code>
|Creates a new relay configuration
|-
|<code>!kira createrelayhere [group]</code>
|Attempts to create a relay in the channel this message was sent in for the group it was sent by
|-
|<code>!kira setrelayconfig [group] [relay]</code>
|Sets which configuration to use for a specific relay
|-
|<code>!kira info</code>
|Prints basic info on the bot
|-
|<code>!kira mcingame [command] </ !kira ingame [command]code>
|Run an in-game command from discord. For instance, <code>!kira ingame nlip CW-1 Falvyu</code> is equivalent to running <code>/nlip CW-1 Falvyu</code> in game.
|Allows you to run ingame commands from discord
| <code>!kira mc nlip CW-1 Falvyu</code> (adds player <code>Falvyu</code> to <code>CW-1</code> name layer)
|-
|<code>!kira invite</code>
|Send the invite link for Kira in chat.
|Allows you to add Kira to other discords
|-
|<code>!kira relayconfig [name]</code>
|!kira quote
|Gives life advice
|-
|!kira relayconfig [name]
|Configures properties of a relay config
|
|-
|<code>!kira setrelayconfig [group] [relay]</code>
|Sets which configuration to use for a specific relay
|
|-
|<code>!kira whoami</code>
|Shows your linked accounts
|
|}
 
{{Mechanics}}
2,232

edits