From 136642836de89bef94c930e1e12e566d1ab2e880 Mon Sep 17 00:00:00 2001 From: Alexejhero <32238504+Alexejhero@users.noreply.github.com> Date: Thu, 15 Jun 2023 21:18:39 +0300 Subject: [PATCH] Submerged v2023.7.24 --- .../FOR MOD DEVELOPERS.md | 18 +- .../Images}/Folder-Structure.png | Bin {Images => .github/Images}/Icon.png | Bin {Images => .github/Images}/Screenshot-1.png | Bin {Images => .github/Images}/Screenshot-2.png | Bin {Images => .github/Images}/Screenshot-3.png | Bin {Images => .github/Images}/Screenshot-4.png | Bin {Images => .github/Images}/Screenshot-5.png | Bin {Images => .github/Images}/Screenshot-6.png | Bin {Images => .github/Images}/Screenshot-7.png | Bin {Images => .github/Images}/Screenshot-8.png | Bin .../THIRD PARTY NOTICE.txt | 0 LICENSE.md | 153 +++++++++++++++ LICENSE.txt | 181 ------------------ README.md | 104 +++++----- 15 files changed, 225 insertions(+), 231 deletions(-) rename FOR MOD DEVELOPERS.md => .github/FOR MOD DEVELOPERS.md (90%) rename {Images => .github/Images}/Folder-Structure.png (100%) rename {Images => .github/Images}/Icon.png (100%) rename {Images => .github/Images}/Screenshot-1.png (100%) rename {Images => .github/Images}/Screenshot-2.png (100%) rename {Images => .github/Images}/Screenshot-3.png (100%) rename {Images => .github/Images}/Screenshot-4.png (100%) rename {Images => .github/Images}/Screenshot-5.png (100%) rename {Images => .github/Images}/Screenshot-6.png (100%) rename {Images => .github/Images}/Screenshot-7.png (100%) rename {Images => .github/Images}/Screenshot-8.png (100%) rename THIRD PARTY NOTICE.txt => .github/THIRD PARTY NOTICE.txt (100%) delete mode 100644 LICENSE.txt diff --git a/FOR MOD DEVELOPERS.md b/.github/FOR MOD DEVELOPERS.md similarity index 90% rename from FOR MOD DEVELOPERS.md rename to .github/FOR MOD DEVELOPERS.md index 0f4643e1..8dac9654 100644 --- a/FOR MOD DEVELOPERS.md +++ b/.github/FOR MOD DEVELOPERS.md @@ -1,3 +1,11 @@ +# NOTICE + +This document was written for Submerged version `v2022.5.1` and hasn't been updated since. Some information might be outdated, but most of it should be ok. + +If you have any doubts check the source code or contact me on discord: `@alexejhero` + +--- + # For Mod Developers Submerged tries to patch as little as possible in order to allow other mods to be easily updated to be compatible with it. However, there are a few classes and patches that we have, which will commonly conflict with most other mods. @@ -7,7 +15,7 @@ Submerged tries to patch as little as possible in order to allow other mods to b # Networking-related IDs used by Submerged - SpawnablePrefabs - - `9` - SubmarineStatus + - `11` - SubmarineStatus - RPCCalls - `210` - SetCustomData - `211` - RequestChangeFloor @@ -16,10 +24,10 @@ Submerged tries to patch as little as possible in order to allow other mods to b - `214` - OxygenDeath - Systems - `130` - SubmarineOxygenSystem - - `136` - SubmarineElevatorSystem (WestLeft) - - `137` - SubmarineElevatorSystem (WestRight) - - `138` - SubmarineElevatorSystem (EastLeft) - - `139` - SubmarineElevatorSystem (EastRight) + - `136` - SubmarineElevatorSystem (HallwayLeft) + - `137` - SubmarineElevatorSystem (HallwayRight) + - `138` - SubmarineElevatorSystem (LobbyLeft) + - `139` - SubmarineElevatorSystem (LobbyRight) - `140` - SubmarineElevatorSystem (Service) - `141` - SubmarinePlayerFloorSystem - `142` - SubmarineSecuritySabotageSystem diff --git a/Images/Folder-Structure.png b/.github/Images/Folder-Structure.png similarity index 100% rename from Images/Folder-Structure.png rename to .github/Images/Folder-Structure.png diff --git a/Images/Icon.png b/.github/Images/Icon.png similarity index 100% rename from Images/Icon.png rename to .github/Images/Icon.png diff --git a/Images/Screenshot-1.png b/.github/Images/Screenshot-1.png similarity index 100% rename from Images/Screenshot-1.png rename to .github/Images/Screenshot-1.png diff --git a/Images/Screenshot-2.png b/.github/Images/Screenshot-2.png similarity index 100% rename from Images/Screenshot-2.png rename to .github/Images/Screenshot-2.png diff --git a/Images/Screenshot-3.png b/.github/Images/Screenshot-3.png similarity index 100% rename from Images/Screenshot-3.png rename to .github/Images/Screenshot-3.png diff --git a/Images/Screenshot-4.png b/.github/Images/Screenshot-4.png similarity index 100% rename from Images/Screenshot-4.png rename to .github/Images/Screenshot-4.png diff --git a/Images/Screenshot-5.png b/.github/Images/Screenshot-5.png similarity index 100% rename from Images/Screenshot-5.png rename to .github/Images/Screenshot-5.png diff --git a/Images/Screenshot-6.png b/.github/Images/Screenshot-6.png similarity index 100% rename from Images/Screenshot-6.png rename to .github/Images/Screenshot-6.png diff --git a/Images/Screenshot-7.png b/.github/Images/Screenshot-7.png similarity index 100% rename from Images/Screenshot-7.png rename to .github/Images/Screenshot-7.png diff --git a/Images/Screenshot-8.png b/.github/Images/Screenshot-8.png similarity index 100% rename from Images/Screenshot-8.png rename to .github/Images/Screenshot-8.png diff --git a/THIRD PARTY NOTICE.txt b/.github/THIRD PARTY NOTICE.txt similarity index 100% rename from THIRD PARTY NOTICE.txt rename to .github/THIRD PARTY NOTICE.txt diff --git a/LICENSE.md b/LICENSE.md index b515ac4a..b8e4424c 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -119,3 +119,156 @@ We allow our users to create and publish Submerged content or videos to any webs
  • Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this License.
  • Exemptions from this License or alternative licenses may be negotiated with the Licensor.
    • + + \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt deleted file mode 100644 index fa036551..00000000 --- a/LICENSE.txt +++ /dev/null @@ -1,181 +0,0 @@ -This mod is not affiliated with Among Us or Innersloth LLC, and the content contained -therein is not endorsed or otherwise sponsored by Innersloth LLC. Portions of the materials -contained herein are property of Innersloth LLC. © Innersloth LLC. - ---- - -VIDEO POLICY - -We allow and encourage our users to create and publish Submerged content or videos to -any websites, including YouTube, Twitch, and similar video sharing services, and also -monetize them. - ---- ---- ---- - -This is a human-readable summary of (and not a substitute for) the license. - -You may share, distribute, or include Submerged in your own modpack or mod downloads, under -the following conditions: -- You may not modify the Submerged assembly in any capacity. - - You may, however, use Harmony to patch the Submerged assembly, as long as your - modifications are for ensuring compatibility with other mods. -- You may not sell users the access to play on Submerged with your mod/modpack. Any -features your mod/modpack offers on the base-game maps cannot be paywalled for Submerged. - ---- - - - Copyright © 2020-2022 5UP AND ASSOCIATES - -By exercising the Licensed Rights (defined below), You accept and agree to be bound by the -terms and conditions of this license ("License"). To the extent this License may be -interpreted as a contract, You are granted the Licensed Rights in consideration of Your -acceptance of these terms and conditions, and the Licensor grants You such rights in -consideration of benefits the Licensor receives from making the Licensed Material available -under these terms and conditions. - - SECTION 1 – Definitions. - -a. Licensor means the individual(s) or entity(ies) granting rights under this Public -License. - -b. You means the individual or entity exercising the Licensed Rights under this Public -License. Your has a corresponding meaning. - -c. Licensed Material means the technological or artistic work, or other material to which -the Licensor applied this License. Screenshots and recordings of the Licensed Material are -not considered part of the Licensed Material. - -d. Licensed Rights means the rights granted to You subject to the terms and conditions of -this License and that the Licensor has authority to license. - -e. Exceptions means any exemptions to the License negociated between You and the Licensor. - -f. Limitations means any limitations to the License imposed on You by the Licensor. - -g. Share means to provide material to the public by any means or process, such as -redistribution, copying of digital files, uploading, and to make material available to the -public including in ways that members of the public may access the material from a place -and at a time individually chosen by them. - - - SECTION 2 – Scope. - -a. License grant - - 1. Subject to the terms and conditions of this Public License, the Licensor hereby - grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, but - revocable license to exercise the Licensed Rights in the Licensed Material, and - to Share the Licensed Material, in whole, for non-commercial purposes only. - - 2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and - Limitations apply to Your use, this Public License does not apply, and You do not - need to comply with its terms and conditions. - - 3. Term. The term of this Public License is specified in Section 5. - - 4. Downstream recipients. - A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed - Material automatically receives an offer from the Licensor to exercise the - Licensed Rights under the terms and conditions of this License. - B. No downstream restrictions. You may not offer or impose any additional or - different terms or conditions on the Licensed Material if doing so restricts - exercise of the Licensed Rights by any recipient of the Licensed Material. - - 5. No endorsement. Nothing in this Public License constitutes or may be construed as - permission to assert or imply that You are, or that Your use of the Licensed Material - is, connected with, or sponsored, endorsed, or granted official status by, the Licensor - or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). - - - SECTION 3 – License Conditions. - -Your exercise of the Licensed Rights is expressly made subject to the following conditions. - -a. Attribution; - - 1. If You Share the Licensed Material, You must: - A. retain the following if it is supplied by the Licensor with the Licensed Material: - i. identification of the creator(s) of the Licensed Material and any others - designated to receive attribution, in any reasonable manner requested by the - Licensor (including by pseudonym if designated); - B. a third party notice file; - C. a notice that refers to this License; - - 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on - the medium, means, and context in which You Share the Licensed Material. For example, - it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a - resource that includes the required information. - -b. No Modification. - - 1. If You Share the Licensed Material, You must: - A. not modify the files contained within the Licensed Material in any capacity, - such as digital modifications of the Licensed Material. - B. not modify the operation of the files contained within the Licensed Material by - any means, such as runtime DLL injection or patching, unless the modifications were - made with the intention of facilitating compatibility between the Licensed Material - and other software. - C. ensure that other software shared alongside the Licensed Material, if present, - does not include any features that are generally available, but require payment to - be used in conjunction with the Licensed Material. - - - SECTION 4 – Disclaimer of Warranties and Limitation of Liability. - -a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the -Licensor offers the Licensed Material as-is and as-available, and makes no representations -or warranties of any kind concerning the Licensed Material, whether express, implied, -statutory, or other. This includes, without limitation, warranties of title, merchantability, -fitness for a particular purpose, non-infringement, absence of latent or other defects, -accuracy, or the presence or absence of errors, whether or not known or discoverable. Where -disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply -to You. - -b. To the extent possible, in no event will the Licensor be liable to You on any legal theory -(including, without limitation, negligence) or otherwise for any direct, special, indirect, -incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages -arising out of this Public License or use of the Licensed Material, even if the Licensor has -been advised of the possibility of such losses, costs, expenses, or damages. Where a -limitation of liability is not allowed in full or in part, this limitation may not apply to -You. - -c. The disclaimer of warranties and limitation of liability provided above shall be -interpreted in a manner that, to the extent possible, most closely approximates an absolute -disclaimer and waiver of all liability. - - - SECTION 5 – Term and Termination. - -a. If You fail to comply with this License, then Your rights under this License terminate -automatically. - • Where Your right to use the Licensed Material has terminated under Section 5(a), it -reinstates: - 1. automatically as of the date the violation is cured, provided it is cured within 7 - days of Your discovery of the violation; or - 2. upon express reinstatement by the Licensor. - -b. The Licensor may choose to terminate Your rights under License at any time, without -specifying a reason. - • Where Your right to use the Licensed Material has terminated under Section 5(a), it -reinstates only upon express reinstatement by the Licensor. - -c. For the avoidance of doubt, the Sections 5(a) and 5(b) do not affect any right the -Licensor may have to seek remedies for Your violations of this License. - -d. The Licensor may offer the Licensed Material under separate terms or conditions; however, -doing so will not terminate this License. - -e. Sections 1, 4, 5, and 6 survive termination of this License. - - SECTION 6 – Other Terms and Conditions. - -a. The Licensor shall not be bound by any additional or different terms or conditions -communicated by You unless expressly agreed. - -b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated -herein are separate from and independent of the terms and conditions of this License. - -c. Exemptions from this License or alternative licenses may be negotiated with the Licensor. diff --git a/README.md b/README.md index 1add10a4..fcc9f62e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![Submerged](./Images/Icon.png) +![Submerged](./.github/Images/Icon.png) # Submerged @@ -21,57 +21,41 @@ Submerged is a mod for Among Us which adds a new map into the game. [See the trailer on YouTube](http://www.youtube.com/watch?v=gAX_mDOX4Pc) -![Screenshot 1](./Images/Screenshot-1.png) -![Screenshot 2](./Images/Screenshot-2.png) -![Screenshot 3](./Images/Screenshot-3.png) -![Screenshot 4](./Images/Screenshot-4.png) -![Screenshot 5](./Images/Screenshot-5.png) -![Screenshot 6](./Images/Screenshot-6.png) -![Screenshot 7](./Images/Screenshot-7.png) -![Screenshot 8](./Images/Screenshot-8.png) +![Screenshot 1](./.github/Images/Screenshot-1.png) +![Screenshot 2](./.github/Images/Screenshot-2.png) +![Screenshot 3](./.github/Images/Screenshot-3.png) +![Screenshot 4](./.github/Images/Screenshot-4.png) +![Screenshot 5](./.github/Images/Screenshot-5.png) +![Screenshot 6](./.github/Images/Screenshot-6.png) +![Screenshot 7](./.github/Images/Screenshot-7.png) +![Screenshot 8](./.github/Images/Screenshot-8.png) # Releases -Submerged is compatible with desktop releases of Among Us. This includes Steam, Epic Games and Itch.io. We do not support cracked versions of Among Us. +Submerged is compatible with desktop releases of Among Us. This includes Steam, Epic Games and itch.io. We do not support cracked versions of Among Us. The table below lists the most recent Submerged release for each Among Us version after `v2022.3.29` (for desktop platforms only). The changelog for each version can be found under the [Releases](https://github.com/SubmergedAmongUs/Submerged/releases) tab. | Among Us Version | Submerged Version | Links | |:-:|:-:|:-:| +| `v2023.7.12`
    `v2023.7.11` | `v2023.7.24` | [Download](https://github.com/SubmergedAmongUs/Submerged/releases/tag/v2023.7.24/) | +| `v2023.6.27`
    `v2023.6.13`
    `v2023.3.28`
    `v2023.2.28`
    `v2022.12.14`
    `v2022.12.8` | Unavailable | - | | `v2022.10.25` | `v2022.10.26` | [Download](https://github.com/SubmergedAmongUs/Submerged/releases/tag/v2022.10.26/) | -| `v2022.10.18` | - | Unavailable | +| `v2022.10.18` | Unavailable | - | | `v2022.9.20`
    `v2022.8.25`
    `v2022.8.24`
    `v2022.8.23` | `v2022.8.26` | [Download](https://github.com/SubmergedAmongUs/Submerged/releases/tag/v2022.8.26/) | | `v2022.7.12`
    `v2022.6.21` | `v2022.6.23` | [Download](https://github.com/SubmergedAmongUs/Submerged/releases/tag/v2022.6.23/) | | `v2022.4.19`
    `v2022.3.29` | `v2022.6.12` | [Download](https://github.com/SubmergedAmongUs/Submerged/releases/tag/v2022.6.12/) | -# Compatibility With Other Mods +# Dependencies -Note: Using Submerged with any other mods might cause bugs or issues, unless the developers of the those mods have ensured that their mod is compatible with Submerged. If you encounter problems while using Submerged with other mods, please contact the developers of those mods. +Submerged depends on the following mods and modding tools in order to function properly: -| Mod | ❔ | Status | -|-|:-:|:-:| -| [Reactor](https://github.com/nuclearpowered/reactor) | 🔗 | Required | -| [BetterTownOfUs](https://github.com/VincentVision/BetterTownOfUs) | ✅ | Supported | -| [ExtremeRoles](https://github.com/yukieiji/ExtremeRoles/) | ✅ | Supported | -| [LasMonjas](https://github.com/KiraYamato94/LasMonjas/) | ✅ | Supported | -| [TheOtherRoles](https://github.com/Eisbison/TheOtherRoles) | ✅ | Supported | -| [TheOtherRoles-GM-Haoming](https://github.com/haoming37/TheOtherRoles-GM-Haoming) | ✅ | Supported | -| [Town-Of-Us-R](https://github.com/eDonnes124/Town-Of-Us-R) | ✅ | Supported | -| [BetterCrewLink](https://github.com/OhMyGuus/BetterCrewLink) | 🟢 | Compatible
    (Partially Supported) | -| [RegionInstall](https://github.com/miniduikboot/Mini.RegionInstall) | 🟢 | Compatible | - -_If you are aware of the compatibility status of any mods not in this list, please let us know by [opening an issue](https://github.com/SubmergedAmongUs/Submerged/issues/new/choose/) or contacting us at `submergedamongus@gmail.com`._ - -If you are a mod developer, the [FOR MOD DEVELOPERS.md](./FOR%20MOD%20DEVELOPERS.md) file includes more information on how to make your mod compatible with Submerged. If you need any help with compatibility patches, feel free to contact us on Discord. You may also include and redistribute Submerged with your mod, under the terms of the [license](LICENSE.md). - -# Compatibility With Servers - -| Server | ❔ | Status | -|-|:-:|:-:| -| Officials | ✅ | Supported | -| [Impostor](https://github.com/Impostor/Impostor/) | ✅ | Supported | +| Mod | Version | +|-|:-:| +| [BepInEx](https://builds.bepinex.dev/projects/bepinex_be) (IL2CPP-win-x86) | `v6.0.0-be.671` | +| [Reactor](https://github.com/nuclearpowered/reactor) | `v2.2.0` | # Installation @@ -79,7 +63,7 @@ If you are a mod developer, the [FOR MOD DEVELOPERS.md](./FOR%20MOD%20DEVELOPERS This mod is only guaranteed to work on Windows operating systems. We have no plans on ensuring compatibility with Linux-based operating systems or Mac. -This mod has been tested and works with the Steam, Epic and itch.io versions of Among Us. We do not support or endorse using a pirated version of Among Us with Submerged. +This mod has been tested and works with the Steam, Epic and itch.io versions of Among Us. We do not support or endorse using a pirated version of Among Us with Submerged. ## Installation Steps @@ -87,7 +71,7 @@ This mod has been tested and works with the Steam, Epic and itch.io versions of 2. Navigate to your Among Us installation directory. 3. Extract the downloaded files there. Ensure that the `BepInEx` folder is located in the same folder as the `Among Us.exe` file (Check screenshot below). -![Folder Structure](./Images/Folder-Structure.png) +![Folder Structure](./.github/Images/Folder-Structure.png) 4. Run the game (Please note that the first launch might take some time). @@ -100,15 +84,15 @@ Submerged is available in the languages listed below. If you would like to help | Language | ❔ | Status | |-|:-:|:-:| | English | ✅ | - | -| Deutsch | ✅ | Fully Translated | -| Español | ✅ | Fully Translated | | Français | ✅ | Fully Translated | -| Nederlands | ✅ | Fully Translated | -| Português (Brasil) | ✅ | Fully Translated | -| Русский | ✅ | Fully Translated | | 日本語 | ✅ | Fully Translated | -| 简体中文 | ✅ | Fully Translated | +| Deutsch | ✅ | Fully Translated | | 繁體中文 | ✅ | Fully Translated | +| Español | 🟡 | Partially Translated | +| Nederlands | 🟡 | Partially Translated | +| Português (Brasil) | 🟡 | Partially Translated | +| Русский | 🟡 | Partially Translated | +| 简体中文 | 🟡 | Partially Translated | | Bisaya | ❌ | Not Translated | | Español (Latinoamérica) | ❌ | Not Translated
    (Using Español) | | Gaeilge | ❌ | Not Translated | @@ -116,6 +100,34 @@ Submerged is available in the languages listed below. If you would like to help | Português | ❌ | Not Translated | | 한국어 | ❌ | Not Translated | +# Compatibility + +This mod tries to touch as little as possible in order to be compatible with as many other mods as possible. However, if you encounter any issues while using Submerged alongside other mods, **please contact the developers of those mods first** before reaching out to us, as we will only investigate Submerged-related issues and not issues related to other mods. + +If you are a mod developer, the [FOR MOD DEVELOPERS.md](./.github/FOR%20MOD%20DEVELOPERS.md) file includes more information on how to make your mod compatible with Submerged. + +Submerged is compatible both with official servers and [Impostor](https://github.com/Impostor/Impostor) servers. + + + # Contributing Guidelines We are not accepting any contributions to Submerged at the moment, but you can [open an issue](https://github.com/SubmergedAmongUs/Submerged/issues/new/choose/) if you have a feature request, want to report a bug, or basically anything else. @@ -132,14 +144,15 @@ _This mod is not affiliated with Among Us or Innersloth LLC, and the content con For business inquiries, please contact us at `submergedamongus@gmail.com`. + # Credits - Project Lead - [5up](https://twitch.tv/5up/) - Developers - - [AlexejheroYTB](https://twitter.com/AlexejheroYTB/) + - [Alexejhero](https://github.com/Alexejhero/) - [arctic_zeph](https://twitter.com/arctic_zeph/) - - [associatedlogos](https://twitter.com/associatedlogos/) + - [probablyadnf](https://github.com/simonkellly/) - Map Design - [Axyn](https://twitter.com/itsAxyn/) - [Blaustoise](https://twitter.com/blaustoise/) @@ -152,6 +165,7 @@ For business inquiries, please contact us at `submergedamongus@gmail.com`. - [xiiyta](https://twitter.com/xiiyta/) - Technical Support - [cybershard](https://github.com/cybershard/) + - [js6pak](https://github.com/js6pak) - [Sanae6](https://twitter.com/Sanae6k/) - Additional Art - [acronmd](https://twitter.com/acronmd/)