diff --git a/Nautilus/DocFX/template/styles/days_one.ttf b/Nautilus/DocFX/custom/public/days_one.ttf similarity index 100% rename from Nautilus/DocFX/template/styles/days_one.ttf rename to Nautilus/DocFX/custom/public/days_one.ttf diff --git a/Nautilus/DocFX/template/styles/main.css b/Nautilus/DocFX/custom/public/main.css similarity index 85% rename from Nautilus/DocFX/template/styles/main.css rename to Nautilus/DocFX/custom/public/main.css index d1d4d83e..717703dd 100644 --- a/Nautilus/DocFX/template/styles/main.css +++ b/Nautilus/DocFX/custom/public/main.css @@ -3,16 +3,12 @@ src: url("days_one.ttf"); } -[data-bs-theme=dark] .lang-diff { - background: #0d1117; -} - .lang-diff-rem { color: rgb(236, 89, 117); } .lang-diff-add { - color: rgb(62, 175, 124);; + color: rgb(62, 175, 124); } @media (min-width: 1600px) { diff --git a/Nautilus/Documentation/guides/sml2-to-nautilus.md b/Nautilus/Documentation/guides/sml2-to-nautilus.md index b415d3e2..816c8101 100644 --- a/Nautilus/Documentation/guides/sml2-to-nautilus.md +++ b/Nautilus/Documentation/guides/sml2-to-nautilus.md @@ -4,9 +4,11 @@ In this article, we will be talking about the necessary changes you must apply t ## Namespace The root namespace for Nautilus is not the same as SMLHelper 2.0. -
+
+
 - <RootNamespace>SMLHelper.V2</RootNamespace>
 + <RootNamespace>Nautilus</RootNamespace>
+
 

 
 ## Referencing
@@ -23,7 +25,8 @@ mentioned in your code.
 
 ### Handler.cs
 Following the handler interfaces change, the overly under-used `Handler` class will leave us in Nautilus
-
+
+
 // Handler.cs
 
 - namespace SMLHelper.V2
@@ -45,6 +48,7 @@ Following the handler interfaces change, the overly under-used `Handler` class w
 -         ...
 -     }
 
+
 
  
 
 ### BioReactorHandler
@@ -52,9 +56,11 @@ The `BioReactorHandler` class is removed in Nautilus because it only had one ver
 SML's entry point, it didn't get applied.  
   
 The following example demonstrates how you can implement the same functionality the `BioReactorHandler` class offered.
-
+
+
 - BioReactorHandler.SetBioreactorCharge(TechType.Peeper, 69f);
 + BaseBioReactor.charge[TechType.Peeper] = 69f;
+
 

 
 ### FishHandler
@@ -63,7 +69,8 @@ The `FishHandler` has been removed in Nautilus. At the time being, we have not a
 
 ### PDAEncyclopediaHandler And PDALogHandler  
 Beginning with Nautilus, both of these handler methods were moved to `PDAHandler` as they only had one method each.
