exmods/GameSDKcraft
1
0
Fork 0
Code Issues Pull requests Releases 3 Activity

Update README with namechange info

Browse source
This commit is contained in:
NGnius (Graham) 2020-07-04 15:08:48 -04:00
parent 203b607074
commit a94d9d7699
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -1,7 +1,7 @@
# GamecraftRPC
# GameSDKcraft
Experimental project for Discord Rich Presence in Gamecraft.
This currently only works in native environments (eg this does not work with Wine/Proton) although I'm sure someone can find a way to fix that.
This currently only works in native environments, although you can use [Discord-IPC-bridge](https://github.com/0e4ef622/wine-discord-ipc-bridge) to get Discord integration working through Wine/Proton.
## Dev environment Setup
@ -9,7 +9,7 @@ This project requires most of Gamecraft's `.dll` files to function correctly.
Most, but not all, of these files are stored in Gamecraft's `Gamecraft_Data\Managed` folder.
The project is pre-configured to look in a folder called ref in the solution's main directory or one level up from that.
You can make sure GamecraftRPC can find all of `.dll` files it needs by copying your Gamecraft folder here and renaming it to `ref`, but you'll have to re-copy it after every Gamecraft update.
You can make sure GameSDKcraft can find all of `.dll` files it needs by copying your Gamecraft folder here and renaming it to `ref`, but you'll have to re-copy it after every Gamecraft update.
You can also create a symbolic link (look it up) to your Gamecraft install folder named `ref` in this folder to avoid having to re-copy files.
For any mod to work, you will have to patch your game with [GCIPA](https://git.exmods.org/modtainers/GCIPA).
@ -24,12 +24,12 @@ The GameSDK csharp folder is already included in the git repo.
## Building
After you've completed the setup, open the solution file `GamecraftRPC.sln` in your prefered C# .NET/Mono development environment.
After you've completed the setup, open the solution file `GameSDKcraft.sln` in your prefered C# .NET/Mono development environment.
I'd recommend Visual Studio Community Edition or JetBrains Rider for Windows and Monodevelop for Linux.
If you've successfully completed setup, you should be able to build the GamecraftRPC project without errors.
If you've successfully completed setup, you should be able to build the GameSDKcraft project without errors.
If it doesn't work and you can't figure out why, ask for help on [our Discord server](https://discord.gg/xjnFxQV).
## Installation
To install the GamecraftRPC mod, copy the build's `GamecraftRPC.dll` into the `Plugins` folder in Gamecraft's main folder.
To install the GameSDKcraft mod, copy the build's `GameSDKcraft.dll` into the `Plugins` folder in Gamecraft's main folder.