Skip to content

Commit 53e667a

Browse files
authored
Merge pull request #15 from monkeyman192/update/147408.1
Updated to pymhf 0.1.15 and added some extra functions and example mod
2 parents 6eb2a6a + d96a4e4 commit 53e667a

File tree

17 files changed

+229
-319
lines changed

17 files changed

+229
-319
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ It should also be noted that Game updates can very easily break mods utilising N
77
Any responsibility for broken saves is entirely on the users of this library.
88

99
Also note that this library will never contain functions relating to online functionality to avoid any abuse.
10-
The author of this library condones any use of this for any usage that is detrimental to other players.
10+
The author of this library condones any use of this code for any purpose that is directly detrimental to other players.
1111

1212
## Installation
1313

@@ -23,12 +23,17 @@ To run NMS.py, enter the following command into a terminal:
2323
pymhf run nmspy
2424
```
2525

26-
This will display some config options to complete. The only option to consider is the location of the mods folder. It is recommended that you create a new folder inside the normal MODS folder which can contain all the python scripts you want to be run.
26+
This will display some config options to complete. The only option to consider is the location of the mods folder. It is recommended that you specify the `MODS` folder inside the `GAMEDATA` folder as your mod directory (ie. the same one you put normal mods in).
27+
All mods will be placed in either this folder, or in a chcild folder of this. You can essentially think of any mod using NMS.py being able to be "installed" in the same way you would any other normal mod.
2728

2829
If NMS.py starts up successfully you should see two extra windows; an auto-created GUI from pyMHF, and a terminal window which will show the logs for pyMHF.
2930

3031
If you want to stop NMS, you can press `ctrl + C` in the window you started the process in to kill it.
3132

33+
## Writing mods
34+
35+
Currently the best way to see how to write a mod is to look at the `example_mods` folder, as well as looking at the [pyMHF docs](https://monkeyman192.github.io/pyMHF/) which has comprehensive details on how to use pyMHF.
36+
3237
### Credits
3338

3439
Thanks to the developers of minhook, cyminhook and pymem, all of which are instrumental in making this framework possible.

docs/api/mod_loader.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

docs/change_log.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/examples/basic_mod.md

Lines changed: 0 additions & 50 deletions
This file was deleted.

docs/index.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/modding/getting_started.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

docs/modding/quick_reference.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

docs/setup.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

docs/writing_libraries.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/writing_mods.md

Lines changed: 0 additions & 81 deletions
This file was deleted.

0 commit comments

Comments
 (0)