diff --git a/AutomaticShipSystems/AutomaticShipSystems.csproj b/AutomaticShipSystems/AutomaticShipSystems.csproj index 9b4c26b..613fbde 100644 --- a/AutomaticShipSystems/AutomaticShipSystems.csproj +++ b/AutomaticShipSystems/AutomaticShipSystems.csproj @@ -4,7 +4,7 @@ AutomaticShipSystems - 0.0.0 + 0.0.1 true latest diff --git a/AutomaticShipSystems/BepInPlugin.cs b/AutomaticShipSystems/BepInPlugin.cs index 5c43212..585e47d 100644 --- a/AutomaticShipSystems/BepInPlugin.cs +++ b/AutomaticShipSystems/BepInPlugin.cs @@ -5,16 +5,9 @@ using System.Reflection; namespace AutomaticShipSystems { - internal static class MyPluginInfo - { - internal const string PLUGIN_GUID = "id107.automaticshipsystems"; - internal const string PLUGIN_NAME = "AutomaticShipSystems"; - internal const string PLUGIN_VERSION = "0.0.0"; - } - - [BepInPlugin(MyPluginInfo.PLUGIN_GUID, MyPluginInfo.PLUGIN_NAME, MyPluginInfo.PLUGIN_VERSION)] + [BepInPlugin(MyPluginInfo.PLUGIN_GUID, MyPluginInfo.USERS_PLUGIN_NAME, MyPluginInfo.PLUGIN_VERSION)] [BepInProcess("Void Crew.exe")] - [BepInDependency("VoidManager")] + [BepInDependency(VoidManager.MyPluginInfo.PLUGIN_GUID)] public class BepinPlugin : BaseUnityPlugin { internal static ManualLogSource Log; diff --git a/AutomaticShipSystems/GUI.cs b/AutomaticShipSystems/GUI.cs index 4bf8ff3..057d5c9 100644 --- a/AutomaticShipSystems/GUI.cs +++ b/AutomaticShipSystems/GUI.cs @@ -5,7 +5,7 @@ namespace AutomaticShipSystems { internal class GUI : ModSettingsMenu { - public override string Name() => "Automatic Ship Systems"; + public override string Name() => MyPluginInfo.USERS_PLUGIN_NAME; public override void Draw() { diff --git a/AutomaticShipSystems/MyPluginInfo.cs b/AutomaticShipSystems/MyPluginInfo.cs new file mode 100644 index 0000000..994dd81 --- /dev/null +++ b/AutomaticShipSystems/MyPluginInfo.cs @@ -0,0 +1,17 @@ +#pragma warning disable CS1591 +namespace AutomaticShipSystems +{ + //Auto-Generated File. Created by PreBuild.ps1 + public class MyPluginInfo + { + public const string PLUGIN_GUID = $"{PLUGIN_ORIGINAL_AUTHOR}.{PLUGIN_NAME}"; + public const string PLUGIN_NAME = "AutomaticShipSystems"; + public const string USERS_PLUGIN_NAME = "Automatic Ship Systems"; + public const string PLUGIN_VERSION = "0.0.1"; + public const string PLUGIN_DESCRIPTION = "Makes circuit breakers, thruster boosters, and trims self reset. Host side."; + public const string PLUGIN_ORIGINAL_AUTHOR = "18107"; + public const string PLUGIN_AUTHORS = "18107"; + public const string PLUGIN_THUNDERSTORE_ID = "VoidCrewModdingTeam/Automatic_Ship_Systems"; + } +} +#pragma warning restore CS1591 diff --git a/AutomaticShipSystems/ReleaseFiles/CHANGELOG.md b/AutomaticShipSystems/ReleaseFiles/CHANGELOG.md new file mode 100644 index 0000000..ffd91a3 --- /dev/null +++ b/AutomaticShipSystems/ReleaseFiles/CHANGELOG.md @@ -0,0 +1,6 @@ +## 0.0.1 +- Updated for Void Crew 0.27.0 (Update 5). +- Disables Progression when starting a session as host. + +## 0.0.0 +- Initial release. diff --git a/AutomaticShipSystems/ReleaseFiles/PluginInfo.config b/AutomaticShipSystems/ReleaseFiles/PluginInfo.config new file mode 100644 index 0000000..82e268a --- /dev/null +++ b/AutomaticShipSystems/ReleaseFiles/PluginInfo.config @@ -0,0 +1,52 @@ +[ReleaseProperties] +; Unique mod ID. Leave blank for auto GUID (OriginalAuthor.Name) +GUID= + +; The name of the mod, used for AutoGUID, AssemblyName, and anything else which needs a file-friendly name. Leave blank to Auto-Fill from existing data. +PluginName=AutomaticShipSystems + +; User friendly name of the mod. Used in MyPluginInfo.cs for names visible to users. Leave blank to Auto-Fill from the PluginName. +UserPluginName=Automatic Ship Systems + +; Thunderstore mod name/page link. Must only have characters [a-z A-Z 0-9 _]. Leave Blank to Auto-Fill based on UserPluginName with " " replaced with "_". +ThunderstorePluginName=Automatic_Ship_Systems + +; The current version of the mod. Used for File Version, BepinPlugin, Thunderstore manifest, and README. +PluginVersion=0.0.1 + +; Version of the game this mod is built for. Used for README +GameVersion=0.27.0 + +; The simple description of the mod, used for MyPluginInfo.cs, Thunderstore manifest, and Assembly descriptions. Must be less than 250 Characters. +PluginDescription=Makes circuit breakers, thruster boosters, and trims self reset. Host side. + +; The original author of the mod, used for auto GUID and MyPluginInfo.cs. +PluginOriginalAuthor=18107 + +; The various authors/editors of the mod, used for MyPluginInfo.cs. Leave blank to Auto-Fill from PluginOrignalAuthor +PluginAuthors= + +; WebpageLink - Used by manifest for thunderstore page. Can be left blank. +WebpageLink=https://github.com/Void-Crew-Modding-Team/AutomaticShipSystems + +; ThunderStore ID (https://thunderstore.io/c/void-crew/p/VoidCrewModdingTeam/VoidManager/ the section equivelant to 'VoidCrewModdingTeam/VoidManager'). Can be left blank, may be utilized by VoidManager for a future feature. +ThunderstoreID=VoidCrewModdingTeam/Automatic_Ship_Systems + +; Dependency Strings - Comma delineated, spacing or no spacing is okay. Used for README and manifest. +DependencyStrings= BepInEx-BepInExPack-5.4.2100, VoidCrewModdingTeam-VoidManager-1.2.2 + + +; PreBuild Execution Params +[PrebuildExecParams] + +; Throw error if icon.png does not exist. +IconError=true + +; Throw error if CHANGELOG is not updated. +ChangelogError=true + +; For output to project dir, use: "ProjectDir". For output to solution Dir, use: "SolutionDir". Leave blank to disable. All other input will use the given file path. +ProjectReadmeOutPath=SolutionDir + +; Output a zip after building. +ZipOutput=true \ No newline at end of file diff --git a/AutomaticShipSystems/ReleaseFiles/README_Template.md b/AutomaticShipSystems/ReleaseFiles/README_Template.md new file mode 100644 index 0000000..ec3aebe --- /dev/null +++ b/AutomaticShipSystems/ReleaseFiles/README_Template.md @@ -0,0 +1,47 @@ +[![](https://img.shields.io/badge/-Void_Crew_Modding_Team-111111?style=just-the-label&logo=github&labelColor=24292f)](https://github.com/Void-Crew-Modding-Team) +![](https://img.shields.io/badge/Game%20Version-[GameVersion]-111111?style=flat&labelColor=24292f&color=111111) +[![](https://img.shields.io/discord/1180651062550593536.svg?&logo=discord&logoColor=ffffff&style=flat&label=Discord&labelColor=24292f&color=111111)](https://discord.gg/g2u5wpbMGu "Void Crew Modding Discord") + +# [UserModName] + +Version [ModVersion] +For Game Version [GameVersion] +Developed by [Authors] +Requires: [Dependencies] + + +[Description] +Intended for solo players. + +--------------------- + +### 💡 Functions + +- Automatically fixes trims after 5 minutes of being inactive +- Automatically fixes circuit breakers after 30 seconds of being tripped +- Automatcally charges boosts 1 minute after fully discharged. +- GUI to disable features +- Disables progression when starting a session as host. + +### 🎮 Client Usage + +- Simply install +- Play as host +- Configure via GUI at F5 > Mod Settings > Automatic Ship Systems + +### 👥 Multiplayer Functionality + +- ✅ Host + - Only the host needs this mod. +- ✅ Session + - Marks the room as Mod_Session when hosting. + +--------------------- + +## 🔧 Install Instructions - **Install following the normal BepInEx procedure.** + +Ensure that you have [BepInEx 5](https://thunderstore.io/c/void-crew/p/BepInEx/BepInExPack/) (stable version 5 **MONO**) and [VoidManager](https://thunderstore.io/c/void-crew/p/VoidCrewModdingTeam/VoidManager/) installed. + +#### ✔️ Mod installation - **Unzip the contents into the BepInEx plugin directory** + +Drag and drop `[ModName].dll` into `Void Crew\BepInEx\plugins` \ No newline at end of file diff --git a/AutomaticShipSystems/ReleaseFiles/icon.png b/AutomaticShipSystems/ReleaseFiles/icon.png new file mode 100644 index 0000000..ea12d7c Binary files /dev/null and b/AutomaticShipSystems/ReleaseFiles/icon.png differ diff --git a/AutomaticShipSystems/VoidManagerPlugin.cs b/AutomaticShipSystems/VoidManagerPlugin.cs index 231ac69..5637cd2 100644 --- a/AutomaticShipSystems/VoidManagerPlugin.cs +++ b/AutomaticShipSystems/VoidManagerPlugin.cs @@ -18,8 +18,10 @@ namespace AutomaticShipSystems public override MultiplayerType MPType => MultiplayerType.Host; - public override string Author => "18107"; + public override string Author => MyPluginInfo.PLUGIN_AUTHORS; - public override string Description => "Makes circuit breakers, thruster boosters, and trims self reset"; + public override string Description => MyPluginInfo.PLUGIN_DESCRIPTION; + + public override string ThunderstoreID => MyPluginInfo.PLUGIN_THUNDERSTORE_ID; } } diff --git a/README.md b/README.md index 1f1df92..6add5e7 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,39 @@ [![](https://img.shields.io/badge/-Void_Crew_Modding_Team-111111?style=just-the-label&logo=github&labelColor=24292f)](https://github.com/Void-Crew-Modding-Team) -![](https://img.shields.io/badge/Game%20Version-0.26.3-111111?style=flat&labelColor=24292f&color=111111) +![](https://img.shields.io/badge/Game%20Version-0.27.0-111111?style=flat&labelColor=24292f&color=111111) [![](https://img.shields.io/discord/1180651062550593536.svg?&logo=discord&logoColor=ffffff&style=flat&label=Discord&labelColor=24292f&color=111111)](https://discord.gg/g2u5wpbMGu "Void Crew Modding Discord") -# AutomaticShipSystems +# Automatic Ship Systems -Version 0.0.0 -For Game Version 0.26.3 +Version 0.0.1 +For Game Version 0.27.0 Developed by 18107 -Requires VoidManager 1.1.7 +Requires: BepInEx-BepInExPack-5.4.2100, VoidCrewModdingTeam-VoidManager-1.2.2 +Makes circuit breakers, thruster boosters, and trims self reset. Host side. +Intended for solo players. + --------------------- -### 💡 Function - **Makes circuit breakers, thruster boosters, and trims self reset** +### 💡 Functions -- Intended for solo play +- Automatically fixes trims after 5 minutes of being inactive +- Automatically fixes circuit breakers after 30 seconds of being tripped +- Automatcally charges boosts 1 minute after fully discharged. +- GUI to disable features ### 🎮 Client Usage -- Install -- Configure at F5 > Mod Settings > Automatic Ship Systems +- Simply install +- Play as host +- Configure via GUI at F5 > Mod Settings > Automatic Ship Systems ### 👥 Multiplayer Functionality - ✅ Host - - This affects all players if the host has the mod + - Only the host needs this mod. +- ✅ Session + - Marks the room as Mod_Session when hosting. ---------------------