From 0f83817cb2685ead60be37d7c5475a06cecc18ad Mon Sep 17 00:00:00 2001
From: D1GQ <83262852+D1GQ@users.noreply.github.com>
Date: Fri, 9 Jan 2026 00:28:02 -0600
Subject: [PATCH] Add README
---
README.md | 94 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 94 insertions(+)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c2d9756
--- /dev/null
+++ b/README.md
@@ -0,0 +1,94 @@
+# ♻ BetterAmongUs ♻
+
+A client-sided mod that enhances the experience for the popular game Among Us!
+
+
+
+
+
+
+
+
+## Getting Started
+
+1. **Install the Mod**: Download the latest version from [Releases](https://github.com/EnhancedNetwork/BetterAmongUs-Public/releases) and follow the installation instructions in the [BepInEx Installation Guide](https://docs.bepinex.dev/articles/user_guide/installation/index.html) to get BetterAmongUs up and running.
+2. **Explore the Features**: Use the pause menu to discover new options and settings.
+3. **Check the Commands**: Type `/commands` in the chat to view a list of all available commands.
+4. **Stay Updated**: Keep an eye on this page for future updates and new features.
+
+## Supported Platforms
+- ✅ Steam
+- ✅ Epic Games
+- ✅ Microsoft Store
+- ✅ itch.io
+- ⚠️ Android (Unknown)
+- ❌ iOS
+- ❌ Xbox/Playstation/Switch
+
+## Supported Game Versions
+- ✅ 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!
+
+
+
+## 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)
+
+## 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.