Configured for DocBuilder

This commit is contained in:
DragonFire47
2024-10-17 22:07:19 -07:00
parent 1ed3155281
commit 34cd7b0479
10 changed files with 149 additions and 23 deletions
@@ -4,7 +4,7 @@
<AssemblyName>AutomaticShipSystems</AssemblyName> <AssemblyName>AutomaticShipSystems</AssemblyName>
<Description> <Description>
</Description> </Description>
<Version>0.0.0</Version> <Version>0.0.1</Version>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks> <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
<LangVersion>latest</LangVersion> <LangVersion>latest</LangVersion>
<RestoreAdditionalProjectSources> <RestoreAdditionalProjectSources>
+2 -9
View File
@@ -5,16 +5,9 @@ using System.Reflection;
namespace AutomaticShipSystems namespace AutomaticShipSystems
{ {
internal static class MyPluginInfo [BepInPlugin(MyPluginInfo.PLUGIN_GUID, MyPluginInfo.USERS_PLUGIN_NAME, MyPluginInfo.PLUGIN_VERSION)]
{
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)]
[BepInProcess("Void Crew.exe")] [BepInProcess("Void Crew.exe")]
[BepInDependency("VoidManager")] [BepInDependency(VoidManager.MyPluginInfo.PLUGIN_GUID)]
public class BepinPlugin : BaseUnityPlugin public class BepinPlugin : BaseUnityPlugin
{ {
internal static ManualLogSource Log; internal static ManualLogSource Log;
+1 -1
View File
@@ -5,7 +5,7 @@ namespace AutomaticShipSystems
{ {
internal class GUI : ModSettingsMenu internal class GUI : ModSettingsMenu
{ {
public override string Name() => "Automatic Ship Systems"; public override string Name() => MyPluginInfo.USERS_PLUGIN_NAME;
public override void Draw() public override void Draw()
{ {
+17
View File
@@ -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
@@ -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.
@@ -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
@@ -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`
Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

+4 -2
View File
@@ -18,8 +18,10 @@ namespace AutomaticShipSystems
public override MultiplayerType MPType => MultiplayerType.Host; 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;
} }
} }
+19 -10
View File
@@ -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/-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") [![](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 Version 0.0.1
For Game Version 0.26.3 For Game Version 0.27.0
Developed by 18107 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 ### 🎮 Client Usage
- Install - Simply install
- Configure at F5 > Mod Settings > Automatic Ship Systems - Play as host
- Configure via GUI at F5 > Mod Settings > Automatic Ship Systems
### 👥 Multiplayer Functionality ### 👥 Multiplayer Functionality
- ✅ Host - ✅ 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.
--------------------- ---------------------