What's Trovogration?
-------------------------------

Trovogration is a client-only minecraft mod which offers more interaction between Trovo Streamer (and/or Twitch Streamer since 2.1.2) and viewers in a form of in-game actions triggered by sending certain chat commands. Don't forget to give an "/op" permission to your player if you're playing on a server, or allow "Cheats" in a single-player.

Points:
-------------------------------

Every Action costs points. There are two types of points available. RP (Regular Points) are points obtained by spending Trovo Mana on streamer's channel, while SP (Special Points) are points which obtained by spending Elixir in a form of Spells (or Bits in Twitch) or events such as Subscription/Gift subscription. Viewers accumulate points by these actions in chat and decide when to issue a certain command. All possible exchange rates for Mana to RP and Elixir to SP are configurable via config.

Actions:
-------------------------------

When viewer issues certain Action, the amount on points will be deducted from viewer's account. If the Action's cost doesn't specify exact points type, RP will be deducted first. If there are not enough points available, Action won't be triggered.

Cooldowns:
-------------------------------

After successfull activation, Action will need to cool down before become available again. And the price of Action will be added to "Heat pool" and 20% (configurable) will be added to "Bank". When Heat pool will become full, Action cooldown phase will be started. During this period, no negative action can be performed (configurable to allow no actions at all during cooldown phase).

Another cooldown will begin if player dies. Because sometimes it's not fair to kill the player right after respawn.

And there is a short cooldown right after connecting to Trovo from game. This one is made to heat up the audience.

Safe Zone:

-------------------------------

Every streamer will be wishing for a safe zone inside his/her base once they will die a couple of times from most kind viewers. So, there's a command /tg safe which sets a "Safe Zone" - a 32-block radius sphere (configurable) centered around a block where the command has been issued. Once the streamer fires the command, a cooldown for setting a Safe Zone will be started (300 seconds by default). Player must not leave a sphere until the cooldown passes and must not die! If either of these events happened, Safe Zone creation will be cancelled. Command available only when there are no active cooldowns.

Reward:

-------------------------------

If someone from viewers manages to kill streamer, "Bank" will be given to viewer's SP balance and zeroed.

How to use?
-------------------------------

When you'll run the game with the mod for the first time, it will create two necessary files: config/trovogration-client.toml and trovogration.json.
Upon entering any saved world, you'll be welcomed with "Press ALT + t" message. That's exactly what you'll need to do to connect to Trovo. But wait. Let's configure Actions first. Go ahead, and open config/trovogration-client.toml file with something like Notepad++.

There are a plenty of options with comments for you to explore and tweak to your likings, but the very bottom section called "Actions" is the most important one.
It consist of a list of possible actions for your viewers to pefrorm. There are a couple of examples in there, and it's okay to leave them there, but it's much more interesting to offer your own actions as well. You're limited only by your imagination (and a variety of minecraft commands of course). So, what's the format of an Action?
Action is a comma-separated list of double-quotted arguments enclosed in a square brackets. First to last arguments meaning are:

