BetterAmongUs/README.md

# ♻ BetterAmongUs ♻

A client-sided mod that enhances the experience for the popular game Among Us!

<img width="700" height="500" alt="BetterAmongUs-Logo" src="/assets/BetterAmongUs-Logo.png" />

</p>
<p align="center">

<div style="text-align: center;">
    <a href="https://discord.gg/vjYrXpzNAn" target="_blank">
        <img src="https://img.shields.io/badge/Discord%20-%231DA1F2.svg?&style=for-the-badge&logo=discord&logoColor=white&color=5662f6" width="200" height="50"/>
    </a>
</div>

## Installation
### For First-Time Installation:

1. **Download the Correct Version**: 
   - Go to the [Releases](https://github.com/D1GQ/BetterAmongUs/releases) page
   - **Choose the correct zip file** for your platform:
     - Steam and itch.io users: `BAU-SteamItchio-Version.zip `
     - Epic Games and Microsoft Store users: `BAU-EpicMsStore-Version.zip`

2. **Extract the Files**:
   - Extract the downloaded zip file to a temporary location

3. **Install to Among Us Folder**:
   - Navigate to your Among Us installation directory
   - Copy ALL files and folders from the extracted zip into your Among Us folder
   - Overwrite any existing files when prompted

4. **Verify Installation**:
   - Launch Among Us
   - If installed correctly, you should see "BetterAmongUs" in the main menu

### For Updating an Existing Installation:

1. **Download the DLL File**:
   - Go to the [Releases](https://github.com/D1GQ/BetterAmongUs/releases) page
   - Download just the `BetterAmongUs.dll` file

2. **Replace the Old DLL**:
   - Navigate to your Among Us installation folder
   - Go to: `BepInEx/plugins/`
   - Replace the existing `BetterAmongUs.dll` with the newly downloaded one

3. **Verify Update**:
   - Launch Among Us
   - Check that the mod version has been updated in the main menu

### Linux Setup (Steam Only)

Use Proton (9.0+) with these launch options:
```
WINEDLLOVERRIDES="winhttp=n,b" PROTON_NO_ESYNC=1 %command%
```

**Setup Steps:**
1. Enable Proton in Steam → Properties → Compatibility → Force Proton 9.0+
2. Copy all mod files into your Among Us directory
3. Add the launch options above
4. Install Protontricks and set `winhttp` as a library override in winecfg

## Supported Platforms
- ✅ Steam
- ✅ Linux + Steam
- ✅ Epic Games
- ✅ Microsoft Store
- ✅ itch.io
- ✅ Android
- ❌ iOS
- ❌ Xbox/Playstation/Switch

## Supported Game Versions
- ✅ AU **v17.2.0** / **v2026.3.17**: (BAU v1.3.3) >
- ✅ AU **v17.1.0** / **v2025.11.18**: (BAU v1.3.1) >
- ✅ AU **v17.0.1** / **v2025.10.14**: (BAU v1.3.0) >
- ✅ AU **v16.1.0** / **v2025.6.10**: (BAU v1.2.0 Beta 1) >
- ✅ AU **v16.0.0** / **v2025.3.25**: (BAU v1.1.6 Beta 1) >
- ✅ AU **v2024.11.26**: >
- ✅ AU **v2024.10.29**: >
- ✅ AU **v2024.9.4**: >
- ✅ AU **v2024.8.13**: >
- ✅ AU **v2024.6.18**: (BAU v1.0.0) >
- ❌ AU **v2024.3.5**: or Below <

## Features

BetterAmongUs comes packed with a variety of features designed to improve your gameplay experience:

- **Built-in Client-Sided Anti-Cheat**: Enjoy a fair game by preventing cheaters from ruining your fun.
- **Host Enhancements**: Gain more control as a host with additional options and settings.
- **Better Options**: Customize your game with a range of new and improved options.
- **Commands**: Utilize a set of commands to manage and enhance gameplay.
- **Client Improvements**: Experience smoother gameplay with various client-side improvements.
- **And More!**: Stay tuned for more exciting features coming your way!

<img width="700" height="500" alt="freeplay-promo" src="/assets/freeplay-promo.png" />

## Anti-Cheat

Are you annoyed with pesky cheaters? Well, fear no more! BetterAmongUs has a built-in anti-cheat for both host and non-host players.

### The Anti-Cheat Can:
- **Check for Invalid Actions/RPCS**: Detect and prevent unauthorized actions and RPC calls.
- **Cancel Out Invalid Actions/RPCS**: Automatically cancel any suspicious activities detected.
- **Detect Specific Cheat Clients**: Identify known cheat clients to keep your game fair.
- **Save Data About Cheaters**: Keep track of detected cheaters for future reference.
- **And More**: Additional anti-cheat measures to ensure a secure gameplay environment.

## Commands

BetterAmongUs offers a variety of commands to enhance your control over the game:

- `/help` Get help with commands.
- `/commands` Get a list of all available commands.
- `/dump` Dump the entire log to the user's desktop.
- `/player {id}` Get a player's information.
- `/players` Get all player information.
- `/setprefix {prefix}` Set the command prefix.
- `/kick {id}` Kick a player from the game (Host Only!).
- `/ban {id}` Ban a player from the game (Host Only!).
- `/endgame` Force end the game (Host Only!).
- `/removeplayer {identifier}` Remove player from local Anti-Cheat data by (FriendCode, HashPuid).
- `/removeall` Remove all players from local Anti-Cheat data.

## Credits

A huge thank you to everyone who contributed to making BetterAmongUs a reality!

- **Head Developer**: [D1GQ](https://github.com/D1GQ)
- **Linux Support**: [Nyx](https://github.com/DeveloperNyx)

## Contacts
betterauofficial@gmail.com

## Disclaimer

**BetterAmongUs** is an unofficial, fan-made mod for **Among Us**. It is not affiliated with, endorsed by, or associated with **InnerSloth LLC** or the official **Among Us** game. All trademarks and copyrights related to **Among Us** are the property of **InnerSloth LLC**. This mod is created purely for entertainment purposes and to enhance the gaming experience. Use of this mod is at your own risk.