0 of 0
About this mod
Adds the ability to randomly assign coloured names to the randomly generated NPCs that wander around town and visit your restaurants. This is designed to be used by streamers that want to add some minimal integration with their viewers.
- Permissions and credits
Use of this mod requires using a bot running on your computer that can write usernames to a text file in response to usage of a command, Twitch channel point redeem, etc. I recommend using Mix it up bot. The mod does not directly interact with streaming platforms like Twitch.
How to install
Installing mods requires BepInEx, a universal mod loader for Unity based games.
To install BepInEx:
1. Download the latest 5.x version for your platform, e.g. BepInEx_win_x64 if you're running Windows.
2. Extract the contents of the zip to your Chef RPG folder, e.g. C:\Program Files (x86)\Steam\steamapps\common\Chef RPG. Once extracted, you should have the folder "BepInEx" in your "Chef RPG" folder, as well as the files doorstop_config.ini and winhttp.dll. Example folder.
3. Run the game once. If installed properly, you should see the folder "plugins" inside your "BepInEx" folder.
To install the mod:
Simply extract the ChefTwitch.dll file into your BepInEx/plugins folder.
Adding names
The mod will look for a file called "TwitchNames.txt" in your BepInEx/plugins folder. Each name should be added on a new line. For example:
You can also assign colors to each name. This lets you for example use the person's twitch name color as their name color in-game.
How names are assigned
At any point the game usually has up to around 10 randomly generated NPCs walking around. Whenever a new NPC spawns, the mod will choose a random name from the list and assign it to that NPC. It's not possible for the same name to be used multiple times at once.
Additionally, only random NPCs will have names assigned to them. Major and minor characters will not have names because they already have their own names.
Example integration with Mix It Up bot
Create the channel point redeem in Twitch and make sure to allow it only once per user per stream. Then, link it to a command in Mix it up bot and configure it like this:
The "Text to save" should be:
Make sure to delete the TwitchNames.txt between each stream if you want it to reset. You can also automate this by adding a command to the Stream end event in Mix It Up if you'd prefer.
Need support?
If you need support, have questions, etc, feel free to join my discord
How to install
Installing mods requires BepInEx, a universal mod loader for Unity based games.
To install BepInEx:
1. Download the latest 5.x version for your platform, e.g. BepInEx_win_x64 if you're running Windows.
2. Extract the contents of the zip to your Chef RPG folder, e.g. C:\Program Files (x86)\Steam\steamapps\common\Chef RPG. Once extracted, you should have the folder "BepInEx" in your "Chef RPG" folder, as well as the files doorstop_config.ini and winhttp.dll. Example folder.
3. Run the game once. If installed properly, you should see the folder "plugins" inside your "BepInEx" folder.
To install the mod:
Simply extract the ChefTwitch.dll file into your BepInEx/plugins folder.
Adding names
The mod will look for a file called "TwitchNames.txt" in your BepInEx/plugins folder. Each name should be added on a new line. For example:
name1
name2
name3You can also assign colors to each name. This lets you for example use the person's twitch name color as their name color in-game.
<color=#F8819C>name1</color>
<color=#FF69B4>name2</color>
<color=#00FF7F>name3</color>
How names are assigned
At any point the game usually has up to around 10 randomly generated NPCs walking around. Whenever a new NPC spawns, the mod will choose a random name from the list and assign it to that NPC. It's not possible for the same name to be used multiple times at once.
Additionally, only random NPCs will have names assigned to them. Major and minor characters will not have names because they already have their own names.
Example integration with Mix It Up bot
Create the channel point redeem in Twitch and make sure to allow it only once per user per stream. Then, link it to a command in Mix it up bot and configure it like this:
The "Text to save" should be:
<color=$usercolor>$userdisplayname</color>Make sure to delete the TwitchNames.txt between each stream if you want it to reset. You can also automate this by adding a command to the Stream end event in Mix It Up if you'd prefer.
Need support?
If you need support, have questions, etc, feel free to join my discord