Submerged v2022.5.1

Co-Authored-By: Simon Kelly <[email protected]>
Co-Authored-By: natsu-k <[email protected]>

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Version (please complete the following information):**
+ - Among Us: [e.g. 2022.3.29s]
+ - Submerged: [e.g. 2022.4.9s]
+
+**Log file**
+Please attach the log file located in BepInEx/LogOutput.log
+If you have restarted your game since you last encountered the issue, please try to reproduce the issue again and then upload the log.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/submit_translation.md

@@ -0,0 +1,17 @@
+---
+name: Submit translation
+about: Help us translate Submerged to other languages
+title: ''
+labels: translation
+assignees: ''
+
+---
+
+**What language(s) do you want to help us with?**
+Let us know what language(s) you want to translate Submerged into.
+
+**How can we contact you?**
+Please leave an email or Discord tag that we can reach you at.
+
+**Additional information**
+Add any other information here.

FOR MOD DEVELOPERS.md

@@ -0,0 +1,121 @@
+# 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.
+
+<br>
+
+# Networking-related IDs used by Submerged
+
+- SpawnablePrefabs
+  - `9` - SubmarineStatus
+- RPCCalls
+  - `210` - SetCustomData
+  - `211` - RequestChangeFloor
+  - `212` - AcknowledgeChangeFloor
+  - `213` - EngineVent
+  - `214` - OxygenDeath
+- Systems
+  - `130` - SubmarineOxygenSystem
+  - `136` - SubmarineElevatorSystem (WestLeft)
+  - `137` - SubmarineElevatorSystem (WestRight)
+  - `138` - SubmarineElevatorSystem (EastLeft)
+  - `139` - SubmarineElevatorSystem (EastRight)
+  - `140` - SubmarineElevatorSystem (Service)
+  - `141` - SubmarinePlayerFloorSystem
+  - `142` - SubmarineSecuritySabotageSystem
+  - `143` - SubmarineSpawnInSystem
+  - `144` - SubmarineBoxCatSystem
+
+# Commonly Conflicting Classes
+
+## `SubmergedDeadBody`
+
+<u>When playing on Submerged</u>, if a player dies their dead body receives a `SubmergedDeadBody` component. This component handles the shadow of the dead body as seen in Lower Central, and moving the dead body between floors if it is in an elevator.
+
+This system might conflict with mods that change the position of dead bodies (for example, an Undertaker role). 
+
+Location: `Submerged.Map.MonoBehaviours.SubmergedDeadBody`
+
+<br>
+
+# Commonly Conflicting Patches
+
+## `float PlatformConsole.CanUse(GameData.PlayerInfo pc, out bool canUse, out bool couldUse)`
+
+<u>When playing on Submerged</u>, this method is comptetely overwritten by the mod, as PlatformConsole is used for elevators. 
+
+This patch may conflict with mods that patch consoles in order to modify who can use them.
+
+Location: `Submerged.Systems.CustomSystems.Elevator.Patches.PlatformConsole_CanUse_Patch`
+
+<br>
+
+## `float ShipStatus.CalculateLightRadius(GameData.PlayerInfo player)`
+
+<u>When playing on Submerged</u>, the `float ShipStatus.CalculateLightRadius(GameData.PlayerInfo player)` method is patched to execute `float SubmarineStatus.CalculateLightRadius(GameData.PlayerInfo player)` instead of its default implementation. This method is used by the mod to play the light flicker animation when lights are sabotaged, and to play the sounds as well.
+
+This system **WILL** conflict with any mods that modify the light radius of players.
+
+Location: `Submerged.Map.Patches.ShipStatus_CalculateLightRadius_Patch`
+
+<br>
+
+## `void ArrowBehaviour.Update()`
+
+<u>When playing on Submerged</u>, this method is completely overwritten by the mod to make arrows point to the nearest elevator if their target is on the other floor.
+
+This patch may work incorrectly with mods that make use of custom arrow behaviours, since those might not be affected by this.
+
+Location: `Submerged.Minigames.Patches.ArrowBehaviour_Update_Patch`
+
+<br>
+
+## `void Console.Use()`
+
+<u>When playing on Submerged</u>, this method is completely overwritten by the mod to check if the player is trying to open the Fix Wiring task in Electrical, and provide the 8-wires minigame instead of the 4-wires one.
+
+This patch may conflict with mods that patch consoles in order to modify who can use them.
+
+Location: `Submerged.Minigames.CustomMinigames.FixWiring.Patches.Console_Use_Patch`
+
+<br>
+
+## `void ExileController.Begin(GameData.PlayerInfo exiled, bool tie)`
+
+<u>When playing on Submerged</u>, this method is completely overwritten by the mod. Most of the code is the same, but there are some Submerged-specific calls which are added to the method.
+
+This patch may conflict with mods that patch the exile cutscene in order to show the role name of the person who died.
+
+Location: `Submerged.ExileCutscene.Patches.ExileController_Begin_Patch`
+
+<br>
+
+## `void PlatformConsole.Use()`
+
+<u>When playing on Submerged</u>, this method is comptetely overwritten by the mod, as PlatformConsole is used for elevators. 
+
+This patch may conflict with mods that patch consoles in order to modify who can use them.
+
+Location: `Submerged.Systems.CustomSystems.Elevator.Patches.PlatformConsole_Use_Patch`
+
+<br>
+
+## `void Vent.CanUse(GameData.PlayerInfo pc, out bool canUse, out bool couldUse)`
+
+<u>When playing on Submerged</u>, this patch ensures that players cannot enter the one-way vent in Engines, and cannot exit the Central vents during the venting transition.
+
+This patch may conflict with mods that patch consoles in order to modify who can use them.
+
+Location: `Submerged.Map.Patches.Vent_CanUse_Patch`
+
+<br>
+
+## `void Vent.MoveToVent(Vent otherVent)`
+
+<u>When playing on Submerged</u>, this patch handles changing the floor when venting and offsetting the player camera when using either the Admin-Engines vents or the Central vents.
+
+This patch may conflict with mods that have custom actions when venting.
+
+**SUBMERGED AUTOMATICALLY HANDLES ANY CROSS-FLOOR VENTS, EVEN CUSTOM ONES!**
+
+Location: `Submerged.Map.Patches.Vent_MoveToVent_Patch`

