Added Localization folder example

SubnauticaModding · Mar 27, 2023 · dc8c2b8 · dc8c2b8
1 parent 7ee825f
commit dc8c2b8
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 1 deletion.
diff --git a/Example mod/Example mod.csproj b/Example mod/Example mod.csproj
@@ -69,4 +69,13 @@
     <PackageReference Include="BepInEx.PluginInfoProps" Version="1.1.0" />
     <PackageReference Include="PolySharp" Version="1.12.1" />
   </ItemGroup>
+  <Target Name="CopyToOutputPath" AfterTargets="Build">
+    <ItemGroup>
+      <LocalizationFiles Include="Localization\*.*" />
+    </ItemGroup>
+    <Copy
+            SourceFiles="@(LocalizationFiles)"
+            DestinationFolder="$(OutDir)\Localization"
+            SkipUnchangedFiles="true" />
+  </Target>
 </Project>
diff --git a/Example mod/Localization/English.json b/Example mod/Localization/English.json
@@ -0,0 +1,4 @@
+{
+  "TitaniumClone": "Titanium Clone",
+  "Tooltip_TitaniumClone": "Titanium clone that makes me go yes."
+}
diff --git a/Example mod/Localization/Spanish.json b/Example mod/Localization/Spanish.json
@@ -0,0 +1,4 @@
+{
+  "TitaniumClone": "Clon de Titanio",
+  "Tooltip_TitaniumClone": "Clon de Titanio que me hace decir que sí"
+}
diff --git a/Example mod/LocalizationExample.cs b/Example mod/LocalizationExample.cs
@@ -33,12 +33,22 @@ public class LocalizationExample : BaseUnityPlugin
 
     private void Awake()
     {
+#if LOCALIZATION_FOLDER
+        /*
+         * Registers a folder as localization folder.
+         * This folder must contain json files that are named after the language they translate.
+         * For example, English translation must be named English.json and Spanish translation must be named Spanish.json.
+         * SML expects this folder to be located in the mod folder at ModName/Localization by default.
+         */
+        LanguageHandler.RegisterLocalizationFolder();
+#else
         // Register our English language entries to the English language
         LanguageHandler.RegisterLocalization("English", _languageEntriesEng);
 
         // Register our Spanish language entries to the Spanish language
         LanguageHandler.RegisterLocalization("Spanish", _languageEntriesEsp);
-
+#endif
+
         /*
          * Create a CustomPrefab instance for our Titanium Clone. Must be set to null or empty if you registered language entries
          * for them earlier like we did.