reorganise everything

bananaturtlesandwich · Aug 27, 2023 · 23fce04 · 23fce04
1 parent 52dbcc2
commit 23fce04
Show file tree

Hide file tree

Showing 60 changed files with 62 additions and 121 deletions.
diff --git a/src/Concepts/Paks.md b/src/Concepts/Paks.md
@@ -3,5 +3,5 @@
 - The game's main pak will always be contained in the `Content/Paks` directory
 - Pak files will sometimes be encrypted via AES keys, however these can be easilyfound  with [AESKeyFinder](https://zenhax.com/viewtopic.php?t=9407&start=20)
 - Pak files can also be split into chunks for a bit of extra security
-- Pak files are normally able to be viewed with [UEViewer](https://www.gildor.org/en/projects/umodel) or [Fmodel](https://fmodel.app/)
-- Pak files can be extracted using tools such as the ones found in [Pakers/Unpakers](../Tools/Pakers.md)
+- Pak files are normally able to be viewed with [umodel](https://www.gildor.org/en/projects/umodel) or [Fmodel](https://fmodel.app/)
+- Pak files can be extracted using tools such as the ones found in [Pakers/Unpakers](../tools/packers.md)
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -1,58 +1,56 @@
 # Summary
 
-[Home Page](Home.md)
+[Home Page](home.md)
 
 ---
 
 # Starting out
-- [The Basics](The-Basics/Basics.md)
-    - [Pak Decompression Options](The-Basics/Unpaking/Options.md)
-        - [QuickBMS](The-Basics/Unpaking/QuickBMS.md)
-        - [Using UnrealPak Directly](The-Basics/Unpaking/UnrealPak.md)
-        - [UEViewer/umodel](The-Basics/Unpaking/UEViewer.md)
-        - [FModel](The-Basics/Unpaking/FModel.md)
+- [The Basics](basics/basics.md)
+    - [Extraction](basics/unpacking/options.md)
+        - [umodel](basics/unpacking/umodel.md)
+        - [FModel](basics/unpacking/fmodel.md)
     - [Unreal Engine]()
-        - [Setting Up](The-Basics/Engine/Setting-Up.md)
-        - [Content Creation](The-Basics/Engine/Creation.md)
+        - [Setting Up](basics/engine/setup.md)
+        - [Content Creation](basics/engine/creation.md)
     - [Packaging]()
-        - [Cooking](The-Basics/Paking/Cooking.md)
-        - [Final Packaging](The-Basics/Paking/Final-Paking.md)
+        - [Cooking](basics/packing/cooking.md)
+        - [Final Packaging](basics/packing/packaging.md)
 
 - [Core UE4 Modding Concepts]()
-    - [Pak files](Concepts/Paks.md)
-    - [Mod Loading](Concepts/Loading.md)
-    - [Cooking](Concepts/Cooking.md)
-    - [Unreal files](Concepts/Files.md)
-    - [Dummying](Concepts/Dummying.md)
+    - [Pak files](concepts/paks.md)
+    - [Mod Loading](concepts/loading.md)
+    - [Cooking](concepts/cooking.md)
+    - [Unreal files](concepts/files.md)
+    - [Dummying](concepts/dummying.md)
 
 ---
 # Specific Guides
 - [Models (Whole section is WIP)]()
     - [Meshes]()
     - [Skeletons]()
-- [Disabling objects](Specific-Guides/Disabling/Disabling.md)
+- [Disabling objects](specific/disabling/disabling.md)
+- [Using UAssetGUI](specific/UAssetGUI.md)
 - [Materials]()
-    - [Via UAssetGUI](Specific-Guides/Materials/UAssetGUI.md)
-    - [In Engine](Specific-Guides/Materials/Engine.md)
-- [Text and Dialogue](Specific-Guides/Dialogue.md)
-- [Level Editing](Specific-Guides/Levels.md)
-- [Using UAssetGUI](Specific-Guides/UAssetGUI.md)
-- [Using UAssetAPI](Specific-Guides/UAssetAPI/UAssetAPI.md)
-- [Blueprint modding](Specific-Guides/Logic-Mods/Blueprint.md)
-    - [UML setup](Specific-Guides/Logic-Mods/UML-Setup.md)
-    - [.profile creation](Specific-Guides/Logic-Mods/Profile.md)
-    - [Project setup](Specific-Guides/Logic-Mods/Project-Setup.md)
-    - [Mod creation](Specific-Guides/Logic-Mods/Creation.md)
-    - [Installing](Specific-Guides/Logic-Mods/Installing.md)
-    - [Auto-Injector setup](Specific-Guides/Logic-Mods/Injector.md)
+    - [Via UAssetGUI](specific/materials/UAssetGUI.md)
+    - [In Engine](specific/materials/engine.md)
+- [Text and Dialogue](specific/dialogue.md)
+- [Level Editing](specific/levels.md)
+- [Using UAssetAPI](specific/UAssetAPI.md)
+// - [Blueprint modding](specific/blueprint/Blueprint.md)
+//     - [UML setup](specific/blueprint/UML-Setup.md)
+//     - [.profile creation](specific/blueprint/Profile.md)
+//     - [Project setup](specific/blueprint/Project-Setup.md)
+//     - [Mod creation](specific/blueprint/Creation.md)
+//     - [Installing](specific/blueprint/Installing.md)
+//     - [Auto-Injector setup](specific/blueprint/Injector.md)
 
 ---
 # Tools and Resources
 - [Tools]()
-    - [Pakers/Unpakers](Tools/Pakers.md)
-    - [Pak Explorers](Tools/Pak-Explorers.md)
-    - [UAsset Editors](Tools/Asset-Editors.md)
-    - [Locres Editors](Tools/Locres-Editors.md)
-- [Resources](Resources/Resources.md)
-    - [Discords](Resources/Discords.md)
-    - [Other Guides](Resources/Other-Guides.md)
+    - [Pakers/Unpakers](tools/packers.md)
+    - [Pak Explorers](tools/explorers.md)
+    - [UAsset Editors](tools/uasset.md)
+    - [Locres Editors](tools/locres.md)
+- [Resources](resources/resources.md)
+    - [Discords](resources/discords.md)
+    - [Other Guides](resources/guides.md)
diff --git a/src/The-Basics/Unpaking/QuickBMS-Extraction.png b/src/The-Basics/Unpaking/QuickBMS-Extraction.png
diff --git a/src/The-Basics/Unpaking/QuickBMS.md b/src/The-Basics/Unpaking/QuickBMS.md
diff --git a/src/The-Basics/Unpaking/QuickBMS.png b/src/The-Basics/Unpaking/QuickBMS.png
diff --git a/src/The-Basics/Unpaking/UnrealPak.md b/src/The-Basics/Unpaking/UnrealPak.md
diff --git a/src/The-Basics/Unpaking/unrealpak.png b/src/The-Basics/Unpaking/unrealpak.png
diff --git a/src/The-Basics/Basics.md → src/basics/basics.md b/src/The-Basics/Basics.md → src/basics/basics.md
diff --git a/src/The-Basics/Engine/UE4.png → src/basics/engine/content.png b/src/The-Basics/Engine/UE4.png → src/basics/engine/content.png
diff --git a/src/The-Basics/Engine/Creation.md → src/basics/engine/creation.md b/src/The-Basics/Engine/Creation.md → src/basics/engine/creation.md
@@ -4,9 +4,9 @@
 - For this example I will use my Fara discord shirt mod
 
 - In this mod I modified the texture for Fara so that it had a discord logo
-![](FaraTex.png)
+![](fara.png)
 
 - Recreate the folder structure that was obtained from exporting the assets - in my case the folders went Game\BlueFire\NPC\Fara\Textures so I must create the folders like this:
-![](UE4.png)
+![](content.png)
 
-- Press ctrl+shift+s to save all
+- Press ctrl + shift + s to save all
diff --git a/src/The-Basics/Engine/FaraTex.png → src/basics/engine/fara.png b/src/The-Basics/Engine/FaraTex.png → src/basics/engine/fara.png
diff --git a/src/The-Basics/Engine/Unchecking.png → src/basics/engine/settings.png b/src/The-Basics/Engine/Unchecking.png → src/basics/engine/settings.png
diff --git a/src/The-Basics/Engine/Setting-Up.md → src/basics/engine/setup.md b/src/The-Basics/Engine/Setting-Up.md → src/basics/engine/setup.md
@@ -2,8 +2,8 @@
 - Install the version of Unreal Engine 4 that your game uses from the [Epic Games Launcher](https://www.unrealengine.com/en-US/download)
 
 - Open up UE4 and create a blank game project with no starter content (it's unnecessary)
-![](NewProject.png)
-![](NewProject2.png)
+![](type.png)
+![](template.png)
 
 - Go into edit > project settings and uncheck use pak file
-![](Unchecking.png)
+![](settings.png)
diff --git a/src/The-Basics/Engine/NewProject2.png → src/basics/engine/template.png b/src/The-Basics/Engine/NewProject2.png → src/basics/engine/template.png
diff --git a/src/The-Basics/Engine/NewProject.png → src/basics/engine/type.png b/src/The-Basics/Engine/NewProject.png → src/basics/engine/type.png
diff --git a/src/The-Basics/Paking/Cooking.md → src/basics/packing/cooking.md b/src/The-Basics/Paking/Cooking.md → src/basics/packing/cooking.md
diff --git a/src/The-Basics/Paking/drip.png → src/basics/packing/drip.png b/src/The-Basics/Paking/drip.png → src/basics/packing/drip.png
diff --git a/src/The-Basics/Paking/Final-Paking.md → src/basics/packing/packaging.md b/src/The-Basics/Paking/Final-Paking.md → src/basics/packing/packaging.md
@@ -1,15 +1,15 @@
 # Final Packaging
 
-- Create a folder named `The name of your mod_P` (the `_P` clarifies it as a patch so that it overwrites original game content)
+- Create a folder named `name_of_your_mod_here_p` (the `_p` clarifies it as a patch so that it overwrites original game content)
 
 - Create a folder the name of your Game's project name
 
 - Go into the folder where you packaged your mod and copy the Content folder in `WindowsNoEditor\ProjectName` into this folder
 
-- Folder structure is very important for UE4 modding so make sure spellings of the folders are the same as they were when exported
+- Folder structure is very important for UE modding so make sure spellings of the folders are the same as they were when exported
 
 - Download [Unrealpak](https://fluffyquack.com/tools/unrealpak.rar) by FluffyQuack and drag the mod folder onto UnrealPak-with-compression.bat
-![](Packaging.png)
+![](packaging.png)
 
 - This will create a pak file - Make sure the pak file still contains the _P at the end of its name
 - Create a folder in your `Paks` folder called ~mods

diff --git a/src/The-Basics/Paking/Packaging.png → src/basics/packing/packaging.png b/src/The-Basics/Paking/Packaging.png → src/basics/packing/packaging.png
diff --git a/src/The-Basics/projectname.png → src/basics/projectname.png b/src/The-Basics/projectname.png → src/basics/projectname.png
diff --git a/src/The-Basics/Unpaking/AES-Keys.md → src/basics/unpacking/aes.md b/src/The-Basics/Unpaking/AES-Keys.md → src/basics/unpacking/aes.md
diff --git a/src/The-Basics/Unpaking/FModel.md → src/basics/unpacking/fmodel.md b/src/The-Basics/Unpaking/FModel.md → src/basics/unpacking/fmodel.md
@@ -2,13 +2,13 @@
 - Install [Fmodel](https://fmodel.app/) by the Fmodel team
 
 - Launch the program and you should be greeted with the startup screen
-![](Fmodel.png)
+![](fmodel.png)
 
 - Set the folder to your Paks folder using the `...` button and proceed
 
 - Click on Settings and change the Unreal Version to your game's version (it will have to restart if changed)
 
-- If there is red dot next to a pak file, go to Directory > AES and read [this](AES-Keys.md)
+- If there is red dot next to a pak file, go to Directory > AES and read [this](aes.md)
 
 - Find something you want to replace or modify - *start with something simple (I'll be using a texture)*
 

diff --git a/src/The-Basics/Unpaking/FModel.png → src/basics/unpacking/fmodel.png b/src/The-Basics/Unpaking/FModel.png → src/basics/unpacking/fmodel.png
diff --git a/src/The-Basics/Unpaking/Options.md → src/basics/unpacking/options.md b/src/The-Basics/Unpaking/Options.md → src/basics/unpacking/options.md
@@ -9,4 +9,4 @@
 
     - If there are multiple pak files then your game has split its paks into chunks - This shouldn't affect the process significantly
 
-- There are more options found in [Pakers/Unpakers](../../Tools/Pakers.md) and [Pak Explorers](../../Tools/Pak-Explorers.md) that I won't go into detail about in this section  
+- There are more options found in [Pakers/Unpakers](../../tools/packers.md) and [Pak Explorers](../../tools/explorers.md) that I won't go into detail about in this section  
diff --git a/src/The-Basics/Unpaking/umodel-Browse.png → src/basics/unpacking/umodel-browse.png b/src/The-Basics/Unpaking/umodel-Browse.png → src/basics/unpacking/umodel-browse.png
diff --git a/src/The-Basics/Unpaking/umodel-Popup.png → src/basics/unpacking/umodel-popup.png b/src/The-Basics/Unpaking/umodel-Popup.png → src/basics/unpacking/umodel-popup.png
diff --git a/src/The-Basics/Unpaking/umodel-Startup.png → src/basics/unpacking/umodel-startup.png b/src/The-Basics/Unpaking/umodel-Startup.png → src/basics/unpacking/umodel-startup.png
diff --git a/src/The-Basics/Unpaking/UEViewer.md → src/basics/unpacking/umodel.md b/src/The-Basics/Unpaking/UEViewer.md → src/basics/unpacking/umodel.md
@@ -4,23 +4,21 @@
 - Install [umodel](https://www.gildor.org/en/projects/umodel) by Gildor
 
 - Launch the program and you should be greeted with the startup screen
-![](umodel-Startup.png)
+![](umodel-startup.png)
 
-- If you extracted the raw assets using [QuickBMS](QuickBMS.md) or [UnrealPak](UnrealPak.md) then set the folder to the output folder you used using the `...` button and proceed
-
-- If not then set the folder to your Paks folder and proceed
+- Set the folder to your Paks folder and proceed
 
 - You should now have access to your game's file system 
 
-- **If you got an AES key prompt click [here](AES-Keys.md)**
-![](umodel-Browse.png)
+- **If you got an AES key prompt click [here](aes.md)**
+![](umodel-browse.png)
 
 - Open a package by double clicking it 
 
 - The first time you should get a pop-up asking for the version of the package
 
 - Enter the version of unreal engine your game uses
-![](umodel-Popup.png)
+![](umodel-popup.png)
 
 - Find something you want to replace or modify - *start with something simple (I'll be using a texture)*
 

diff --git a/src/The-Basics/version.png → src/basics/version.png b/src/The-Basics/version.png → src/basics/version.png
diff --git a/src/Resources/Other-Guides.md → src/resources/guides.md b/src/Resources/Other-Guides.md → src/resources/guides.md
diff --git a/src/Specific-Guides/UAssetAPI/UAssetAPI.md → src/specific/UAssetAPI.md b/src/Specific-Guides/UAssetAPI/UAssetAPI.md → src/specific/UAssetAPI.md
diff --git a/src/Specific-Guides/UAssetGUI.md → src/specific/UAssetGUI.md b/src/Specific-Guides/UAssetGUI.md → src/specific/UAssetGUI.md
diff --git a/src/Specific-Guides/Logic-Mods/Blueprint.md → src/specific/blueprint/Blueprint.md b/src/Specific-Guides/Logic-Mods/Blueprint.md → src/specific/blueprint/Blueprint.md
diff --git a/src/Specific-Guides/Logic-Mods/Creation.md → src/specific/blueprint/Creation.md b/src/Specific-Guides/Logic-Mods/Creation.md → src/specific/blueprint/Creation.md
diff --git a/src/Specific-Guides/Logic-Mods/Injector.md → src/specific/blueprint/Injector.md b/src/Specific-Guides/Logic-Mods/Injector.md → src/specific/blueprint/Injector.md
diff --git a/src/Specific-Guides/Logic-Mods/Installing.md → src/specific/blueprint/Installing.md b/src/Specific-Guides/Logic-Mods/Installing.md → src/specific/blueprint/Installing.md
diff --git a/src/Specific-Guides/Logic-Mods/Profile.md → src/specific/blueprint/Profile.md b/src/Specific-Guides/Logic-Mods/Profile.md → src/specific/blueprint/Profile.md
diff --git a/...ecific-Guides/Logic-Mods/Project-Setup.md → src/specific/blueprint/Project-Setup.md b/...ecific-Guides/Logic-Mods/Project-Setup.md → src/specific/blueprint/Project-Setup.md
diff --git a/src/Specific-Guides/Logic-Mods/UML-Setup.md → src/specific/blueprint/UML-Setup.md b/src/Specific-Guides/Logic-Mods/UML-Setup.md → src/specific/blueprint/UML-Setup.md
diff --git a/src/Specific-Guides/Dialogue.md → src/specific/dialogue.md b/src/Specific-Guides/Dialogue.md → src/specific/dialogue.md
diff --git a/src/Specific-Guides/Disabling/Disabling.md → src/specific/disabling/disabling.md b/src/Specific-Guides/Disabling/Disabling.md → src/specific/disabling/disabling.md
@@ -6,15 +6,15 @@ This is a useful way to disable actors in game - can be used for stuff like remo
 
 - Open umodel and find the content you would like to disable (In my case the main menu castle)
 
-![](Reference.png)
+![](reference.png)
 
 - Recreate the observed folder structure like you would in final paking (because we are dealing with cooked uassets)
 
 *A useful shortcut for creating new folders is ctrl+shift+n and you can enter the name and double-press enter to go inside the folder*
 
 - Create a blank text document with the same name as the uasset you want to disable and change the file extension to .uasset
-![](Structure.png)
+![](structure.png)
 
 - Package the folder, place in mod folder and run the game
-![](NoCastle.png)
+![](no-castle.png)
 - The content should not appear if done correctly
diff --git a/src/Specific-Guides/Disabling/NoCastle.png → src/specific/disabling/no-castle.png b/src/Specific-Guides/Disabling/NoCastle.png → src/specific/disabling/no-castle.png
diff --git a/src/Specific-Guides/Disabling/Reference.png → src/specific/disabling/reference.png b/src/Specific-Guides/Disabling/Reference.png → src/specific/disabling/reference.png
diff --git a/src/Specific-Guides/Disabling/Structure.png → src/specific/disabling/structure.png b/src/Specific-Guides/Disabling/Structure.png → src/specific/disabling/structure.png
diff --git a/src/Specific-Guides/Levels.md → src/specific/levels.md b/src/Specific-Guides/Levels.md → src/specific/levels.md
diff --git a/src/Specific-Guides/Materials/UAssetGUI.md → src/specific/materials/UAssetGUI.md b/src/Specific-Guides/Materials/UAssetGUI.md → src/specific/materials/UAssetGUI.md
diff --git a/src/Specific-Guides/Materials/UassetGUI.png → src/specific/materials/UassetGUI.png b/src/Specific-Guides/Materials/UassetGUI.png → src/specific/materials/UassetGUI.png
diff --git a/src/Specific-Guides/Materials/Engine.md → src/specific/materials/engine.md b/src/Specific-Guides/Materials/Engine.md → src/specific/materials/engine.md
diff --git a/src/Specific-Guides/Materials/nodes.png → src/specific/materials/nodes.png b/src/Specific-Guides/Materials/nodes.png → src/specific/materials/nodes.png
diff --git a/src/Specific-Guides/Models/Exporting.png → src/specific/models/Exporting.png b/src/Specific-Guides/Models/Exporting.png → src/specific/models/Exporting.png
diff --git a/src/Specific-Guides/Models/Importing.png → src/specific/models/Importing.png b/src/Specific-Guides/Models/Importing.png → src/specific/models/Importing.png
diff --git a/src/Specific-Guides/Models/Smoothing.png → src/specific/models/Smoothing.png b/src/Specific-Guides/Models/Smoothing.png → src/specific/models/Smoothing.png
diff --git a/src/Specific-Guides/Models/Units.png → src/specific/models/Units.png b/src/Specific-Guides/Models/Units.png → src/specific/models/Units.png
diff --git a/src/Specific-Guides/Models/Meshes.md → src/specific/models/meshes.md b/src/Specific-Guides/Models/Meshes.md → src/specific/models/meshes.md
diff --git a/src/Specific-Guides/Models/Rigs.md → src/specific/models/rigs.md b/src/Specific-Guides/Models/Rigs.md → src/specific/models/rigs.md
diff --git a/src/Tools/Pak-Explorers.md → src/tools/explorers.md b/src/Tools/Pak-Explorers.md → src/tools/explorers.md
diff --git a/src/Tools/Libraries.md → src/tools/libraries.md b/src/Tools/Libraries.md → src/tools/libraries.md
@@ -6,9 +6,6 @@
 
   - [unreal automation tools](https://docs.rs/cargo-uat)
 
-  ### Python
-  - [PyPakParser](https://pypi.org/project/PyPAKParser/)
-
   ### C sharp
   - [UassetAPI](https://github.com/atenfyr/UAssetAPI)
 
@@ -18,4 +15,8 @@
 
   - [UnSave.Extensions](https://www.nuget.org/packages/UnSave.Extensions)
 
-  - [PakReader](https://www.nuget.org/packages/PakReader/)
+  - [PakReader](https://www.nuget.org/packages/PakReader/)
+
+  ### Python
+  - [PyPakParser](https://pypi.org/project/PyPAKParser/)
+
diff --git a/src/Tools/Locres-Editors.md → src/tools/locres.md b/src/Tools/Locres-Editors.md → src/tools/locres.md
diff --git a/src/Tools/Pakers.md → src/tools/packers.md b/src/Tools/Pakers.md → src/tools/packers.md
diff --git a/src/Tools/Asset-Editors.md → src/tools/uasset.md b/src/Tools/Asset-Editors.md → src/tools/uasset.md