mirrors/CLre
2
0
Fork 0
Code Issues Pull requests Releases 3 Activity

Add important mod info

Browse source
This commit is contained in:
NGnius (Graham) 2020-10-01 10:00:48 -04:00
parent 883c1c026a
commit 0f5555ab4c
1 changed files with 21 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -1,19 +1,34 @@
# CLre
Shell project for Cardlife mods.
Use this as a quick-start project structure for your own mods, or to learn how modding works.
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 tools ontop.
## 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 ref in the solution's main directory or one level up from that.
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 parent folder and renaming it to `cl`, but you'll have to re-copy it after every Cardlife update.
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 (look it up) 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.
```
CLre_repo/ -- CLre repository files
CLre/ -- Code files
README.md -- This file
etc.
cl/ -- CardLife files
Cardlife_Data/
Managed/ -- Cardlife C# Assemblies
```
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).
The installation process is roughly the same as for Gamecraft, except there's no pre-compiled download available: [GCIPA Gamecraft install guide](https://git.exmods.org/modtainers/GCIPA/src/branch/master/README.md#how-to-install).
## Building
@ -25,4 +40,4 @@ If it doesn't work and you can't figure out why, ask for help on [our Discord se
## Installation
To install the CLre mod, copy the build's `CLre.dll` into the `Plugins` folder in Cardlife's main folder.
To install the CLre mod, copy the build's `CLre.dll` into the `Plugins` folder where Cardlife is installed.