Differences

This shows you the differences between two versions of the page.

--- modding:replacing_images [2021/09/16 20:30]
kodicraft4 created
+++ modding:replacing_images [2021/09/17 16:03] (current)
kodicraft4 [Generating an image delta] Added link to file-types
@@ Line 47: / Line 47: @@
 //Note: Certain enemies, notably enemies that can feel more emotions than just SAD, ANGRY and HAPPY will have more vertical sprites in their image//
-====== Putting the images in a mod ======
+===== Putting the images in a mod =====
 After editing your images, you must put them in your **mod folder** under the same path relative to your decrypted ''/www/'', for instance, if you have edited the image in ''www_playtest_01234567/img/sv_actors/!battle_bun_bunny.png'', you must put that image in ''www/mods/<yourmodID>/img/sv_actors/!battle_bun_bunny.png''.
@@ Line 71: / Line 71: @@
  And done! Your modified file should now appear in game in the place that you replaced.
-TODO: Talk about image deltas.
+====== Image Deltas ======
+Image deltas are a special type of file introduced in [[:installing_oneloader|OneLoader]] V1.0.0. They provide a new way to edit images in your mods, by storing the difference between the original image and the new one. While this technique takes a bit of time to load when the game starts, image deltas can be stacked on top of each other allowing for greater compatibility between different asset changing mods.
+It is often recommended to use image deltas instead of replacing images if you are only changing a small part of an image, for instance if you are adding an accessory or a detail to a face.
+===== Generating an image delta =====
+To generate an image delta, simply follow the following steps
+  - Visit the [[https://rph.space/olid/generator.html|OLID generator]]
+{{:modding:olid_generator.png?400|}}
+  - Upload the original unmodified file as the //Source file//
+  - Upload the modified file as the //Target file//
+  - Press process
+You will be given a [[modding:file-types#.olid_-_OneLoaderImageDelta|.olid file]]. To verify if your file works, use the [[https://rph.space/olid/applier.html|delta applier]] with the original unmodified file as the //Source file//
+===== Applying an image delta =====
+Putting an image delta in an OMORI mod is similar to [[modding:replacing_images#Putting the images in a mod|replacing raw images]], however it does take a few more steps
+  - Put your olid file anywhere in your **mod folder** and take note of its path
+  - Add the entry ''"do_olid"'' to the ''"_flags"'' array in your ''mod.json'' file. If you do not have that array, create it.
+  - Add an entry with the syntax ''{"patch":"img/<folder>/<original image file>.png", "with":"<path/to/olid/file>.olid"}'' to the ''"image_deltas"'' array in your ''mod.json file''. If you do not have that array, create it.
+For instance, if you have modified the file ''img/sv_actors/!battle_bun_bunny.png'' and your .olid file is stored in ''/<yourmodID>/olid/!battle_bun_bunny.olid'', your ''mod.json'' file should look similar to this:
+<code json>
+{
+    "id": "yourmodID",
+    "name": "Your mod's name",
+    "description": "A longer description for your mod",
+    "version": "1.0",
+    "_flags":[
+      "do_olid"
+      ]
+    "files": {
+      "plugins": [],
+      "text": [],
+      "data": [],
+      "maps": [],
+      "assets": [],
+      "exec": [],
+      "image_deltas": [
+        {"patch":"img/sv_actors/!battle_bun_bunny.png", "with":"/<yourmodID>/olid/!battle_bun_bunny.olid"}
+       ]
+    }
+  }
+ </code>
+And done! Your modified file should now appear in game in the place that you replaced.

mods.one modding wiki

User Tools

Site Tools

Differences

Page Tools