CLre/README.md

# CLre

Always eat your celery, so you'll grow up to be big and strong like me. 
Work-in-progress mod for [CardLife](http://cardlifegame.com/). 

CardLife has stopped receiving updates, but that doesn't mean it's free from bugs. 
CLre is a mod to rejuvenate CardLife by fixing old bugs and adding some modding sprinkles. 

## Setup

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 cl in the solution's main directory or one level up from that. 

You can make sure CLre can find all of `.dll` files it needs by copying your Cardlife folder beside this repo's folder and renaming it to `cl`, but that's a bit of a waste of disk space. 
You can also create a symbolic link to your Cardlife install folder named `cl` in the same spot to avoid having to re-copy files. 
For example, if you cloned the repo into a folder called `CLre_repo`, this is what your folder structure would look like. 

If you decide to change the `cl` folder configuration, do not commit your `CLre.csproj` file otherwise your changes will be rejected.

```
CLre_repo/ <- CLre git project files
  CLre/ <- Code files
  README.md <- This file
  etc.

cl/ <- CardLife files
  Cardlife_Data/
    Managed/ <- Cardlife C# Assemblies
  CardlifeGameServer_Data/
    Managed/ <- Cardlife Standalone Server C# Assemblies (optional)
```

For any mod to work, you will have to patch your game with the Cardlife adaptation of [CLIPA](https://git.exmods.org/NGnius/CLIPA). 
The installation process is roughly the same as for Gamecraft, except with a different name: [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 `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 CLre project without errors. 
If it doesn't work and you can't figure out why, ask for help on the [Exmods Discord server](https://discord.exmods.org). 

## Installation

To install the CLre mod, copy the build's `CLre.dll` into the `Plugins` folder where Cardlife is installed.