|
5 | 5 |
|
6 | 6 | # Bean Mod Manager |
7 | 7 |
|
8 | | -A simple mod manager for Among Us. Install and manage mods like TOHE, Town of Us Mira, Better CrewLink, The Other Roles, and more without the hassle. |
| 8 | +A comprehensive mod manager for the popular game Among Us built with Windows Forms. Easily install, manage, and switch between mods like TOHE, Town of Us Mira, Better CrewLink, The Other Roles, and many more without hassle. |
9 | 9 |
|
10 | 10 |  |
11 | 11 |
|
| 12 | +## Features |
| 13 | + |
| 14 | +- **First Launch Wizard** - Guided setup for first-time users |
| 15 | +- **Automatic Detection** - Auto-detects Among Us installation (Steam, Epic Games, Microsoft Store) |
| 16 | +- **Smart Mod Management** - Install multiple mods, but only one active at a time |
| 17 | +- **Dependency Management** - Automatically installs required frameworks (Reactor, MiraAPI) |
| 18 | +- **Update Checking** - Notifies you when mod updates are available |
| 19 | +- **Incompatibility Detection** - Warns about conflicting mods before installation |
| 20 | +- **Search & Filter** - Find mods quickly with search and category filters |
| 21 | +- **Bulk Operations** - Install, uninstall, or update multiple mods at once |
| 22 | +- **Theme Support** - Light and dark themes with system preference detection |
| 23 | +- **Virtualized UI** - Optimized performance for large mod lists |
| 24 | +- **Steam Depot Support** - Automatic game file downloads for mods that require specific game versions |
| 25 | + |
12 | 26 | ## How to install? |
13 | 27 |
|
14 | 28 | 1. Download the latest release from the [releases page](https://github.com/rewalo/BeanModManager/releases) |
15 | | -2. Extract and run `BeanModManager.exe` |
16 | | -3. Set your Among Us folder path in Settings (or let it auto-detect) |
17 | | -4. Install BepInEx when prompted |
| 29 | +2. Run the `BeanModManager_Setup.msi` installer |
| 30 | + - The installer will guide you through the setup process |
| 31 | + - You can choose to create desktop and start menu shortcuts |
| 32 | + - Installation requires administrator privileges |
| 33 | +3. Launch Bean Mod Manager from the desktop shortcut or Start Menu |
| 34 | +4. Complete the first launch wizard: |
| 35 | + - The wizard will help you detect your Among Us installation |
| 36 | + - Select your game version (Steam/Itch.io or Epic/MS Store) |
| 37 | + - Install BepInEx (required for mods to work) |
18 | 38 | 5. You're ready to go! |
19 | 39 |
|
20 | 40 | ## How to use it? |
21 | 41 |
|
22 | 42 | - Launch Bean Mod Manager |
23 | | -- Go to the **Mod Store** tab |
| 43 | +- Go to the **Mod Store** tab to browse available mods |
24 | 44 | - Click **Install** on any mod you want |
25 | | -- Once installed, click **Play** to launch Among Us with that mod |
| 45 | +- Once installed, go to the **Installed Mods** tab |
| 46 | +- Click **Play** to launch Among Us with that mod active |
26 | 47 | - Use **Launch Vanilla** to play without mods |
27 | 48 |
|
28 | | -Mods are stored separately in `Among Us/Mods/{ModId}/`. When you click Play, it copies the selected mod's files into `BepInEx/plugins/` and launches the game. This way you can have multiple mods installed but only one active at a time. |
29 | | - |
30 | 49 | ## Included Mods |
31 | 50 |
|
32 | | -- **Launchpad Reloaded** - A vanilla-oriented Among Us mod with unique features, enhancing the gameplay experience without overcomplicating it. |
33 | | -- **All The Roles** - A mod for Among Us which adds many new roles, modifiers, game modes, map settings, hats and more |
34 | | -- **Town of Host Enhanced (TOHE)** - Host-only modpack with enhanced features |
35 | | -- **Town of Us Mira** - Town of Us Reactivated with MiraAPI |
| 51 | +### Featured Mods |
| 52 | +- **Town of Host Enhanced (TOHE)** - A host-only modpack for Among Us with enhanced features |
| 53 | +- **Town of Us Mira** - Town of Us Reactivated, but cleaner using MiraAPI with many improvements! |
36 | 54 | - **Better CrewLink** - Voice proximity chat for Among Us |
37 | | -- **The Other Roles (TOR)** - A mod for Among Us which adds many new roles, new Settings and new Custom Hats to the game |
38 | | -- **The Other Roles GM IA** - A mod for Among Us which adds many new roles, new Settings and new Custom Hats to the game (GM IA version) |
39 | | -- **Las Monjas** - A mod for Among Us which adds new roles and features to the game |
40 | 55 | - **Submerged** - A mod for Among Us which adds a new map into the game |
| 56 | +- **The Other Roles GM IA** - A mod for Among Us which adds many new roles, new Settings and new Custom Hats to the game (GM IA version) |
| 57 | +- **Endless Host Roles** - The largest Among Us mod |
| 58 | + |
| 59 | +### Gameplay Mods |
| 60 | +- **Launchpad: Reloaded** - A vanilla oriented fun and unique Among Us client mod |
| 61 | +- **All The Roles** - A mod for Among Us which adds many new roles, modifiers, game modes, map settings, hats and more |
| 62 | +- **The Other Roles** - A mod for Among Us which adds many new roles, new Settings and new Custom Hats to the game |
41 | 63 | - **StellarRoles** - A mod for Among Us which adds new Roles & Modifiers, new Settings and new Custom Cosmetics to the game |
| 64 | +- **Las Monjas** - A mod for Among Us which adds new roles and features to the game |
| 65 | +- **yanplaRoles** - A mod that introduces new roles and modifiers |
| 66 | +- **NewMod** - A mod for Among Us that introduces a variety of new roles, unique abilities, and custom game modes |
| 67 | +- **Cursed Among Us** - A mod for Among Us that introduces challenging modifications to gameplay |
| 68 | + |
| 69 | +### Host Mods |
| 70 | +- **Project Lotus: Continued** - Unique, beautiful, and customizable host mod. Adds cosmetics, commands and hotkeys, and various options |
| 71 | + |
| 72 | +### Utility & Fun Mods |
42 | 73 | - **SmolMod** - An Among Us Mod that makes players the size of pets! |
43 | | -- **Project Lotus: Continued** - Unique, beautiful, and customizable host mod. Adds cosmetics, commands and hotkeys, and various options. |
44 | 74 | - **PropHunt** - A mod for Among Us which extends Hide and Seek into a new mode, Prop Hunt! |
45 | 75 | - **Level Imposter** - Custom Among Us Mapping Studio |
46 | | -- **yanplaRoles** - A mod that introduces new roles and modifiers. |
47 | | -- **NewMod** - A mod for Among Us that introduces a variety of new roles, unique abilities, and custom game modes, offering players exciting new ways to enjoy the game. |
48 | | -- **AUnlocker** - A mod that unlocks additional content and features in Among Us. |
49 | | -- **Endless Host Roles** - The largest Among Us mod. |
50 | | -- **Cursed Among Us** - A mod for Among Us that introduces challenging modifications to gameplay. |
| 76 | +- **AUnlocker** - A mod that unlocks additional content and features in Among Us |
51 | 77 |
|
52 | | -Epic/MS Store versions are automatically detected - mod dropdowns will prefer the right version for your game. |
| 78 | +**Note:** Epic/MS Store versions are automatically detected - mod dropdowns will prefer the right version for your game. Some mods require Steam depot downloads for specific game versions, which are handled automatically. |
53 | 79 |
|
54 | 80 | ## Core Frameworks & Dependencies |
55 | 81 |
|
56 | | -Bean Mod Manager also manages essential modding frameworks that power many of the mods above. These are automatically installed when needed: |
| 82 | +Bean Mod Manager automatically manages essential modding frameworks that power many of the mods above. These are installed automatically when needed: |
57 | 83 |
|
58 | | -- **Reactor** - A shared modding framework that powers most Among Us mods |
| 84 | +- **Reactor** - A shared modding framework that powers most Among Us mods. The manager handles version conflicts automatically. |
59 | 85 | - **Mira API** - A modern modding API that powers newer mods with enhanced features and better performance |
60 | 86 |
|
61 | 87 | ## Requirements |
62 | 88 |
|
63 | | -- Windows 10 or later |
64 | | -- .NET Framework 4.8.1 or later |
65 | | -- Among Us installed (Steam, Epic, or MS Store) |
66 | | -- Internet connection for downloading mods |
| 89 | +- **Windows 10 or later** |
| 90 | +- **.NET Framework 4.8.1 or later** |
| 91 | +- **Among Us installed** (Steam, Epic Games Store, or Microsoft Store) |
| 92 | +- **Internet connection** for downloading mods and updates |
67 | 93 |
|
68 | 94 | ## Making a mod compatible with Bean Mod Manager |
69 | 95 |
|
70 | | -Publish a release in a public GitHub repository for your mod. In this release, you can add either (or both): |
| 96 | +To add your mod to Bean Mod Manager, follow these steps: |
71 | 97 |
|
72 | | -- The `.dll` file of the mod |
73 | | -- A `.zip` with the Among Us modded directory structure |
| 98 | +1. **Publish a release** in a public GitHub repository for your mod |
| 99 | +2. In the release, include either (or both): |
| 100 | + - The `.dll` file(s) of the mod |
| 101 | + - A `.zip` file with the Among Us modded directory structure |
| 102 | +3. **Follow standard BepInEx structure** - mods should be compatible with BepInEx plugin system |
| 103 | +4. **For multiple game versions** (Steam/Epic), include separate assets with naming conventions: |
| 104 | + - **Steam/Itch.io**: Recommended to include "steam" or "itch" in the asset name, or specify in your request |
| 105 | + - **Epic/MS Store**: Recommended to include "epic" or "msstore" in the asset name, or specify in your request |
| 106 | +5. **Open an issue or pull request** on this repository with: |
| 107 | + - Your repository link |
| 108 | + - Mod name, author, description |
| 109 | + - Category (Mod, Host Mod, Utility, etc.) |
| 110 | + - Any dependencies or incompatibilities |
74 | 111 |
|
75 | | -The mod should follow standard BepInEx structure. For multiple game versions (Steam/Epic), include separate assets: |
76 | | -- Steam/Itch.io: Include "steam" or "itch" in the asset name |
77 | | -- Epic/MS Store: Include "epic" or "msstore" in the asset name |
78 | | - |
79 | | -Then open an issue or pull request with your repository link and it'll be added! |
| 112 | +The mod will be added to the registry after review! |
80 | 113 |
|
81 | 114 | ## Building from source |
82 | 115 |
|
83 | | -1. Open `BeanModManager.sln` in Visual Studio |
84 | | -2. Restore NuGet packages |
85 | | -3. Build the solution (F6) |
86 | | -4. Run the application |
| 116 | +### Prerequisites |
| 117 | +- Visual Studio 2019 or later (with .NET Framework 4.8.1 development tools) |
| 118 | +- NuGet package manager |
| 119 | + |
| 120 | +### Steps |
| 121 | +1. Clone the repository: |
| 122 | + ```bash |
| 123 | + git clone https://github.com/rewalo/BeanModManager.git |
| 124 | + cd BeanModManager |
| 125 | + ``` |
| 126 | +2. Open `BeanModManager.sln` in Visual Studio |
| 127 | +3. Restore NuGet packages (right-click solution → Restore NuGet Packages) |
| 128 | +4. Build the solution (Build → Build Solution or F6) |
| 129 | +5. Run the application (Debug → Start Debugging or F5) |
| 130 | + |
| 131 | +The built executable will be in `bin\Release\` or `bin\Debug\` depending on your configuration. |
87 | 132 |
|
88 | 133 | ## Credits & Resources |
89 | 134 |
|
90 | | -Thanks to all mod creators. Check their respective GitHub repositories directly in Bean Mod Manager! |
| 135 | +Thanks to all the mod creators whose work makes this manager possible. You can access each mod's GitHub repository directly from within Bean Mod Manager by clicking the GitHub link on any mod card. |
| 136 | + |
| 137 | +### Contributing |
91 | 138 |
|
92 | | -If your mod is included and you want it removed, open a GitHub issue or send a message. It'll be removed immediately. Same goes if you want your mod added! |
| 139 | +- **Want your mod added?** Open a GitHub issue or pull request with your repository details (see "Making a mod compatible" section above) |
| 140 | +- **Want your mod removed?** Open a GitHub issue or send a message - it'll be removed immediately |
| 141 | +- **Found a bug or have a feature request?** Please open an issue on GitHub |
93 | 142 |
|
94 | 143 | ## License |
95 | 144 |
|
96 | | -This software is distributed under the GNU GPLv3 License. |
| 145 | +This software is distributed under the GNU GPLv3 License. See the [LICENSE](LICENSE) file for details. |
0 commit comments