LICENSE.md

@@ -0,0 +1,110 @@
+_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._
+
+---
+
+<strong>Video Policy</strong>
+
+We allow 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.
+
+---
+---
+---
+
+<i>This is a human-readable summary of (and not a substitute for) the license.</i>
+
+- <p>You may share, distribute, or include Submerged <i>non-commercially</i> in your own modpack or mod downloads, under the condition that you do not modify Submerged in any capacity, (including physically modifying the assembly or patching the mod) with the exception of ensuring compatibility between Submerged and your mod.</p>
+
+    - For clarification, you are still allowed to request payments, donations, etc. or have
+      premium-only features in your mod, but you may not sell users the access to play on
+      Submerged with your mod/modpack.
+
+- If Submerged stops being distributed, you must remove it from your mod/modpack as well.
+
+---
+
+<h3>Copyright © 2020-2022 5UP AND ASSOCIATES</h3>
+<p>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.</p>
+<p id="s1"><strong>Section 1 – Definitions.</strong></p>
+<ol type="a">
+<li id="s1g"><strong>Licensor</strong> means the individual(s) or entity(ies) granting rights under this Public License.</li>
+<li id="s1k"><strong>You</strong> means the individual or entity exercising the Licensed Rights under this Public License. <strong>Your</strong> has a corresponding meaning.</li>
+<li id="s1e"><strong>Licensed Material</strong> means the technological or artistic work, or other material to which the Licensor applied this License.</li>
+<li id="s1f"><strong>Licensed Rights</strong> means the rights granted to You subject to the terms and conditions of this License and that the Licensor has authority to license.</li>
+<li id="s1d"><strong>Exceptions</strong> means any exemptions to the License negociated between You and the Licensor.</li>
+<li id="s1d2"><strong>Limitations</strong> means any limitations to the License imposed on You by the Licensor.</li>
+<li id="s1i"><strong>Share</strong> 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.</li>
+</ol>
+<p id="s2"><strong>Section 2 – Scope.</strong></p>
+<ol type="a">
+<li id="s2a"><strong>License grant</strong>.
+<ol>
+<li id="s2a1">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.
+</li><li id="s2a2"><span style="text-decoration: underline;">Exceptions and Limitations</span>. 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.</li>
+<li id="s2a3"><span style="text-decoration: underline;">Term</span>. The term of this Public License is specified in Section <a href="#s5a">5(a)</a>.</li>
+<li id="s2a5"><span style="text-decoration: underline;">Downstream recipients</span>.
+<div class="para">
+<ol type="A">
+<li id="s2a5A"><span style="text-decoration: underline;">Offer from the Licensor – Licensed Material</span>. 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.</li>
+<li id="s2a5B"><span style="text-decoration: underline;">No downstream restrictions</span>. 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.</li>
+</ol>
+</div>
+</li><li id="s2a6"><span style="text-decoration: underline;">No endorsement</span>. 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 <a href="#s3a1Ai">3(a)(1)(A)(i)</a>.</li>
+</ol>
+</ol>
+<p id="s3"><strong>Section 3 – License Conditions.</strong></p>
+<p>Your exercise of the Licensed Rights is expressly made subject to the following conditions.</p>
+<ol type="a">
+<li id="s3a"><p><strong>Attribution</strong>;</p>
+<ol>
+<li id="s3a1"><p>If You Share the Licensed Material, You must:</p>
+<ol type="A">
+<li id="s3a1A">retain the following if it is supplied by the Licensor with the Licensed Material:
+<ol type="i">
+<li id="s3a1Ai">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);</li>
+<li id="s3a1Aii">a third party notice;</li>
+<li id="s3a1Aiii">a notice that refers to this License;</li>
+</ol>
+</li>
+</ol>
+</li>
+<li id="s3a2">You may satisfy the conditions in Section <a href="#s3a1">3(a)(1)</a> 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.</li>
+<li id="s3a3">If requested by the Licensor, You must remove any of the information required by Section <a href="#s3a1A">3(a)(1)(A)</a> to the extent reasonably practicable.</li>
+</ol>
+</li>
+<li><p><strong>No Modification</strong>.</p>
+<ol>
+<li id="s3a1"><p>If You Share the Licensed Material, You must:</p>
+<ol type="A">
+<li id="s3a1B">not modify the Licensed Material in any capacity, including digital modifications of the Licensed Material, and extensions or attachments to the Licensed Material which modify how the Licensed Material operates.</li>
+</ol>
+</ol>
+</ol>
+
+<p id="s4"><strong>Section 4 – Disclaimer of Warranties and Limitation of Liability.</strong></p>
+<ol style="font-weight: bold;" type="a">
+<li id="s4a"><strong>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.</strong></li>
+<li id="s4b"><strong>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.</strong></li>
+</ol>
+<ol start="3" type="a">
+<li id="s4c">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.</li>
+</ol>
+<p id="s5"><strong>Section 5 – Term and Termination.</strong></p>
+<ol type="a">
+<li id="s5a">If You fail to comply with this License, then Your rights under this License terminate automatically. The Licensor may also choose to terminate Your rights under License at any time, without specifying a reason.</li>
+<li id="s5b">
+<p>Where Your right to use the Licensed Material has terminated under Section <a href="#s5a">5(a)</a>, it reinstates:</p>
+<ol>
+<li id="s5b1">automatically as of the date the violation is cured, provided it is cured within 15 days of Your discovery of the violation; or</li>
+<li id="s5b2">upon express reinstatement by the Licensor.</li>
+</ol>
+For the avoidance of doubt, this Section <a href="#s5b">5(b)</a> does not affect any right the Licensor may have to seek remedies for Your violations of this License.</li>
+<li id="s5c">The Licensor may offer the Licensed Material under separate terms or conditions; however, doing so will not terminate this License.</li>
+<li>The Licensor may choose to stop distributing the Licensed Material at any time. In doing so, Your rights under License will be terminated unless they are expressly reinstated by the Licensor.</li>
+<li id="s5d">Sections <a href="#s1">1</a>, <a href="#s4">4</a>, <a href="#s5">5</a>, and <a href="#s6">6</a> survive termination of this License.</li>
+</ol>
+<p id="s6"><strong>Section 6 – Other Terms and Conditions.</strong></p>
+<ol type="a">
+<li id="s6a">The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.</li>
+<li id="s6b">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.</li>
+<li id="s6c">Exemptions from this License may be negotiated with the Licensor.</li>
+</ol>