Merge branch 'main' of https://github.com/xChipseq/Dropship-Mod-Loader

Author: xChipseq

MODS.md

@@ -0,0 +1,25 @@
+> [!Note]
+> Want a mod to be added? Create a pull request or an issue
+## Currently supported mods
+### Role mods:
+- [Town of Us Reactivated](https://github.com/eDonnes124/Town-Of-Us-R)
+- [The Other Roles](https://github.com/TheOtherRolesAU/TheOtherRoles)
+- [Stellar Roles](https://github.com/Mr-Fluuff/StellarRolesAU)
+- [All The Roles](https://github.com/Zeo666/AllTheRoles)
+- [Town of Us](https://github.com/slushiegoose/Town-Of-Us)
+- [Town of Us JK](https://github.com/JoaKing08/Town-Of-Us-JK)
+
+### Custom Maps
+- [LevelImposter](https://github.com/DigiWorm0/LevelImposter)
+- [Submerged](https://github.com/SubmergedAmongUs/Submerged)
+- [BetterPolus](https://github.com/Brybry16/BetterPolus)
+
+### Other
+- [Vanilla Enhancements](https://github.com/xChipseq/VanillaEnhancements)
+
+### Dependencies
+- [Reactor](https://github.com/NuclearPowered/Reactor)
+- [Mira API](https://github.com/All-Of-Us-Mods/MiraAPI)
+
+> [!Warning]
+> [The list](https://github.com/xChipseq/Dropship/blob/main/Data/mods.json) is incomplete and is missing a lot of stuff

README.md

@@ -1,12 +1,56 @@
 <br />
 <div align="center">
   <a href="https://github.com/xChipseq/Dropship">
-    <img src="images/logo.png" alt="Dropship" width="80" height="80">
+    <img src="Images/dropship_logo.png" alt="Dropship" width="220" height="220">
   </a>
 
-<h3 align="center">project_title</h3>
-
+<h3 align="center">Dropship</h3>
   <p align="center">
-    project_description
+    Among us console-app mod launcher 
   </p>
 </div>
+
+<p align="center">
+	<a href="https://github.com/xChipseq/Dropship/releases">
+		<img alt="Downloads" src="https://img.shields.io/github/downloads/xChipseq/Dropship/total">
+	</a>
+	<a href="https://github.com/xChipseq/Dropship/releases/latest">
+		<img alt="Latest Release" src="https://img.shields.io/github/v/release/xChipseq/Dropship?include_prereleases">
+	</a>
+	<a href="https://github.com/xChipseq/Dropship/blob/master/LICENSE.md">
+		<img alt="License" src="https://img.shields.io/github/license/xChipseq/Dropship">
+	</a>
+	<a href="https://ko-fi.com/chipseq">
+		<img alt="Ko-Fi" src="https://img.shields.io/badge/Support_me-%23FF5E5B?logo=Ko-fi&logoColor=white">
+	</a>
+</p>
+<hr />
+
+## Features
+- ✨ Easy to use commands
+- ⚙️ Download any version of [Supported Mods](https://github.com/xChipseq/Dropship/blob/main/MODS.md)
+- 🚀 Download any **Among Us** version using **built-in DepotDownloader**, no betas required!
+- 📖 Create **profiles** and add **mods of your choice** to them without having to manually move the files
+
+## Example Usage
+1. Download a mod using `download_mod ModOfYourChoice v1.0.0` command, wait for everything to install
+2. Create a new profile with `create_profile MyProfile`
+3. Edit it to be able to add mods to it, `edit_profile MyProfile`
+4. Add the mod to your profile using `add_mod ModOfYourChoice v1.0.0`
+5. Launch the game with `play MyProfile`!
+
+## Instalation
+1. Download the [latest release](https://github.com/xChipseq/Dropship/releases/latest). The embedded version is recommended
+2. Create a folder for the app and extract the .exe file there
+3. Launch the app. This might take a second
+4. All the folders should be created, you are all set when you see the dropship text!
+> [!Warning]
+> While the embedded labeled package has [DepotDownloader](https://github.com/SteamRE/DepotDownloader/releases/latest) installed and should work without any additional work, if you downloaded the other one - `DepotDownloader.exe` is required to download and place in the same folder as `Dropship.exe`
+
+> [!Note]
+> For now, the launcher only works with the game bought on **Steam** and the only supported platform is **Windows**. *This will change in future*
+
+## Roadmap
+- [ ] Actual UI using WPF (probably)
+- [ ] Support for other platforms
+- [ ] Support for game bought on apps other than Steam