modcreation
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
modcreation [2019/06/27 18:30] – [Important Links and Info] umfdev | modcreation [2019/07/04 10:24] – [Important Links and Info] umfdev | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ~~Title: Mod Creation ~~ | ||
+ | {{tag> | ||
====== Requirements ====== | ====== Requirements ====== | ||
* C# Compiler (Recommended: | * C# Compiler (Recommended: | ||
* .NET Decompiler (Recommended: | * .NET Decompiler (Recommended: | ||
* **[[install|uMod Framework]]** | * **[[install|uMod Framework]]** | ||
- | * [[API|UMF API Documentation]] | + | * [[api:|UMF API Documentation]] |
* [[https:// | * [[https:// | ||
* [[https:// | * [[https:// | ||
Line 15: | Line 17: | ||
====== Mod Project Files ====== | ====== Mod Project Files ====== | ||
- Run '' | - Run '' | ||
- | * [[File:UMF.ProjectGenerator_Example.png]] | + | * {{:umf.projectgenerator_example.png?nolink|}} |
- Mod name with no spaces or special characters. This is used for the project files, class and assembly name. | - Mod name with no spaces or special characters. This is used for the project files, class and assembly name. | ||
- Where to save the source code of the mod. | - Where to save the source code of the mod. | ||
Line 23: | Line 25: | ||
- All References adds all dll files in the Managed folder as References, giving you access to all Unity classes as well as any separate classes the game provides. Only use if you know what you are doing. | - All References adds all dll files in the Managed folder as References, giving you access to all Unity classes as well as any separate classes the game provides. Only use if you know what you are doing. | ||
- Open your project solution by double clicking ModName.sln in the newly opened folder. | - Open your project solution by double clicking ModName.sln in the newly opened folder. | ||
- | * File:UMF.ProjectGenerator_SolutionFolder.png | + | * {{:umf.projectgenerator_solutionfolder.png?nolink|}} |
- | * File:UMF.ProjectGenerator_VisualStudio.png | + | * {{:umf.projectgenerator_visualstudio.png?nolink|}} |
- Add your code and click Build > Rebuild. (Rebuild will clean your project before each build.) | - Add your code and click Build > Rebuild. (Rebuild will clean your project before each build.) | ||
- | * See **[[# | + | |
+ | | ||
+ | \\ | ||
+ | ---- | ||
+ | |||
+ | \\ | ||
+ | |||
+ | ====== Decompiling Game Code ====== | ||
+ | In order to modify existing game code or figure out which game code you want to interface with you must decompile the game code using any decompiling program.\\ | ||
+ | Due to the vast superiority of [[https:// | ||
+ | Once you have installed dnSpy follow these steps: | ||
+ | - Run dnSpy once so that it integrates with windows explorer' | ||
+ | - Navigate to '' | ||
+ | - Right click '' | ||
+ | * Alternatively you can click **File > Open** inside the dnSpy and open this file. | ||
+ | - Navigate through the **Assembly Explorer** on the left side until you reach the '' | ||
+ | * {{:: | ||
+ | * This is where you will find the vast majority of the game code for most games. | ||
+ | * Some games may use other namespaces for some of it's code. | ||
+ | - Use the **Assembly Explorer**, **Search** and **Analyze** tools of dnSpy to discover code relevant to what you want to mod and learn where it is tied to. | ||
+ | * See **[[guide_firstsrmod|My First Slime Rancher Mod (Modding Guide)]]** to learn various ways to create a basic mod. | ||
+ | * See **[[# | ||
\\ | \\ | ||
---- | ---- | ||
Line 33: | Line 56: | ||
====== Important Links and Info ====== | ====== Important Links and Info ====== | ||
- | * **[[API|UMF API]]** - The UMF API gives you access to various functions that makes modding easier, and is also required in order for the mod to be started. | + | * **[[api:|UMF API]]** - The UMF API gives you access to various functions that makes modding easier, and is also required in order for the mod to be started. |
- | * **[[Mod Installer]]** - The UMF Mod Installer (URI Handler) lets you create one click Install links for your mods. | + | * **[[guides|Modding Guides]]** - A list of guides to assist |
* **[[Harmony]]** - Harmony is a useful library provided with UMF that lets you overwrite and inject code in MEMORY into existing classes and functions. | * **[[Harmony]]** - Harmony is a useful library provided with UMF that lets you overwrite and inject code in MEMORY into existing classes and functions. | ||
- | * **[[UMF Patch]]** - An IL-based UMF scripting patch system used as a last resort to let you automatically overwrite code in dll files on disk when Harmony can't access it in any way. | + | * **[[: |
- | * **[[Source Mods]]** - UMF can compile and run mods at runtime directly from .cs files placed in '' | + | * **[[: |
- | * **[[Example Mods]]** - A list of open source UMF mods you can use as examples to better learn coding with UMF. | + | * **[[: |
- | * **[[dnSpy Guide]]** - A basic guide on how to use dnSpy for modding. | + | * **[[: |
+ | * **[[: | ||
- | UMF starts and access mods through **[[API:Attributes|Attributes]]**.\\ | + | UMF starts and access mods through **[[api:attributes: |
- | Mods can currently be provided as .cs files, .dll files, .zip files(containing .dll files), and .umfmod files(packed and encrypted) by the **[[modpacker|Mod Packer]]**.\\ | + | Mods can currently be provided as .cs files, .dll files, .zip files(containing .dll files), and .umfmod files(packed and encrypted) by the **[[:modpacker|Mod Packer]]**.\\ |
UMF and Mods made with UMF does not re-distribute any code or game files from games or the Unity Engine. Making them both morally and legally safe.\\ | UMF and Mods made with UMF does not re-distribute any code or game files from games or the Unity Engine. Making them both morally and legally safe.\\ | ||
- | Mods made with UMF can also be freely sold/ | + | Mods made with UMF can also be freely sold/ |
\\ | \\ | ||
---- | ---- |
modcreation.txt · Last modified: 2024/04/24 23:22 by 127.0.0.1