feat!: initial mod

README.md

@@ -1,11 +1,15 @@
-# Mod template
+# Peacock Strings
 
-To get started, customise manifest.json to your liking, then create a commit along the lines of `feat: initial mod`. If you're looking to integrate this into an existing mod you have, copy everything from that mod over to this template, create a commit such as `chore: transfer existing mod` and then tag that commit with the currently released version of the mod (the initial commit will still automatically be tagged 0.1.0, which is fine).
+Adds Peacock's strings to the game without the use of dynamic resources.
 
-This template will do everything for you, including versioning, generating changelogs and creating mod ZIPs; just make sure you follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0). If you want to have multiple new features in a release, just work in a branch and then merge it into the main branch once you want to release.
+**How to Update**
+To update this mod, you can get the latest version of `h3_locale.json` from the `resources` folder in the
+main [Peacock repository](https://github.com/thepeacockproject/Peacock) and replace `peacockstrings.locr.json`
+with it (keeping the file name `peacockstrings.locr.json`) and changing the `hash` to
+`[assembly:/localization/hitman6/conversations/ui/pro/online/peacock.sweetmenutext].pc_localized-textlist`.
 
-As a rule of thumb, anything that doesn't drastically alter the mod or make sweeping changes that could break other mods should be either an `enhancement` (for improvements to existing parts of the mod), `feat` (for new parts of the mod) or `fix` (for bugfixes). You can specify the part of the mod you're changing like so: `fix(epic feature): do this thing properly`.
+**Installation Instructions**
 
-If you do drastically alter the mod or make sweeping changes that could break other mods, add an exclamation mark just before the `:`, and write `BREAKING CHANGE: This thing is now this thing, which means this.` in the "description" or "footer" of the commit.
-
-An important note: the version for the mod starts at `0.1.0`, which means the mod is in development. When you finalise the mod for its first release, add an exclamation mark before the `:` and the version will automatically be bumped to `1.0.0`.
+1. Make sure the Simple Mod Framework is installed, you can find [it here](https://www.nexusmods.com/hitman3/mods/200/).
+2. Download the zip from the Releases tab and open the Mod Manager GUI, use the **Add a Mod** button and select the zip you just downloaded.
+3. Press **Apply** and enjoy your localised strings.

content/chunk0/menuresources.entity.patch.json

@@ -0,0 +1,27 @@
+{
+    "tempHash": "0093A0F6345CF59D",
+    "tbluHash": "000B130B701B0A23",
+    "patch": [
+        {
+            "AddEntity": [
+                "feed27a52810e9bc",
+                {
+                    "parent": "23b3aa5d63435ab4",
+                    "name": "Peacock",
+                    "factory": "[modules:/zuitextentity.class].pc_entitytype",
+                    "blueprint": "[modules:/zuitextentity.class].pc_entityblueprint",
+                    "properties": {
+                        "m_pTextListResource": {
+                            "type": "ZRuntimeResourceID",
+                            "value": {
+                                "resource": "[assembly:/localization/hitman6/conversations/ui/pro/online/peacock.sweetmenutext].pc_localized-textlist",
+                                "flag": "5F"
+                            }
+                        }
+                    }
+                }
+            ]
+        }
+    ],
+    "patchVersion": 6
+}