readme update and some minor stuff

Author: FabForReal

Core/PackageRegister.cs Core/PackageRegistry.csCore/PackageRegister.cs renamed to Core/PackageRegistry.cs

@@ -3,20 +3,20 @@
 
 namespace EasyPackageAPI.Core;
 
-public static class PackageRegister
+public static class PackageRegistry
 {
     public static List<Package> Packages = [];
 
     // this is not really ideal imo and will break if an update adds new packages or another mod modifies the payloads array
     private const int baseIndex = 17; // current (1.12c) vanilla payloadmanager payload array length - 1
     private static int currentIndexCount = -1;
 
-    public static void RegisterPackage(GameObject package, string[] shops)
+    public static void Register(GameObject package, string[] shops)
     {
         Packages.Add(new Package(package, shops, AddIndex()));
     }
 
-    public static void RegisterPackage(GameObject package, string shop)
+    public static void Register(GameObject package, string shop)
     {
         Packages.Add(new Package(package, [shop] , AddIndex()));
     }

Core/PayloadLoader.cs

@@ -6,9 +6,9 @@ internal static class PayloadLoader
 {
     public static void Load(PayloadManager payloadManager)
     {
-        if (PackageRegister.Packages == null) return;
+        if (PackageRegistry.Packages == null) return;
 
-        foreach (Package p in PackageRegister.Packages)
+        foreach (Package p in PackageRegistry.Packages)
         {
             if (payloadManager.payloads.Contains(p.GameObject)) return;
 

Core/ShopLoader.cs

@@ -6,9 +6,9 @@ internal static class ShopLoader
 { 
      public static void Load(ShopInfo shopInfo)
      {
-         if (PackageRegister.Packages == null) return;
+         if (PackageRegistry.Packages == null) return;
 
-         foreach (Package p in PackageRegister.Packages)
+         foreach (Package p in PackageRegistry.Packages)
          {
              if (shopInfo.payloads.Contains(p.GameObject)) return;
 

EasyPackageAPI.csproj

@@ -8,7 +8,7 @@
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <LangVersion>latest</LangVersion>
     <EasyDeliveryPath>/home/fab/.local/share/Steam/steamapps/common/Easy Delivery Co/</EasyDeliveryPath>
-    <ModProfilePath>/home/fab/.local/share/com.kesomannen.gale/easy-delivery-co/profiles/Default/BepInEx/plugins/EasyPackageAPI/</ModProfilePath>
+    <ModProfilePath>/home/fab/.local/share/com.kesomannen.gale/easy-delivery-co/profiles/Default/BepInEx/plugins/</ModProfilePath>
       <RestoreAdditionalProjectSources>
           https://api.nuget.org/v3/index.json;
           https://nuget.bepinex.dev/v3/index.json;
@@ -52,6 +52,6 @@
   </ItemGroup>
 
   <Target Name="PostBuild" AfterTargets="PostBuildEvent">
-    <Exec Command="cp &quot;$(ProjectDir)bin/Debug/net472/EasyPackageAPI.dll&quot; &quot;$(ModProfilePath)/&quot;" />
+    <Exec Command="cp &quot;$(ProjectDir)bin/Debug/net472/EasyPackageAPI.dll&quot; &quot;$(ModProfilePath)/EasyPackageAPI/&quot;" />
   </Target>
-</Project>
+</Project>

README.md

@@ -1,15 +1,29 @@
 # EasyPackageAPI
 
-API for adding custom packages to easy delivery co.
+API for easily adding custom packages to easy delivery co.
 
-This mod does not add any packages of its own
+This mod does not add any packages of its own.
 
 ## How To Use
 
-### Example
+### Preamble
 
+The registering of a custom package with the API is extremely easy, however the setup for a creation 
+for a prefab is a quite tedious process.
+
+I'm not going into details for this rn, but basically you would need to do these things:
+1. Extract the assets using a tool from the game
+2. Create a Unity project and import the required assets for a package
+3. Use an existing prefab as a template and modify it however you want
+(makes it easier than recreating one from scratch)
+4. Export your package(s) as a Asset Bundle
+
+### Loading And Registering
+
+#### Example Plugin.cs
 ```csharp
 [BepInPlugin(MyPluginInfo.PLUGIN_GUID, MyPluginInfo.PLUGIN_NAME, MyPluginInfo.PLUGIN_VERSION)]
+[BepInDependency(EasyPackageAPI.MyPluginInfo.PLUGIN_GUID)]
 public class Plugin : BaseUnityPlugin
 {
     internal static ManualLogSource Log;
@@ -28,6 +42,7 @@ public class Plugin : BaseUnityPlugin
         RegisterPackages()
     }
 
+    // for loading your asset bundle. you can do this however you want
     private void LoadAssets()
     {
         // ideally put your assets in a assets sub directory but it can be anywhere
@@ -42,15 +57,16 @@ public class Plugin : BaseUnityPlugin
         packageTwo = myAssetBundle.LoadAsset<GameObject>("Package Two");
     }
 
+    // registering your packages
     private void RegisterPackages()
     {
         // add a package to multiple shops
-        PackageRegister.RegisterPackage(packageOne,
+        PackageRegistry.Register(packageOne,
             [Shops.Pawn_Shop, Shops.Easy_Depot,
                 Shops.Bar, Shops.EZ_Bakery, Shops.Easy_Flowers]);
 
         // add a package to one shop
-        PackageRegister.RegisterPackage(packageTwo, Shops.Easy_Depot);
+        PackageRegistry.Register(packageTwo, Shops.Easy_Depot);
     }
 }
 ```