"command" - what word (prepended by hash sign #) viewer has to send in Trovo chat to perform the Action
"is action negative?" - "true" if the Action mean to harm the player in any way, "false" if the Action is doing something kind to player.
"minimum day" - how many days has to pass in Minecraft for this Action to become available. Only days spent in game are counted. Useful when playing on servers.
"allowed dimension list" - list of Minecraft dimensions (separated by semicolon ;) where the Action will be available. Prepend the list with a single minus sign (-) to turn the list into blacklist instead. Leave this argument blank if dimension doesn't matter.
"cost" - how much points the Action costs
"only accept SP?" - "true" if the Action requires SP, and won't be triggered no matter how much RPs the viewer posesses. "false" - any points can be used to pay the price. RPs will be spent first.
"cooldown (in seconds)" - how much time should pass before the Action will be available again.
"command list divided by semicolon" - single Action can perform several commands on activation. Just separate them by semicolon (;)

By the way, if the command in list starts with "/summon" then special clause will be appended to it to specify viewer's name who summons the mob for player.

Example:
-------------------------------

Let's say, we have such Action available in list:
"skeleton", "true", "1", "-minecraft:the_nether", "300", "false", "300", "/summon minecraft:skeleton"

To perform this action, viewer must send "#skeleton" in chat.
This Action is definetly negative
Action can be triggered since Day 1
Action cannot be triggered while player is in the Nether
Cost for the Action is 300 points
And it isn't necessary to spend SP for it. RPs are fine.
300 seconds should pass after successfull summon to issue this Action again
/summon minecraft:skeleton command will be sent to Minecraft console upon Action triggering

Another example:
-------------------------------

"tools", "false", "10", "minecraft:overworld", "100", "true", "600", "/give @s minecraft:stone_pickaxe;/give @s minecraft:stone_shovel;/give @s minecraft:stone_axe"

To perform this action, viewer should type "#tools" in chat.
This Action is positive. It will give stone pickaxe, stone shovel and stone axe to player! Yeah!
Action can be triggered since Day 10
Action can be triggered while player is in the Overworld only
Price is a solid hundred points
But stone tool set is expensive and useful, so only SPs can be spent
One set can be gifted per 10 minutes only
Three commands will be sent to Minecraft console upon activation

Built-in Trovo/Twitch-chat commands:
-------------------------------

There are special commands which are always available:

#cp [nickname] - can be used to get the information about user account balance (and be postponed with "nickname" to get the information about specific viewer. Available for moderators only).
#addrp|#addpp <viewer_name> <amount> - command available to use only by super-mods (by default) which adds a certain amount of RP to the specified viewer
#addsp <viewer_name> <amount> - command available to use only by super-mods (by default) which adds a certain amount of SP to the specified viewer

#addrpx|#addppx <multiplier> <viewer_name> <amount> - command available to use only by super-mods (by default) which adds a certain amount of RP multiplied by multiplier to the specified viewer
#addspx <multiplier> <viewer_name> <amount> - command available to use only by super-mods (by default) which adds a certain amount of SP multiplied by multiplier to the specified viewer

#days|#gs - displays current streamer Survival Day in chat

In-Game commands:

-------------------------------

/tg add_action <command> <isNegative?> <min_day> "<dimensions>" <price> <spOnly?> <cooldown> "<command_list>"

Allows quick adding action while in-game. Refer to "How to use?" for more information about arguments. Please note: dimensions and command_list argument must be double-quotted!

/tg overwrite_action <command> <newCommandName> <isNegative?> <min_day> "<dimensions>" <price> <spOnly?> <cooldown> "<command_list>"

Allows edition of existing action while in-game. Refer to "How to use?" for more information about arguments. newCommandName allows to rename the action. Please note: dimensions and command_list argument must be double-quotted!

/tg get_action <command>

Gets all the information about specified action, including current cooldown

/tg remove_action <command> <really?>

Removes specified action. Just in case there's another argument for confirmation of deletion - is should be "true".

/tg safe

Starts a Safe Zone creation, or cancels current Safe Zone if there's one exists already.

---- Added since 2.0:

/tg set_cooldown

Sets current Cooldown

/tg set_head

Sets current Accumulated Heat

/tg set_reward

Sets current Bank Reward

---- Added since 2.1.1:

/tg days

Displays current Days Survived

---- Added since 2.1.3:

/tg gui

Opens commands config GUI.

Your comments are always welcome!

What's Trovogration?-------------------------------

Points:-------------------------------

Actions:-------------------------------

Cooldowns:-------------------------------

Safe Zone:

-------------------------------

Reward:

-------------------------------

How to use?-------------------------------

Example:-------------------------------

Another example:-------------------------------

Built-in Trovo/Twitch-chat commands:-------------------------------

In-Game commands:

-------------------------------

What's Trovogration?
-------------------------------

Points:
-------------------------------

Actions:
-------------------------------

Cooldowns:
-------------------------------

How to use?
-------------------------------

Example:
-------------------------------

Another example:
-------------------------------

Built-in Trovo/Twitch-chat commands:
-------------------------------

TrovoGration