https://github.com/modestimpala/votvchaosmod
Twitch Chaos Mod for Voices of the Void
https://github.com/modestimpala/votvchaosmod
lua python twitch ue4 ue4ss voices-of-the-void votv
Last synced: 10 months ago
JSON representation
Twitch Chaos Mod for Voices of the Void
- Host: GitHub
- URL: https://github.com/modestimpala/votvchaosmod
- Owner: modestimpala
- License: other
- Created: 2024-09-03T23:07:10.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-14T20:29:24.000Z (over 1 year ago)
- Last Synced: 2024-12-14T21:25:31.728Z (over 1 year ago)
- Topics: lua, python, twitch, ue4, ue4ss, voices-of-the-void, votv
- Language: Python
- Homepage:
- Size: 19.9 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
### Twitch Chaos Mod
Chaos Mod is an interactive mod that allows Twitch chat to vote on various in-game effects, send emails and shop for items! Experience Chaos with 100 different commands to vote for!
The mod features full Channel Points integration that lets viewers redeem custom rewards for Chaos Commands, emails, shop items, and hints. These rewards can be configured individually and run alongside regular Twitch voting.
It also features a Direct Mode with an Online Control Panel that runs alongside Twitch Integration. When enabled, it allows sending specific commands directly to players through a web interface.
Version 3.3.0 introduces an OBS Browser Overlay system, allowing streamers to display real-time voting information directly in their streams. The webserver runs locally at http://localhost:3202/ and integrates seamlessly with OBS Browser Sources. Additionally, this version includes "The Big Red Button" prop, a complete Nextbot AI rework, two new Nextbots, and various Chaos related tweaks.
Please see changelog for specific changes.
ChaosMod has automatic installation for the Twitch ChaosBot. A main menu button automatically downloads and runs a pre-built exe making installation a breeze. If you still want to run from source, it can automatically launch the python file for you.
**If you encounter any issues, *please* report them in the Discord channel or Github issues.** ChaosBot now has improved logging, so please include the log file (VotV\Binaries\Win64\pyChaosMod\logs or VotV\Binaries\Win64\logs) when submitting Twitch issues for easier troubleshooting.
## Features
- Twitch chat voting system
- Channel Point integration
- Offline Mode that randomly runs commands without Twitch Integration
- Direct Mode to send commands over a web interface
- Built in automatic installation of Twitch bot
- Randomized chaos effects, including custom assets
- Highly Customizable
- Email, Hint, and Shop system for viewer interaction - users can send emails to the in-game computer, order items from the shop and send hints of specific types
- Stylish In-game UI to display votes and ChaosMod status
- New OBS Browser Overlay system to display real-time voting, for users who wish to be completely surprised by the Chaos!
## Community
[GitHub Discussions](https://github.com/modestimpala/VotVChaosMod/discussions)
[Discord](https://discord.gg/Bq7HCMRfjk)
## Automatic r2modman Setup
1. Install ChaosMod and unreal-shimloader
2. Follow [Twitch's instructions to register an Application in the Twitch Dev Console](https://dev.twitch.tv/docs/authentication/register-app/)
- When registering your Application, be sure to set your **OAuth Redirect URL** to ``http://localhost:17563``. This is neccessary for automatic Web OAuth.
- Name and Category can be whatever you'd prefer. Example: VotVChaosBotModdy. Category: Game Integration.
- Your Application should be **Confidential**.
3. Once your Application is registered, click the **Manage** button from [Dev Console](https://dev.twitch.tv/console/apps).
- Make note of your **Client ID**.
- Under **"Client Secret"** click **New Secret**
- Make note of your Client Secret. **Do not share these values** - you must keep them confidential.
4. Launch the game with ChaosMod installed and click Chaos Settings on the Main Menu.
- Under "Twitch Settings" enter the following:
- Your desired Twitch Channel
- Your Client ID
- Your Client Secret
- Adjust any other settings as needed.
5. Click Save.
6. Launch the ChaosBot from main menu, which will automatically download and extract a pre-built exe, then run it.
If you want to download the exe manually, or run from source, see below.
## Manual r2modman Setup
1. Install ChaosMod and unreal-shimloader
2. Download [ChaosBot.zip](https://github.com/modestimpala/VotVChaosMod/releases/download/latest/ChaosBot.zip) from GitHub releases
- Optionally, download python source [from GitHub repo](https://github.com/modestimpala/VotVChaosMod/)
3. Navigate to modded game directory, pa08_00**\WindowsNoEditor\VotV\Binaries\Win64\
4. Place ChaosBot.exe in a folder called "pyChaosMod" inside Win64 folder
- Optionally, extract python source into Win64 folder
- pip install to install from requirements.txt
5. Follow [Twitch's instructions to register an Application in the Twitch Dev Console](https://dev.twitch.tv/docs/authentication/register-app/)
- When registering your Application, be sure to set your **OAuth Redirect URL** to ``http://localhost:17563``. This is neccessary for automatic Web OAuth.
- Name and Category can be whatever you'd prefer. Example: VotVChaosBotModdy. Category: Game Integration.
- Your Application should be **Confidential**.
6. Once your Application is registered, click the **Manage** button from [Dev Console](https://dev.twitch.tv/console/apps).
- Make note of your **Client ID**.
- Under **"Client Secret"** click **New Secret**
- Make note of your Client Secret. **Do not share these values** - you must keep them confidential.
7. Launch the game with ChaosMod installed and click Chaos Settings on the Main Menu.
- Under "Twitch Settings" enter the following:
- Your desired Twitch Channel
- Your Client ID
- Your Client Secret
- Adjust any other settings as needed.
8. Click Save.
9. Launch the ChaosBot from main menu, which will automatically run in order priority: ChaosBot.exe, python Chaosbot.py
- Optionally, run the program from pyChaosMod folder
Folder structure WindowsNoEditor\VotV\Binaries\Win64\pyChaosMod is *essential* for proper functionality
## Configuration
Use in-game configuration menu to change settings and set Twitch connection info.
## OBS Overlay
The OBS Overlay runs alongside ChaosBot at http://localhost:3202/
Simply add this to your active OBS scene and configure ChaosBot/CSS as needed.
The CSS stylesheet can be edited at VotV/Binaries/Win64/pyChaosMod/cfg/styles.css
and the local webserver port can be adjusted with cfg/overlay.cfg
```
[overlay]
; Port for the overlay web server
port=3202
```
Use the in-game configuration menu to disable the visibility of the regular Voting Menu and optionally disable hints under Misc. for an incognito chaos stream!
## Usage
1. Start your game with mods enabled, through r2modman or manual setup.
2. Launch ChaosBot from main menu
- Optionally, launch exe or .py file manually from pyChaosMod folder
3. Either pause the game or open inventory to see buttons to toggle the mod and other functions (bottom right)
Optional In-game keybinds:
- F8: Toggle Chaos Mod on/off
- F7: Manually trigger voting
- F6: Clear active events, to allow saving and pausing if disabled
- F3: Toggle email system (if enabled)
4. Twitch viewers can vote using numbers in chat during voting periods.
5. If enabled, viewers can use the `!email` command to send in-game emails.
- Format: !email subject:[subject] body:[body]
6. If the shop system is enabled, viewers can use the `!shop` command to place orders when the shop is open. This will deduct Points if enabled.
- [Shop items list](https://github.com/modestimpala/VotVChaosMod/blob/main/list_store.txt)
# Showcase
https://github.com/user-attachments/assets/4adc4bad-de7b-4fab-8a11-432bc1a9cb42
https://github.com/user-attachments/assets/9d8f602b-c36d-4a8f-b708-261537f7ef94
Twitch Chatter Email Showcase
https://github.com/user-attachments/assets/e9362855-1803-4733-a60d-bf4571f273f7
Twitch Shopping Showcase
# Commands
Current List of Commands (spoilers)
- randomEvent
- hiccups
- fling
- rainbowATV
- fossilHounds
- stickDrift
- earthquake
- dirtyWindow
- explodeFridge
- bigRoach
- 5ghorse
- cataracts
- magneticEffect
- flipCamera
- vomit
- pukeDrive
- vomitRandomItem
- pukeStream
- pyramidTime
- kerfurYeet
- redSky
- killAllKerfurs
- spawnKerfurs
- ignitePlayer
- teleportRadioTower
- teleportTurbine
- ragdollPlayer
- superSpeed
- hulkMode
- smokeCig
- 500cigs
- explodePlayer
- badSun
- blackFog
- jellyFishTime
- spawnMeatball
- lowGravity
- spawnZeroGun
- spawnSonicGun
- freeMoney
- skyFallingEvent
- waspAttack
- laserSpam
- caltropsTrap
- spawnMeatballFood
- spawnMaxwell
- spawnKavotia
- wispTeleport
- spawnATV
- insaneATVs
- explodeAllATVs
- fixAllATVs
- smoke500cigs
- deleteActiveSignal
- randomDream
- forceSleep
- takePicture
- starvePlayer
- fullTummy
- doublePoints
- halfPoints
- nauseaEffect
- lsdEffect
- teleportToBaseBalcony
- teleportTopOfBase
- evilEriePlush
- immortalForTime
- bigKel
- tinyKel
- tinyKerfurs
- bigKerfurs
- baseRave
- fishSplosion
- bigLakeFish
- ohFiddlesticks
- forceServerMinigame
- breakRandomServers
- breakRandomGenerator
- fixGenerators
- garbageDay
- spamFlashlight
- madnessCombat
- maxwellBomb
- drainSleep
- addEnergy
- nextbotCharborg
- nextbotJerma
- nextbotWalter
- nextbotGlorpFriend
- jumpscareComputer
- freeBattery
- orderShrimp
- orderDrives
- orderPizza
- orderTV
- orderRadio
- orderBanana
- orderCheese
- fullSleep
- healPlayer