Skip to content

TheRamik/Among-Us-Twitch-Mod

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

57 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Logo

Among Us Twitch Mod

An Among Us mod that allows twitch viewers to interact with your game via channel points
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

  1. About The Project
  2. Getting Started
  3. Building
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

This is a mod that allows a Twitch broadcaster's viewers to interact with their Among Us game via Channel Points.

Once set up, this mod will allow Twitch viewers to

  • Kill a random player
  • Swap positions of all living players

This mod was originally created by Efren Aguilar and Ricky Tham as part of the 2021 Twitch Channel Point Hackathon.

Built With

Getting Started

To get the game mod working will require a few steps, as shown below. Streamers will also need to set up the TwitchLib application, instructions for that can be found here.

Prerequisites

In order to play this mod online, a custom/private server is needed. Using Impostor is probably the easiest way to do this. Before doing anything else, it is highly recommended to get that set up first since this mod will not work without it.

Instructions and downloads for this are linked below, as well as a useful video for those who may need it.

Installation

Players will need to download the latest "AmongUsTwitchMod" zip folder found here.

SteamExample

Once there, open up the Among Us game files/folder. If you have the game on Steam, the easiest way is to do this via the settings button for Among Us.

FileExample

Inside here, unzip the contents of the zip folder. It should then look similar to what is shown above.

InstallSuccessExample

Then try running the game. It may take some time to launch the first time, but that's normal. If you see something like what is shown above, you have successfully installed the mod!

Installation (Streamers Only)

If you are a streamer, you will also need to install the TwitchLib program. Instructions for that can be found here.

Building

To build the Among Us mod for this project, you will need to creator a Reactor development environment. Instructions for this can be found here.

To build the TwitchLib program, follow the instructions here.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

For any mod issues, please see the open issues to check if someone else is having the same issue as you, or even a solution! Otherwise, feel free to post your issue there.

If you want to see the mod played live, follow Rickelz_ on Twitch!

Project Link: https://github.com/TheRamik/Among-Us-Twitch-Mod

Acknowledgements