Merge pull request #6 from Timberborn-Modding-Central/rename

Renames for consistency of plural and clarity

README.md

@@ -1,74 +1,18 @@
 # TimberAPI
-Upcoming API to enable easier Timberborn modding
+Unofficial API to enable easier Timberborn modding
 
-*Currently has the following features:*
-1. Bind your code to Timberborn to allow Dependency Injection. Supports InGame, MainMenu, and MapEditor
-2. Listen to any event. Extend the Listener class and use `[OnEvent]`
-3. Add labels to localization
+### **Currently supported features:**
+1. Bind your code easily with depencency injection
+2. Event listening of any event to get triggered on in game actions
+3. A comprehensive UI component builder
+4. Asset injection, provide your own icons or even unity bundles
+5. Labels and localization support
 
-Wiki (with general Timberborn modding info too!
-[Wiki Link](https://github.com/Timberborn-Modding-Central/TimberAPI/wiki)
+## More Information can be found on the wiki
+**[Timberborn Modding Wiki](https://github.com/Timberborn-Modding-Central/TimberAPI/wiki)**
 
-*To use this API, add this BepInEx annotation:*
-`[BepInDependency("com.timberapi.timberapi")]`
+## TimberAPI Documentation
+**[Documentation for TimberAPI](https://github.com/Timberborn-Modding-Central/TimberAPI/wiki/TimberAPI-Feature-Guide)**
 
-## Dependency Injection:
-1. Create a configurator and bind your class:
-```
-public class ExampleConfigurator : IConfigurator {
-    public void Configure(IContainerDefinition containerDefinition) {
-        containerDefinition.Bind<ExampleListener>().AsSingleton();
-    }
-}
-```
-2. Register it with the game
-```
-TimberAPI.Dependencies.AddConfigurator(new ExampleConfigurator());
-```
-
-## Event Listening
-1. Extend the TimberAPI Listener class, which will automatically hook the eventbus
-2. Listen to an event with `[OnEvent`
-```
-public class ExampleListener : Listener {
-    [OnEvent]
-    public void OnDroughtStarted(DroughtStartedEvent droughtStartedEvent) {...}
-```
-3. Register your class with the game through a configurator (see Dependency Injection)
-
-## Localization Labels 
-1. Add a label
-```
-TimberAPI.Localization.AddLabel("ExampleMod.ToolGroups.ExampleToolGroup", "Example Label");
-```
-
-## UIBuilder
-1. Inject UIBuilder into a configurated class
-2. Build any visual element with the timberborn components
-```c#
-public UIBuilderFragmentExample(IUIBuilder builder)
-{
-    builder.CreateComponentBuilder()
-        .AddButton("First Button", name: "firstButton")
-        ...
-        .Build();
-}
-```
-
-## Asset loader
-1. Register asset to the game (default asset file location `assets`)
-2. Use the `IAssetLoader` to use the loaded assets, `IAssetLoader` will automatically be injected into binded classes
-```c#
-TimberAPI.AssetLoaderSystem.AddSceneAssets("TimberAPIExample", IAssetLoaderSystem.EntryPoint.InGame);
-```
-Custom asset root location:
-```c#
-TimberAPI.AssetLoaderSystem.AddSceneAssets("TimberAPIExample", IAssetLoaderSystem.EntryPoint.InGame, new []{ "assets", "ingame" });
-```
-```c#
-private readonly IAssetLoader _assetLoader;
-_assetLoader.Load<Sprite>("prefix/subfolder/filename/itemname")
-```
-
-
-See [ExamplePlugin](https://github.com/Timberborn-Modding-Central/TimberAPI/blob/main/TimberAPIExample/TimberApiExamplePlugin.cs) for more examples
+## Provided Sample Plugin with API examples
+**[Example Plugin](https://github.com/Timberborn-Modding-Central/TimberAPI/blob/main/TimberAPIExample/TimberApiExamplePlugin.cs)**

TimberAPI/AssetLoader/AssetLoaderSystem.cs → TimberAPI/AssetLoader/AssetRegistry.cs

@@ -10,7 +10,7 @@
 
 namespace TimberbornAPI.AssetLoader
 {
-    public class AssetLoaderSystem : IAssetLoaderSystem
+    public class AssetRegistry : IAssetRegistry
     {
         internal static SceneEntryPoint ActiveScene = SceneEntryPoint.Global;
 

TimberAPI/AssetLoader/AssetSystem/AssetLoader.cs

@@ -46,12 +46,12 @@ public T Load<T>(string prefix, string[] path, string fileName, string name) whe
         {
             try
             {
-                return AssetLoaderSystem.PluginRepository.FindByPrefix(prefix).AssetRepository
+                return AssetRegistry.PluginRepository.FindByPrefix(prefix).AssetRepository
                     .FindByPathAndFileName(path, fileName).AssetBundle.LoadAsset<T>(name);
             }
             catch (PrefixNotFoundException e)
             {
-                Console.WriteLine($"Given prefix ({e.Prefix}) was not found. did you load it in the correct scene: {AssetLoaderSystem.ActiveScene}");
+                Console.WriteLine($"Given prefix ({e.Prefix}) was not found. did you load it in the correct scene: {AssetRegistry.ActiveScene}");
                 Console.WriteLine(e.StackTrace);
                 throw;
             }
@@ -108,7 +108,7 @@ public T[] LoadAll<T>(string prefix, string[] path, string fileName) where T : U
         {
             try
             {
-                return AssetLoaderSystem.PluginRepository.FindByPrefix(prefix).AssetRepository
+                return AssetRegistry.PluginRepository.FindByPrefix(prefix).AssetRepository
                     .FindByPathAndFileName(path, fileName).AssetBundle.LoadAllAssets<T>();
             }
             catch (PrefixNotFoundException e)

TimberAPI/AssetLoader/IAssetLoaderSystem.cs → TimberAPI/AssetLoader/IAssetRegistry.cs

@@ -2,7 +2,7 @@
 
 namespace TimberbornAPI.AssetLoader
 {
-    public interface IAssetLoaderSystem
+    public interface IAssetRegistry
     {
         /// <summary>
         /// Adds assets to a scene that are placed in the assetLocation

TimberAPI/AssetLoader/Patches/SceneLoaderPatcher.cs

@@ -16,8 +16,8 @@ public static class ProjectConfiguratorPatch
         {
             private static void Postfix()
             {
-                TimberAPI.AssetLoaderSystem.LoadSceneAssets(SceneEntryPoint.Global);
-                TimberAPI.AssetLoaderSystem.LoadSceneAssets(SceneEntryPoint.MainMenu);
+                TimberAPI.AssetRegistry.LoadSceneAssets(SceneEntryPoint.Global);
+                TimberAPI.AssetRegistry.LoadSceneAssets(SceneEntryPoint.MainMenu);
             }
         }
 
@@ -73,8 +73,8 @@ private static class LoadHelper
              */
             internal static void LoadSceneAssets(SceneEntryPoint scene)
             {
-                TimberAPI.AssetLoaderSystem.UnloadSceneAssets(AssetLoaderSystem.ActiveScene);
-                TimberAPI.AssetLoaderSystem.LoadSceneAssets(scene);
+                TimberAPI.AssetRegistry.UnloadSceneAssets(AssetRegistry.ActiveScene);
+                TimberAPI.AssetRegistry.LoadSceneAssets(scene);
             }
         }
     }

TimberAPI/AssetLoader/PluginSystem/PluginRepository.cs

@@ -22,7 +22,7 @@ public PluginRepository()
         /// <exception cref="PrefixNotFoundException"></exception>
         public Plugin FindByPrefix(string prefix)
         {
-            Plugin modPlugin = _plugins.FirstOrDefault(plugin => plugin.Prefix == prefix && (plugin.LoadingScene == AssetLoaderSystem.ActiveScene
+            Plugin modPlugin = _plugins.FirstOrDefault(plugin => plugin.Prefix == prefix && (plugin.LoadingScene == AssetRegistry.ActiveScene
                 || plugin.LoadingScene == SceneEntryPoint.Global));
 
             if (modPlugin == null)

TimberAPI/Dependency/Dependencies.cs → TimberAPI/DependencyRegistry/DependencyRegistry.cs

@@ -7,17 +7,19 @@
 using TimberbornAPI.Common;
 using UnityEngine;
 
-namespace TimberbornAPI.Dependency
+namespace TimberbornAPI.DependencySystem
 {
     [HarmonyPatch]
-    public class Dependencies : IDependencies
+    public class DependencyRegistry : IDependencyRegistry
     {
         private static Dictionary<SceneEntryPoint, List<IConfigurator>> configuratorsByEntryPoint = new();
 
-        /**
-         * Install a Configurator into a scene to allow dependency injection
-         * The class must implement IConfigurator and can use Bind<>() to inject dependencies
-         */
+        /// <summary>
+        /// Install a Configurator into a scene to allow dependency injection
+        /// The class must implement IConfigurator and can use Bind<>() to inject dependencies
+        /// </summary>
+        /// <param name="configurator">The configurator class to inject, which does the binding</param>
+        /// <param name="entryPoint">Scene to bind to, defaults to InGame</param>
         public void AddConfigurator(IConfigurator configurator, SceneEntryPoint entryPoint = SceneEntryPoint.InGame)
         {
             if (entryPoint == SceneEntryPoint.Global)
@@ -35,39 +37,27 @@ public void AddConfigurator(IConfigurator configurator, SceneEntryPoint entryPoi
             }
         }
 
-        /**
-         * Inject configurators into MasterScene (InGame)
-         */
         [HarmonyPostfix]
         [HarmonyPatch(typeof(MasterSceneConfigurator), "Configure")]
-        static void InjectMasterScene(IContainerDefinition containerDefinition)
+        static void InjectIntoMasterScene(IContainerDefinition containerDefinition)
         {
             InstallAll(containerDefinition, SceneEntryPoint.InGame);
         }
 
-        /**
-         * Inject configurators into MainMenuScene
-         */
         [HarmonyPostfix]
         [HarmonyPatch(typeof(MainMenuSceneConfigurator), "Configure")]
-        static void InjectMainMenuScene(IContainerDefinition containerDefinition)
+        static void InjectIntoMainMenuScene(IContainerDefinition containerDefinition)
         {
             InstallAll(containerDefinition, SceneEntryPoint.MainMenu);
         }
 
-        /**
-         * Inject configurators into MapEditorScene
-         */
         [HarmonyPostfix]
         [HarmonyPatch(typeof(MapEditorSceneConfigurator), "Configure")]
-        static void InjectMapEditorScene(IContainerDefinition containerDefinition)
+        static void InjectIntoMapEditorScene(IContainerDefinition containerDefinition)
         {
             InstallAll(containerDefinition, SceneEntryPoint.MapEditor);
         }
 
-        /**
-         * Install all the configurators for the given entryPoint
-         */
         private static void InstallAll(IContainerDefinition containerDefinition, SceneEntryPoint entryPoint)
         {
             List<IConfigurator> configurators =

TimberAPI/DependencyRegistry/IDependencyRegistry.cs

@@ -0,0 +1,17 @@
+using Bindito.Core;
+using TimberbornAPI.Common;
+
+namespace TimberbornAPI.DependencySystem
+{
+    public interface IDependencyRegistry
+    {
+        /// <summary>
+        /// Install a Configurator into a scene to allow dependency injection
+        /// The class must implement IConfigurator and can use Bind<>() to inject dependencies
+        /// </summary>
+        /// <param name="configurator">The configurator class to inject, which does the binding</param>
+        /// <param name="entryPoint">Scene to bind to, defaults to InGame</param>
+        void AddConfigurator(IConfigurator configurator, SceneEntryPoint entryPoint = SceneEntryPoint.InGame);
+
+    }
+}

TimberAPI/Event/EventListener.cs

@@ -0,0 +1,29 @@
+using Bindito.Core;
+using Timberborn.SingletonSystem;
+
+namespace TimberbornAPI.EventSystem
+{
+    /// <summary>
+    /// Extend Event Listener class to automatically register event listening
+    /// Listen to any event with [OnEvent]
+    /// </summary>
+    /// <remarks>
+    /// You must also bind that class in a Configurator and add it with
+    /// TimberAPI.Dependency.AddConfigurator()
+    /// </remarks>
+    public abstract class EventListener : ILoadableSingleton
+    {
+        private EventBus _eventBus;
+
+        [Inject]
+        public void InjectDependencies(EventBus eventBus)
+        {
+            _eventBus = eventBus;
+        }
+
+        public void Load()
+        {
+            _eventBus.Register(this);
+        }
+    }
+}

TimberAPI/Localization/ILocalization.cs

@@ -1,10 +1,9 @@
 using System.Collections.Generic;
 
-namespace TimberbornAPI.Localizations
+namespace TimberbornAPI.LocalizationSystem
 {
     public interface ILocalization
     {
-
         /// <summary>
         /// Add a label into the current localization
         /// For use in DisplayNameLocKey, such as in ToolGroup

TimberAPI/Localization/Localization.cs

@@ -4,27 +4,28 @@
 using HarmonyLib;
 using Timberborn.Common;
 
-namespace TimberbornAPI.Localizations
+namespace TimberbornAPI.LocalizationSystem
 {
     [HarmonyPatch]
     public class Localization : ILocalization
     {
         private static Dictionary<string, string> labelsToInject = new();
 
-        /**
-         * Add a label into the current localization
-         * 
-         * Example: CreativeMode.ToolGroups.MapEditor : "Map editor tools" 
-         * For use in DisplayNameLocKey, such as in ToolGroup
-         */
+        /// <summary>
+        /// Add a label into the current localization
+        /// For use in DisplayNameLocKey, such as in ToolGroup
+        /// </summary>
+        /// <param name="key">The key to reference the label with later</param>
+        /// <param name="value">The localized label</param>
         public void AddLabel(string key, string value)
         {
             labelsToInject.Add(key, value);
         }
 
-        /**
-         * Add multiple labels into the current localization
-         */
+        /// <summary>
+        /// Add multiple labels into the current localization
+        /// </summary>
+        /// <param name="labels">Multiple key:value labels to add</param>
         public void AddLabels(Dictionary<string, string> labels)
         {
             labelsToInject.AddRange(labels);

TimberAPI/Localization/LocalizationRecord.cs

@@ -1,6 +1,6 @@
 using LINQtoCSV;
 
-namespace TimberbornAPI.Localizations
+namespace TimberbornAPI.LocalizationSystem
 {
     /// <summary>
     /// Timberborn code Timberborn.Localization.LocalizationRecord

TimberAPI/Localization/LocalizationRepository.cs

@@ -8,7 +8,7 @@
 using TimberbornAPI.Internal;
 using UnityEngine;
 
-namespace TimberbornAPI.Localizations
+namespace TimberbornAPI.LocalizationSystem
 {
     internal static class LocalizationRepository
     {