GameSDKcraft/README.md

# GameSDKcraft

Experimental project for Discord Rich Presence in Gamecraft.
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

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 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). 
[Direct link to install guide](https://git.exmods.org/modtainers/GCIPA/src/branch/master/README.md#how-to-install). 
!!Download a release from git.exmods.org not github.com!! 

This project also requires the [GamecraftModdingAPI](https://git.exmods.org/modtainers/GamecraftModdingAPI) library to be installed (in `ref/Plugins/GamecraftModdingAPI.dll`). 
[Direct link to install guide](https://www.exmods.org/guides/install.html).

For rich presence functionality, files in lib/x86_64 of Discord's [GameSDK](https://discord.com/developers/docs/game-sdk/sdk-starter-guide) must be copied to ref/Gamecraft_Data/Plugins.
The GameSDK csharp folder is already included in the git repo.

## Building

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 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 GameSDKcraft mod, copy the build's `GameSDKcraft.dll` into the `Plugins` folder in Gamecraft's main folder.
Update README with namechange info 2020-07-04 15:08:48 -04:00			`# GameSDKcraft`
Initial commit 2020-03-16 21:05:19 +00:00
Convert to GamecraftRPC 2020-03-26 11:27:40 -04:00			`Experimental project for Discord Rich Presence in Gamecraft.`
Update README with namechange info 2020-07-04 15:08:48 -04:00			`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.`
Update README 2020-03-16 20:25:49 -04:00
Convert to GamecraftRPC 2020-03-26 11:27:40 -04:00			`## Dev environment Setup`
Update README 2020-03-16 20:25:49 -04:00
			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.`

Update README with namechange info 2020-07-04 15:08:48 -04:00			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.
Update README 2020-03-16 20:25:49 -04:00			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).`
			`[Direct link to install guide](https://git.exmods.org/modtainers/GCIPA/src/branch/master/README.md#how-to-install).`
			`!!Download a release from git.exmods.org not github.com!!`

			This project also requires the [GamecraftModdingAPI](https://git.exmods.org/modtainers/GamecraftModdingAPI) library to be installed (in `ref/Plugins/GamecraftModdingAPI.dll`).
			`[Direct link to install guide](https://www.exmods.org/guides/install.html).`

Add additional development info 2020-06-29 20:19:50 -04:00			`For rich presence functionality, files in lib/x86_64 of Discord's [GameSDK](https://discord.com/developers/docs/game-sdk/sdk-starter-guide) must be copied to ref/Gamecraft_Data/Plugins.`
			`The GameSDK csharp folder is already included in the git repo.`

Update README 2020-03-16 20:25:49 -04:00			`## Building`

Update README with namechange info 2020-07-04 15:08:48 -04:00			After you've completed the setup, open the solution file `GameSDKcraft.sln` in your prefered C# .NET/Mono development environment.
Update README 2020-03-16 20:25:49 -04:00			`I'd recommend Visual Studio Community Edition or JetBrains Rider for Windows and Monodevelop for Linux.`

Update README with namechange info 2020-07-04 15:08:48 -04:00			`If you've successfully completed setup, you should be able to build the GameSDKcraft project without errors.`
Update README 2020-03-16 20:25:49 -04:00			`If it doesn't work and you can't figure out why, ask for help on [our Discord server](https://discord.gg/xjnFxQV).`

			`## Installation`

Update README with namechange info 2020-07-04 15:08:48 -04:00			To install the GameSDKcraft mod, copy the build's `GameSDKcraft.dll` into the `Plugins` folder in Gamecraft's main folder.