-
+
+
 PDAEncyclopedia.EntryData entry = new PDAEncyclopedia.EntryData()
 {
   key = "SomeEncy",
@@ -76,13 +83,16 @@ PDAEncyclopedia.EntryData entry = new PDAEncyclopedia.EntryData()
 
 - PDALogHandler.AddCustomEntry("SomeLog", "SomeLanguageKey");
 + PDAHandler.AddLogEntry("SomeLog", "SomeLanguageKey");
+
 

 
 ### InGameMenuHandler
 The methods `InGameMenuHandler` class had have been moved to the `Nautilus.Utility` namespace and the class has been renamed to `SaveUtils`.
-
+
+
 - InGameMenuHandler.RegisterOnSaveEvent(() => ErrorMessage.AddMessage("We do be saving!"));
 + SaveUtils.RegisterOnSaveEvent(() => ErrorMessage.AddMessage("We do be saving!"));
+
 

 
 ## Enum Handlers
@@ -117,35 +127,44 @@ Below we will talk about the necessary changes you will need to make your custom
 
 
 ### Configuring Custom TechType Objects
-
+
+
 - TechType customTech = TechTypeHandler.AddTechType("CustomTech", "Custom Tech", "Custom Tech that makes me go yes.", SpriteManager.Get(TechType.Titanium), unlockedAtStart: false);
 + TechType customTech = EnumHandler.AddEntry<TechType>("CustomTech")
 +             .WithPdaInfo("Custom Tech", "Custom Tech that makes me go yes.", unlockedAtStart: false)
 +             .WithIcon(SpriteManager.Get(TechType.Titanium));
+
 

 
 ### Configuring Custom CraftData.BackgroundType Objects
-
+
+
 - CraftData.BackgroundType customBG = BackgroundTypeHandler.AddBackgroundType("CustomBackground", SpriteManager.GetBackground(TechType.Battery));
 + CraftData.BackgroundType customBG = EnumHandler.AddEntry<CraftData.BackgroundType>("CustomBackground")
 +             .WithBackground(SpriteManager.GetBackground(TechType.Battery));
+
 

 
 ### Configuring Custom EquipmentType Objects
-
+
+
 - EquipmentType customEquipment = EquipmentHandler.AddEquipmentType("CustomEquipment");
 + EquipmentType customEquipment = EnumHandler.AddEntry<EquipmentType>("CustomEquipment");
+
 

 
 ### Configuring Custom PingType Objects
-
+
+
 - PingType customPing = PingHandler.RegisterNewPingType("CustomPing", SpriteManager.Get(SpriteManager.Group.Pings, PingType.Signal.ToString()));
 + PingType customPing = EnumHandler.AddEntry<PingType>("CustomPing")
 +             .WithIcon(SpriteManager.Get(SpriteManager.Group.Pings, PingType.Signal.ToString()));
+
 

 
 ### Configuring Custom TechCategory and TechGroup Objects
-
+
+
 - TechGroup customGroup = TechGroupHandler.AddTechCategory("CustomGroup", "Custom Group");
 + TechGroup customGroup = EnumHandler.AddEntry<TechCategory>("CustomGroup").WithPdaInfo("Custom Group");
 
@@ -153,15 +172,18 @@ Below we will talk about the necessary changes you will need to make your custom
 - TechCategoryHandler.TryRegisterTechCategoryToTechGroup(customGroup, customCategory);
 + TechCategory customCategory = EnumHandler.AddEntry<TechCategory>("CustomCategory").WithPdaInfo("Custom Group")
 +             .RegisterToTechGroup(customGroup);
+
 

 
 ### Configuring Custom CraftTree.Type Objects
-
+
+
 - ModCraftTreeRoot root = CraftTreeHandler.CreateCustomCraftTreeAndType(CustomTree, out CraftTree.Type customTree);
 + CraftTree.Type customTree = EnumHandler.AddEntry<CraftTree.Type>("CustomTree")
 +             .CreateCraftTreeRoot(out ModCraftTreeRoot root);
 
 root.AddTabNode("SomeTab");
+
 

 
 ___
@@ -512,7 +534,8 @@ Since we discovered the best practices and better ways to deal with custom sound
 Beginning with Nautilus, all custom sounds will require a bus instead of a SoundChannel to determine the effects (E.G: reverb, muffling, low-pass, etc..) and the volume slider.  
 Additionally, the `PlaySound` signature was also modified and renamed to `TryPlaySound`.
 
-
+
+
 - Channel channel = AudioUtils.PlaySound(soundPath, SoundChannel.Music);
 + if (AudioUtils.TryPlaySound(soundPath, AudioUtils.BusPaths.Music, out Channel channel))
 + {
@@ -540,6 +563,7 @@ Additionally, the `PlaySound` signature was also modified and renamed to `TryPla
 +   // do something with channel
 + }
 
+
 

 
 > [!WARNING]
diff --git a/Nautilus/docfx.json b/Nautilus/docfx.json
index 8f09e998..f0f2cdc4 100644
--- a/Nautilus/docfx.json
+++ b/Nautilus/docfx.json
@@ -66,7 +66,7 @@
     "template": [
        "default",
        "modern",
-       "DocFX/template"
+       "DocFX/custom"
     ]
   }
 }
\ No newline at end of file