Create build.sh

Added section for help, feature suggestions, and bug reports.

Core.cs

@@ -8,18 +8,33 @@ using VMM.ModRegistry.Settings;
 using VMM.ModRegistry.Settings.Types;
 using VMM.UI;
 
-[assembly: MelonInfo(typeof(VMM.Core), ModInfo.Name, ModInfo.Version, ModInfo.Author, null)]
+[assembly: MelonInfo(typeof(VMM.Core), ModInfo.Name, ModInfo.Version, ModInfo.Author, ModInfo.DownloadLink)]
 [assembly: MelonGame("Singularity Studios", "Vigil")]
 
 namespace VMM
 {
     internal class Core : MelonMod
     {
-        public static MelonLogger.Instance Logger { get; private set; }
+        public static MelonLogger.Instance Logger
+        {
+            get
+            {
+                if (_logger != null)
+                {
+                    return _logger;
+                }
+                else
+                {
+                    throw new System.Exception("Logger instance is not initialized yet.");
+                }
+            }
+        }
+
+        private static MelonLogger.Instance _logger;
 
         public override void OnInitializeMelon()
         {
-            Logger = LoggerInstance;
+            _logger = LoggerInstance;
             LoggerInstance.Msg("Initialized.");
         }
 

ModInfo.cs

@@ -7,8 +7,8 @@ namespace VMM
     internal class ModInfo
     {
         public const string Name = "VigilModManager";
-        public const string Version = "1.0.0";
+        public const string Version = "1.0.1";
         public const string Author = "Exil_S";
-        public const string DownloadLink = "";
+        public const string DownloadLink = "https://github.com/ExilProductions/VigilModManager";
     }
 }

README.md

@@ -6,6 +6,13 @@ A mod manager for the game Vigil that provides an in-game interface for managing
 
 *The mod is built using Melonloader 7.1*
 
+## Showcase
+
+### Mod Button in Main Menu
+![Mod Button](Assets/ModButton.PNG)
+
+### Mod Management Interface
+![Mod Menu](Assets/ModMenu.PNG)
 
 ## Installation
 
@@ -61,7 +68,7 @@ var sliderSetting = new SliderSetting
 settings.AddSetting(sliderSetting);
 
 // Register settings with the manager
-VMM.Core.ModManager.Instance.RegisterSettings(Assembly.GetExecutingAssembly(), settings);
+VMM.ModRegistry.ModManager.Instance.RegisterSettings(Assembly.GetExecutingAssembly(), settings);
 ```
 
 
@@ -70,10 +77,13 @@ VMM.Core.ModManager.Instance.RegisterSettings(Assembly.GetExecutingAssembly(), s
 ### Building
 
 1. Set the `VIGIL_GAME_DIR` environment variable to your Vigil installation directory
-    - Example: `setx VIGIL_GAME_DIR "E:\Steam\steamapps\common\Vigil"`
+    - Example Windows: `setx VIGIL_GAME_DIR "E:\Steam\steamapps\common\Vigil"`
 2. Build the project using Visual Studio or `dotnet build`
 3. The post-build event automatically copies the compiled DLL to the game's Mods folder
 
+### Need help, suggest a feature or found a bug?
+Open up a issue and tag it with the fitting tags
+
 ## License
 
 This project is licensed under the Apache License 2.0. See LICENSE.txt for the full license text.

VMM.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 	<PropertyGroup>
 		<TargetFramework>netstandard2.1</TargetFramework>
 		<ImplicitUsings>enable</ImplicitUsings>
@@ -9,12 +9,13 @@
 		<AssemblyVersion>1.0.0.0</AssemblyVersion>
 		<FileVersion>1.0.0.0</FileVersion>
 		<NeutralLanguage>en-US</NeutralLanguage>
-		<AssemblyName>VigilModManagerML</AssemblyName>
+		<AssemblyName>VigilModManager</AssemblyName>
 		<LangVersion>latest</LangVersion>
 		<ImplicitUsings>enable</ImplicitUsings>
 	</PropertyGroup>
 	<ItemGroup>
 	  <Compile Include="Core.cs" />
+	  <Compile Include="ModInfo.cs" />
 	  <Compile Include="ModRegistry\ModEntry.cs" />
 	  <Compile Include="ModRegistry\ModManager.cs" />
 	  <Compile Include="ModRegistry\Settings\ISettingsElement.cs" />
@@ -392,6 +393,14 @@
 	</PropertyGroup>
 
 	<Target Name="PostBuild" AfterTargets="PostBuildEvent">
-		<Exec Command="COPY &quot;$(TargetPath)&quot; &quot;$(VIGIL_GAME_DIR)\Mods&quot;" />
+
+		<!-- Windows -->
+		<Exec Condition="'$(OS)' == 'Windows_NT'"
+			  Command="copy &quot;$(TargetPath)&quot; &quot;$(VIGIL_GAME_DIR)\Mods&quot;" />
+
+		<!-- Linux/Mac -->
+		<Exec Condition="'$(OS)' != 'Windows_NT'"
+			  Command="cp &quot;$(TargetPath)&quot; &quot;$(VIGIL_GAME_DIR)/Mods&quot;" />
 	</Target>
+
 </Project>

build.bat

@@ -0,0 +1,28 @@
+@echo off
+echo Building VigilModManager...
+
+
+if "%VIGIL_GAME_DIR%"=="" (
+    echo ERROR: VIGIL_GAME_DIR environment variable is not set!
+    echo Please set VIGIL_GAME_DIR to your Vigil game installation directory.
+    echo Example: set VIGIL_GAME_DIR=C:\Games\Vigil
+    pause
+    exit /b 1
+)
+
+echo Using Vigil game directory: %VIGIL_GAME_DIR%
+
+dotnet build VMM.csproj --configuration Release
+
+if %ERRORLEVEL% EQU 0 (
+    echo.
+    echo Build completed successfully!
+    echo The mod DLL has been copied to: %VIGIL_GAME_DIR%\Mods\
+) else (
+    echo.
+    echo Build failed! Please check the error messages above.
+    pause
+    exit /b 1
+)
+
+pause

build.sh

@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+
+# VigilModManager build script for Linux
+echo "Building VigilModManager..."
+
+# Check if VIGIL_GAME_DIR is set
+if [ -z "$VIGIL_GAME_DIR" ]; then
+    echo "ERROR: VIGIL_GAME_DIR environment variable is not set!"
+    echo "Please set VIGIL_GAME_DIR to your Vigil game installation directory."
+    echo "Example: export VIGIL_GAME_DIR=\$HOME/.local/share/Steam/steamapps/common/Vigil"
+    exit 1
+fi
+
+echo "Using Vigil game directory: $VIGIL_GAME_DIR"
+
+# Build the project
+dotnet build VMM.csproj --configuration Release
+BUILD_EXIT_CODE=$?
+
+if [ $BUILD_EXIT_CODE -eq 0 ]; then
+    echo
+    echo "Build completed successfully!"
+    MOD_DIR="$VIGIL_GAME_DIR/Mods"
+    mkdir -p "$MOD_DIR"
+    echo "The mod DLL has been copied to: $MOD_DIR"
+else
+    echo
+    echo "Build failed! Please check the error messages above."
+    exit 1
+fi
+
+read -rp "Press Enter to exit..."