Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Tuchan committed Aug 15, 2023
1 parent 23aad46 commit 8516633
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,34 @@
# NeonWhiteRP
A Rich Presence Mod for Neon White
A Discord Rich Presence (RP) Mod that aims for customization.

![hub](https://github.com/Tuchan/NeonWhiteRP/assets/43300571/2bf7bf26-ae49-49e8-b634-945fd911b5fa) ![game](https://github.com/Tuchan/NeonWhiteRP/assets/43300571/63021616-0b8f-4a9e-bd52-543dc4b7c6b6) ![neonrank](https://github.com/Tuchan/NeonWhiteRP/assets/43300571/57955a80-b2fb-411f-bfa6-95bffdf88a9b)

| ⚠️ Important |
|------------------------------------------|
| In the near future, this mod will be simplified and put as a module in NeonLite.|

# Supports
- Menus
- Normal Levels
- Sidequest levels
- Custom Levels (RMMBY)
- Level Rush Modes
- Central Heaven (Map) Actions
- Cutscenes
- Global Neon Rank
- and more...

# How to install
1. [Download the newest Discord's GameSDK](https://discord.com/developers/docs/game-sdk/sdk-starter-guide) (v3.2.1 was used while creating this mod)
2. Unzip then go into `/lib` and depending on your system choose `x86` - 32 bit or `x86_64` - 64 bit and copy `discord_game_sdk.dll` and put it in your Mod folder
3. Go to [releases](https://github.com/Tuchan/NeonWhiteRP/releases/latest) and download the `NeonWhiteRP.dll` and put it in your Mod folder


| ℹ️ Information |
|------------------------------------------|
| If there is an update, you will see a pop up in game.|

# Other things
- Big thanks to [MOPSKATER](https://github.com/MOPSKATER) for helping with this dramatically haha

If you want to launch your game faster, add `--melonloader.hideconsole` to launch properties (right click the game on steam -> properties -> launch options at the bottom of that window) to hide the console that melonloader loads in.

0 comments on commit 8516633

Please sign in to comment.