Skip to content

Commit f5b970c

Browse files
author
Benjamin Foo
committed
Updated documentation
1 parent 35ed043 commit f5b970c

4 files changed

Lines changed: 24 additions & 11 deletions

File tree

docs/banner.xcf

-66.7 KB
Binary file not shown.

docs/camsettingspp.png

814 KB
Loading

docs/mod_manager.png

2.57 MB
Loading

readme.md

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,23 @@
11
<img src="docs/banner.png">
22

33
# Going Medieval - Mod Loader & Plugin-API
4-
This project allows the development and loading of mods for Going Medieval, written in C#.
4+
This project allows the development and loading of mods for Going Medieval.
55

6-
The currently supported version is 0.5.28.6.
6+
**Note** \
7+
This project allows the modification of the gm runtime - this can lead to unexpected behaviour, errors or bugs.
8+
Be aware of this - **I don't take any responsibility for any damage or corrupted files** - you are on your own now 🐱‍👤.
9+
10+
Going Medieval is a product of the game development studio [Foxy Voxel](https://foxyvoxel.io/). All rights belong to them.
11+
This project uses [Harmony](https://harmony.pardeike.net/) and [Unity-Doorstop](https://github.com/NeighTools/UnityDoorstop).
712

813
## Features
914
The following features are supported by the Mod Launcher:
10-
- load C# based mods using a simple [Plugin-API](https://github.com/benjaminfoo/GoingMedievalModLauncher/blob/main/GoingMedievalModLauncher/src/plugins/IPlugin.cs)
11-
- access the native unity API / runtime
12-
- replace / patch methods by using [Harmony](https://harmony.pardeike.net/)
13-
- No manual editing / hacking of files - the games files don't get modified
15+
- Current support for version 0.5.28.6
16+
- Load C# based mods using a simple [Plugin-API](https://github.com/benjaminfoo/GoingMedievalModLauncher/blob/main/GoingMedievalModLauncher/src/plugins/IPlugin.cs)
17+
- Access the native unity API / runtime
18+
- Replace / patch methods by using [Harmony](https://harmony.pardeike.net/)
19+
- No manual editing of files
20+
- Mod-Manager User Interface for enabling / disabling a mod
1421
- Logging
1522
- ModLauncher / Plugin related logging within the 'mod_launcher.log' file
1623
- Unity related logging within the 'output_log' file
@@ -30,15 +37,21 @@ Increases rendering-, zoom- & shadow-distance - may slow down performance.
3037
[DeveloperConsole Enabler - Plugin](https://github.com/benjaminfoo/GoingMedievalModLauncher/tree/main/DeveloperConsoleEnablerPlugin)\
3138
Enables the Developer-Console by using L to open and K to close the UI.
3239

33-
## Installation:
40+
### Installation
3441
Download the latest release and drop it into your going medieval folder
3542

36-
## Technical
43+
### Technical
3744

3845
For technical information checkout the [wiki](https://github.com/benjaminfoo/GoingMedievalModLauncher/wiki/Technical) at the github-page.
3946

40-
## Additional
41-
- Unity-Doorstop for injecting code: https://github.com/NeighTools/UnityDoorstop
42-
- Harmony for runtime patching of code: https://harmony.pardeike.net/
47+
### Screenshots
48+
<img src="docs/mod_manager.png">
49+
<img src="docs/camsettingspp.png">
50+
51+
52+
### Additional Information
53+
- [Going Medieval](https://foxyvoxel.io/) as this project's target 🐱‍💻
54+
- [Unity-Doorstop](https://github.com/NeighTools/UnityDoorstop) for injecting code 💉
55+
- [Harmony](https://harmony.pardeike.net/) for runtime patching of code 🩹
4356

4457

0 commit comments

Comments
 (0)