Update README with CL specifics
This commit is contained in:
parent
25099aa1f4
commit
883c1c026a
1 changed files with 12 additions and 16 deletions
28
README.md
28
README.md
|
@ -1,32 +1,28 @@
|
|||
# HelloModdingWorld
|
||||
# CLre
|
||||
|
||||
Shell project for Gamecraft mods.
|
||||
Shell project for Cardlife mods.
|
||||
Use this as a quick-start project structure for your own mods, or to learn how modding works.
|
||||
|
||||
## 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.
|
||||
This project requires most of Cardlife's `.dll` files to function correctly.
|
||||
Most, but not all, of these files are stored in Cardlife's `Cardlife_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 HelloModdingWorld 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.
|
||||
You can make sure CLre can find all of `.dll` files it needs by copying your Cardlife folder beside this repo's parent folder and renaming it to `cl`, but you'll have to re-copy it after every Cardlife update.
|
||||
You can also create a symbolic link (look it up) to your Cardlife install folder named `cl` in the same spot 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 any mod to work, you will have to patch your game with the Cardlife adaptation of [GCIPA](https://git.exmods.org/modtainers/GCIPA/src/branch/cardlife).
|
||||
The installation process is roughly the same as for Gamecraft: [GCIPA Gamecraft install guide](https://git.exmods.org/modtainers/GCIPA/src/branch/master/README.md#how-to-install).
|
||||
|
||||
## Building
|
||||
|
||||
After you've completed the setup, open the solution file `HelloModdingWorld.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.
|
||||
After you've completed the setup, open the solution file `CLre.sln` in your prefered C# .NET/Mono development environment.
|
||||
I'd recommend Visual Studio Community Edition or JetBrains Rider.
|
||||
|
||||
If you've successfully completed setup, you should be able to build the HelloModdingWorld project without errors.
|
||||
If you've successfully completed setup, you should be able to build the CLre 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 HelloModdingWorld mod, copy the build's `HelloModdingWorld.dll` into the `Plugins` folder in Gamecraft's main folder.
|
||||
To install the CLre mod, copy the build's `CLre.dll` into the `Plugins` folder in Cardlife's main folder.
|
||||
|
|
Loading…
Reference in a new issue