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

Update README info and links

Browse source
This commit is contained in:
NGnius (Graham) 2020-12-28 13:38:59 -05:00
parent 2cf5e80412
commit 425afa1c60
1 changed files with 15 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -4,7 +4,7 @@ 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/). Work-in-progress mod for [CardLife](http://cardlifegame.com/).
CardLife has stopped receiving updates, but that doesn't mean it's free from bugs. 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. CLre is a mod to rejuvenate CardLife by fixing old bugs and adding some modding sprinkles.
## Setup ## Setup
@ -13,22 +13,26 @@ Most, but not all, of these files are stored in Cardlife's `Cardlife_Data\Manage
The project is pre-configured to look in a folder called cl 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 folder and renaming it to `cl`, but that's a bit of a waste of disk space. 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. 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. 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 repository files CLre_repo/ <- CLre git project files
CLre/ -- Code files CLre/ <- Code files
README.md -- This file README.md <- This file
etc. etc.
cl/ -- CardLife files cl/ <- CardLife files
Cardlife_Data/ Cardlife_Data/
Managed/ -- Cardlife C# Assemblies 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 [GCIPA](https://git.exmods.org/modtainers/GCIPA/src/branch/cardlife). 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 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). 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 ## Building
@ -36,7 +40,7 @@ After you've completed the setup, open the solution file `CLre.sln` in your pref
I'd recommend Visual Studio Community Edition or JetBrains Rider. 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 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). 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 ## Installation