Update installation process

This commit is contained in:
NGnius (Graham) 2021-08-30 18:00:56 -04:00
parent e501371f38
commit 29ac927b95

View file

@ -34,8 +34,8 @@ cl/ <- Cardlife files
```
For any game mod to work, you will have to patch your game with the Cardlife adaptation of [CLIPA](https://git.exmods.org/NGnius/CLIPA).
FOr a server mod to work, you will have to patch the server (CardlifeGameServer.exe).
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).
For a server mod to work, you will have to patch the server (CardlifeGameServer.exe).
The installation process is below, or you can follow the instructions for Gamecraft: [GCIPA Gamecraft install guide](https://git.exmods.org/modtainers/GCIPA/src/branch/master/README.md#how-to-install).
### Building
@ -47,13 +47,18 @@ If it doesn't work and you can't figure out why, ask for help on the [Exmods Dis
## Installation
To install the CLre mod, copy the build's `CLre.dll` into the `Plugins` folder where Cardlife is installed.
To install the CLre_server mod, copy the CLre_server build's `CLre_server.dll` into the `Plugins` folder where Cardlife is installed.
To patch Cardlife to load mods, download the latest version of [CLIPA](https://git.exmods.org/NGnius/CLIPA/releases), extract the contents into the game folder, then drag `Cardlife.exe` (or `CardlifeServer.exe` to patch the server) onto `IPA.exe`.
If you haven't turned on "Show file extensions" in Windows, those files may appear to be named `Cardlife` and `IPA`.
Some antivirus software may (wrongly) claim that `IPA` is a virus, but those warnings can be dismissed.
If you don't believe me, read the [CLIPA source code](https://git.exmods.org/NGnius/CLIPA).
To install the CLre mod, copy `CLre.dll` and `0Harmony.dll` (from the release zip) into the `Plugins` folder in the Cardlife install directory.
To install the CLre_server mod, copy `CLre_server.dll` and `0Harmony.dll` (from the release zip) into the `Plugins` folder where Cardlife is installed.
## A Note on CLre and CLre_server mods' (lack of) cooperation
CLre is designed for the Cardlife client, and cannot be used to mod the Cardlife server.
Similarly, CLre_server is designed for the Cardlife server, and cannot be used to mod the Cardlife client.
CLre is designed for the Cardlife client, and cannot be used with the Cardlife server.
Similarly, CLre_server is designed for the Cardlife server, and cannot be used with the Cardlife client.
DO NOT install CLre and CLre_server in the same `Plugins` folder, because both mods will be loaded -- guaranteeing one will break.
To install CLre and CLre_server on the same computer, create a copy of the game installation and use one copy for CLre and one for CLre_server.
@ -79,6 +84,8 @@ As of v0.0.3, ten (10) bugfixes are implemented.
- OfflineSpawnpointSavingFloatFix: [MORE: https://trello.com/c/hpADhDhQ/21-login-goes-to-original-spawn] [ID: 9] (0M/2P/0I/0W/0A/0D/2T)
- AntiStupidFloats: Force language-agnostic float->string behaviour internally (DISABLED BY DEFAULT) [ID: 10] (0M/1P/1I/0W/0A/0D/2T)
Technically, that's eleven (11) but AntiStupidFloats is disabled unless you add `--float-fix` to the launch parameters.
### API
Basic engine registration and some events are exposed for modders to use.