forked from hodlhodl1132/twitchtoolkit
-
Notifications
You must be signed in to change notification settings - Fork 5
/
mod-descripton.txt
165 lines (104 loc) · 10.2 KB
/
mod-descripton.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
[h1]Another twitch integration mod based on the popular mod Twitch Stories.[/h1]
Check out that mod here: https://steamcommunity.com/sharedfiles/filedetails/?id=1575408914
[h1]TwitchToolkit - Chat Storytelling Integration - Coins and Voting[/h1]
This mod is far into beta-testing and is mostly bug free. We hate bugs so if you find any please let us know in the discord so we can fix asap.
[h1]Languages[/h1]
Currently available in English and Deutsch. We are inviting translators to our team, please join via discord and let us know in the help section. https://discord.gg/qrtg224
If you are streaming this mod you can post in the channel-promotion section of our discord!
[h1]Main Features[/h1]
TwitchToolkit adds to big features including the storytelling voting and coin store, both work standalone of each other.
[h1]Storyteller Voting[/h1]
TwitchToolkit adds 3 new vanilla-like storytellers into the game. The Uristbot(cassy), Spartanbot(phoebe), and Hodlbot(randy) all use similar storyteller patterns to the base game. The difference is instead of coming up with only one possible outcome they come up with more depending on how many vote options you have max. This is not based on a real world timer but uses in game time to decide when incidents should occur.
New votes will show up on screen with a timer while the current results update in real time. You can drag the vote box to your preferred position.
[h1]Coin Store[/h1]
TwitchToolkit adds the coin store which it is notorious for. Your viewers will earn coins per minute based on your settings. These coins can be spent on storytelling events and different tradeable ingame items. Events will happen immediately and items will come from cargo pods dropped near your base.
When purchasing an item/event, any message included after the command is included in the letter notification in game. See screenshots
Events have cooldowns to prevent absolute insanity (of course this can be turned off) and uses the games brain to decide if certain things can happen.
Items are generated from your custom game, so if you have mods with tradeable items, those items will be available in your purchase list.
[h1]Features[/h1]
[h1]Commands[/h1]
[b]Admin Commands[/b]
[u]!addtoolkitmod[/u] - Syntax: !addmod @username - give viewer access to mod commands below
[u]!removetoolkitmod[/u] - Syntax: !removemod @username - take viewer access to mod commands below
[u]!resetviewers[/u] - resets all viewers data back to default, must confirm twice
[b]Mod Commands[/b]
[u]!refreshviewers[/u] - updates viewers watching channel, this is for debugging mostly
[u]!karmaround[/u] - simulates a coin reward round
[u]!givecoins[/u] - Syntax: !givecoins @username 1000 - gives user 1000 coins (can also be used with negative numbers to take coins)
Moderators cannot give coins to themselves
[u]!giveallcoins[/u] - Syntax: !giveallcoins 1000 - gives all users 1000 coins
[u]!checkuser[/u] - Syntax: !checkuser @username - do a balance check on the user
[u]!setkarma[/u] - Syntax: !setkarma @username 100 - set user karma to 100%
[u]!togglestore[/u] - toggle ability for users to purchase items/events
[u]!togglecoins[/u] - toggle ability for users to earn coins while viewing
[b]User Commands[/b]
These are changeable and if you reset these commands in the settings they will translate to your language if supported.
[u]!bal[/u] - check balance and karma rate
[u]!buyevent[/u] - Syntax: !buyevent skillincrease - purchase an event
[u]!buyitem[/u] - Syntax: !buyitem beer 2 - purchase an item
[u]!whatiskarma[/u] - explains what the karma system is
[u]!purchaselist[/u] - gives users a link to the public purchase list
[u]!instructions[/u] - gives users info on using the mod
[u]!modinfo[/u] - gives users info about the mod
[u]!modsettings[/u] - gives user info on how many coins are being earned and global settings
[u]!giftcoins[/u] - Syntax: !giftcoins @username 100 - give another viewer your coins
[u]!toolkitcmds[/u] - shows all available commands to the user, this does not translate by default so it can be universally recognized.
[h1]Karma System[/h1]
As much as we'd all love to send 50 raids to our favorite twitch streamers, we need to balance things out. To do this a karma system is in use that rewards users for good events & items while punishing users for bad events. Your karma rate will decide how many coins you earn per interval up to your set karma cap. The base recommended Karma cap is 140% and any higher viewers will snowball the coins they earn.
The more you spend on items/good events the more coins you will make overall.
[h1]Custom Pricing[/h1]
Items and events included in your game can have their pricing changed. Once you have completed editing your prices you can output them to a custom spreadsheet. A wonderful guide by the Twitch.tv/Kruffles will help you setup your custom pricing for your viewers, that you can view here:
https://docs.google.com/document/d/10r1JmgazoVyU_8ydEPzvuoXIaAU6zNec79ZSG11jnZ4/edit
[h1]Coins Settings[/h1]
Coins section of the mod settings
Reward coins: Toggles whether or not your viewers are earning coins
Store Open: Toggles whether or not your viewers can purchase items/events
Viewers can gift other viewers coins: Toggles gifting(trading) of coins between viewers. This is off by default since it can easily be abused by alt accounts. I recommend turning this off for streams that can’t be properly moderated.
Coins per interval: Your viewers will get this many base coins every coin reward round
Max Karma: What is the maximum bonus percentage of coins viewers can earn (For example: 140% means viewers would earn extra 40% of base reward)
Minimum Purchase Price: To prevent spam of low priced items, a minimum purchase price will require viewers to spend a min amount of coins to complete a purchase.
Minutes between coin reward: How often should viewers be reward the base coins + karma bonus
Starting Balance: How many coins should new viewers start with
Starting Karma: What percentage of the base coin reward should new viewers start with
Link to custom pricing sheet: This will change the outputted link to the pricing sheet to your custom sheet
[h1]Events Settings[/h1]
Events section of mod settings
At the top of this box is a search box that can be used to quickly find events you are looking for. Next to the search box are the up/down scrolling. To the right of that is the price multipliers that will change the pricing of all events at once. Lastly, is the reset to default button which will ensure your events are working right, are up to date, and have default values.
Each of the events listed have the following options:
Price of each event can be changed with the integer buttons.
The type of karma given to the player for the event, so bad events take down karma and good events pull up karma. An example of when you might change this, if you are running a cannibal colony it would make sense for the cannibal trait to be a good thing.
The disable button sets the price to 0 which makes the event unbuyable, to turn an event back on raise the price.
The max button is the maximum amount of times the event can happen within your cooldown period. The cooldown period is set in the options section of the mod settings.
[h1]Items Settings[/h1]
Items sections of mod settings
The items section also has a search bar for quickly finding items. The reset to default will make sure all tradeable items in your current game + mods will be loaded into your purchase list. The price for items are calculated off the basemarketvalue of items. Each items price can be altered or items can be disabled entirely.
[h1]Options Settings[/h1]
Options section of mod settings
Should buildings unable to be uninstalled be included in the item list? This option was never intended for the full release, however, this bug turned into a feature. It is recommended to keep this off as it makes it so you can’t purchase ‘buildings’. An example of this would be a grave, which would wall from the sky and immediately construct itself. This can cause unwanted consequences like destroying items, destroying buildings, or never appearing in the first place.
Should viewers have unlimited coins? Self-explanatory, should the game check if viewers have enough coins?
Should events have cooldowns? This prevents events from being spammed past their max value within their cooldown period.
Should viewer names be repeated in raids/aid? This is a cool feature but can be buggy down the road if you don’t use a mod like RuntimeGC for cleaning up old pawns. To my understanding, by generating tons of pawns with the same name you could potentially cause issues.
Large voting window? If you stream at a lower resolution than 1080p or have a lot of mobile viewers, you may want to make the voting window larger.
How many minutes in a cooldown period? This is how often the max of each event can be hit. So for a big raid, if a viewer purchased this the next viewer would have to wait 15 mins before purchase. For events with a higher max of 1 it will work slightly different. If an event has a max of two and a viewer purchases one it will work like this.
Viewer 1 purchases inspiration. Viewer 2 purchases inspiration 5 minutes later. Viewer 3 tries to purchase inspiration but it is on cooldown, it takes another 10 minutes for the first viewers purchase to not be counted in the cooldown.
Separate chatroom uuid and and channel id are beta features and are not supported. Use at your own risk. Will be supported in near feature when bug free.
[h1]Command Settings[/h1]
Commands section of mod settings
Commands can be whispered? This allows viewers to whisper their commands to the username set.
Commands must be whispered? Forces viewers to whisper their command to the username set
Should purchases be confirmed in chat? Creates a confirmation message upon successful purchase of item/event. This is spammy which is why you might want it off.
The rest of the settings in this section allow you to change the commands incase they conflict with other stream commands. If you click reset commands, it will attempt to translate the commands into your language.
Special thanks to:
-help
Codingale
-stream testers
zenfrox
spartanstu23
suwey
kruffles
and the viewers of their streams
-based off source code from mod TwitchStories written by
finally
rachey
swenee
Xenon