Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RequiDev/ReMod.Core
The core dependency of ReMod
https://github.com/RequiDev/ReMod.Core
vrchat vrchat-mod vrchat-mods vrchat-tool vrchatapi
Last synced: 13 days ago
JSON representation
The core dependency of ReMod
- Host: GitHub
- URL: https://github.com/RequiDev/ReMod.Core
- Owner: RequiDev
- License: gpl-3.0
- Archived: true
- Created: 2021-10-29T04:48:03.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T14:45:30.000Z (almost 2 years ago)
- Last Synced: 2023-08-06T07:22:30.584Z (about 1 year ago)
- Topics: vrchat, vrchat-mod, vrchat-mods, vrchat-tool, vrchatapi
- Language: C#
- Homepage:
- Size: 225 KB
- Stars: 31
- Watchers: 5
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Disclaimer
Since VRChat has added EAC this library doesn't work anymore.
# ReMod.Core
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).
## DISCLAIMER! THIS IS NOT A MOD. THIS IS JUST A DEPENDENCY FOR MODS!
## Description
This library powers both my private VRChat mod and the public version of it. Its main use is to create UI elements for VRChat in an easy way without all the work behind it.
## Usage
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.
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)
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).
Modify ReMod.Core as you need it, test your changes and create a pull request to submit your changes.
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.
## Documentation
I'll be honest, read the code in [ReModCE](https://github.com/RequiDev/ReModCE). I wrote this library to use it for my projects. I'm fine with other people using it as long as they respect the [license](https://github.com/RequiDev/ReMod.Core/blob/master/LICENSE) behind it.
A few things are a bit convoluted, but that's because I tried my best to OOP the unity hierarchy of the UI objects behind it. It should still be easy enough to understand.
## Contribution
In case you do have something to contribute, please create a pull request. Try to stay close to the current coding style.
## Credits
[@Kiokuu](https://github.com/Kiokuu)
[@imxLucid](https://github.com/imxLucid)
[@DDAkebono](https://github.com/DDAkebono)
[@MintLily](https://github.com/MintLily)