CLre/README.md

29 lines
1.6 KiB
Markdown
Raw Normal View History

2020-10-01 14:46:16 +01:00
# CLre
2020-10-01 14:21:44 +01:00
2020-10-01 14:46:16 +01:00
Shell project for Cardlife mods.
2020-10-01 14:21:44 +01:00
Use this as a quick-start project structure for your own mods, or to learn how modding works.
## Setup
2020-10-01 14:46:16 +01:00
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.
2020-10-01 14:21:44 +01:00
The project is pre-configured to look in a folder called ref in the solution's main directory or one level up from that.
2020-10-01 14:46:16 +01:00
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.
2020-10-01 14:21:44 +01:00
2020-10-01 14:46:16 +01:00
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).
2020-10-01 14:21:44 +01:00
## Building
2020-10-01 14:46:16 +01:00
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.
2020-10-01 14:21:44 +01:00
2020-10-01 14:46:16 +01:00
If you've successfully completed setup, you should be able to build the CLre project without errors.
2020-10-01 14:21:44 +01: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
2020-10-01 14:46:16 +01:00
To install the CLre mod, copy the build's `CLre.dll` into the `Plugins` folder in Cardlife's main folder.