Skip to content

Commit

Permalink
better readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xiaoxiao921 committed Jun 4, 2024
1 parent f774ccc commit 1831245
Showing 1 changed file with 9 additions and 15 deletions.
24 changes: 9 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,24 @@
[Hades Modding Discord](https://discord.com/invite/KuMbyrN)
---

## Mod Manager Installation

- Until ReturnOfModding integration is merged into the main r2modman version, [use the fork available here.](https://github.com/xiaoxiao921/r2modmanPlus/releases/)

## Manual Installation

- Place the main Hell2Modding file, called `d3d12.dll`, next to the game executable called `Hades2.exe` inside the game folder.
- Place the main Hell2Modding file, called `d3d12.dll`, next to the game executable called `Hades2.exe` in the game's `Ship` folder.

## User Interface

- Ships with a ImGui user interface. The default key for opening the GUI is INSERT. You can change the key inside the `Hell2Modding/config/Hotkeys.cfg` file
- Hell2Modding comes with an ImGui user interface. The default key to open the user interface is `INSERT`. You can change this key in the `ReturnOfModding/config/Hell2Modding-Hell2Modding-Hotkeys.cfg` file.

## Creating mods

- Define a `main.lua` file in which to code your mod.

- Create a `manifest.json` file that follows the Thunderstore Version 1 Manifest format.

- Create a folder whose name follows the GUID format `TeamName-ModName`, for example: `Hell2Modding-DebugToolkit`.

- Place the `main.lua` file and the `manifest.json` file in the folder you've just created.

- Place the newly created folder in the `plugins` folder in the Hell2Modding root folder, called `Hell2Modding`, so the path to your manifest.json should be something like `Hell2Modding/plugins/Hell2Modding-DebugToolkit/manifest.json`.

- You can check the existing `examples` in that github repository if you wanna try stuff out.
- [Checkout the template created by the modding community](https://github.com/SGG-Modding/Hades2ModTemplate)

Interesting folders under the root folder:
## Folder convention:

- `plugins`: Location of .lua, README, manifest.json files.
- `plugins_data`: Used for data that must persist between sessions but not be manipulated by the user.
- `config`: Used for data that must persist between sessions and that can be manipulated by the user.
- `config`: Used for data that must persist between sessions and can be manipulated by the user.

0 comments on commit 1831245

Please sign in to comment.