documentation edits

Sewer56 · Mar 26, 2024 · 7006264 · 7006264
1 parent 078ed55
commit 7006264
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 2 deletions.
diff --git a/README-LOADER.md b/README-LOADER.md
@@ -26,6 +26,6 @@ For more information, [please visit the documentation](https://sewer56.dev/p5rpc
 - Lipsum (zarroboogs): Original Implementation  
 - CherryCreamSoda: Project Logo  
 - Shujynx, Covfefe: Mod Test Data  
-- AnimatedSwine37: PAK Merging  
+- AnimatedSwine37: PAK and BF Merging  
 - Secre-C: SPD Merging  
 - oceanstuck: BMD Merging
diff --git a/docs/index.md b/docs/index.md
@@ -43,6 +43,6 @@ Refer to the [usage section](./usage.md).
 - Lipsum (zarroboogs): Original Implementation  
 - CherryCreamSoda: Project Logo  
 - Shujynx, Covfefe: Mod Test Data  
-- AnimatedSwine37: PAK Merging  
+- AnimatedSwine37: PAK and BF Merging  
 - Secre-C: SPD Merging  
 - oceanstuck: BMD Merging
diff --git a/docs/usage.md b/docs/usage.md
@@ -223,6 +223,41 @@ Then follow the steps for loose spds.
 
 ![SpdPakedExample2](./images/SpdPakedExample2.png)
 
+## Editing SPD Files
+
+!!! info
+
+    Essentials can be used to edit textures and sprites in SPD files such that multiple mods can edit sprites in the same texture.
+
+[Uses FileRedirectionFramework under the hood, follow instructions here for more information.](https://sewer56.dev/FileEmulationFramework/emulators/spd.html)  
+Don't add dependency on SPD emulator (it's not necessary), but do follow rest of guide.
+
+In addition to the sprite entry files `(.spdspr/.sprt)` and/or textures `(.dds/.tmx)` files you include in `FEmulator\SPD` per the above guide you may need to add dummy spd files where they would normally go in `FEmulator\PAK` (only if the spd you're editing is located in an archive).
+
+### Example - Loose SPD
+
+To edit the loose `CHAT.SPD` file in `FONT\CHAT` you would first create a directory mimicking the path of the spd in `FEmulator\SPD`, including the spds filename.
+
+![SpdLooseExample1](./images/SpdLooseExample1.png)
+
+Then you would put your sprite entry and/or texture files in `FEmulator\SPD\FONT\CHAT\CHAT.SPD\`
+
+![SpdLooseExample2](./images/SpdLooseExample2.png)
+
+### Example - SPD in archive
+
+!!! info
+
+    To create a dummy spd file you can create a new empty text file and just rename it, changing the file extension.
+
+To edit `higawari_common.spd` in the archive `CALENDAR\HIGAWARI.PAK` you would first add a dummy spd file in `FEmulator\PAK\CALENDAR\HIGAWARI.PAK` (as per [the information above](#replacing-files-in-archives))
+
+![SpdPakedExample1](./images/SpdPakedExample1.png)
+
+Then follow the steps for loose spds.
+
+![SpdPakedExample2](./images/SpdPakedExample2.png)
+
 ## Releasing/Uploading your Mods
 
 Please refer to the [Reloaded wiki](https://reloaded-project.github.io/Reloaded-II/EnablingUpdateSupport/), and follow the guidance.