Skip to content
This repository was archived by the owner on Jan 24, 2023. It is now read-only.

Commit c8ea8e1

Browse files
authored
Update README.md
1 parent 120cc22 commit c8ea8e1

1 file changed

Lines changed: 25 additions & 1 deletion

File tree

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,26 @@
11
# ReMod.Core
2-
The core dependency of ReMod and ReModCE. This project contains several helper functions, wrappers and UI classes for VRChat, Unity and MelonLoader.
2+
3+
[![main](https://img.shields.io/github/workflow/status/RequiDev/ReMod.Core/main?style=for-the-badge)](https://github.com/RequiDev/ReMod.Core/actions/workflows/main.yml)
4+
[![All Releases](https://img.shields.io/github/downloads/RequiDev/ReMod.Core/total.svg?style=for-the-badge&logo=appveyor)](https://github.com/RequiDev/ReMod.Core/releases)
5+
6+
The core dependency of my VRChat mods **ReMod** and [ReModCE](https://github.com/RequiDev/ReModCE). This project contains several helper functions, wrappers and UI classes for VRChat, Unity and [MelonLoader](https://github.com/LavaGang/MelonLoader).
7+
8+
## Description
9+
This library powers both my private VRChat mod and the public version of it. It's main use is to create UI elements for VRChat in an easy way without all the work behind it.
10+
11+
## Usage
12+
If you don't intend to modify the project your best bet is to either download the latest release from [here](https://github.com/RequiDev/ReMod.Core/releases/latest) or [here](https://github.com/RequiDev/ReModCE/releases/latest). Both this project and ReModCE will have an automatically built version in their releases.
13+
You'll want to link against that version and just supply it with your mod by either automatically load version from GitHub like [here](https://github.com/RequiDev/ReModCE/blob/master/ReModCE.Loader/ReMod.Loader.cs#L194)
14+
15+
If you **NEED** to modify ReMod.Core and need those changes to be in here, I'd suggest adding this repository to yours as a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules).
16+
Modify ReMod.Core as you need it, test your changes and create a pull request to submit your changes.
17+
18+
Please don't ILMerge ReMod.Core into your project as that can cause all sorts of problems with 2 ReMod.Core libraries existing in 1 process.
19+
20+
## Contribution
21+
In case you do have something to contribute, please create a pull request. Try to stay close to the current coding style.
22+
23+
## Credits
24+
[Kiokuu](https://github.com/Kiokuu)
25+
[imxLucid](https://github.com/imxLucid)
26+
[DDAkebono](https://github.com/DDAkebono)

0 commit comments

Comments
 (0)