Project Remnants manual installation guide

gistfile1.txt

# Manual installation

## Windows

This mod is NOT compatible with ZombieBuddy. Trying to run both at once will crash the game. Don't do it. Look at me. Don't.

You need to copy a certain number of files from the ProjectZomboid game directory for this mod to function.

1) Go to Steam, right clcick on the game, go to "Manage" > "Browse Local Files".

2) Open the `jre64/bin` folder. This folder contains a set of files we need to copy to the main ProjectZomboid directory.

3) Copy the following files:

- `instrument.dll`
- `java.dll`
- `jli.dll`
- `vcruntime140.dll`
- `api-ms-win-crt-convert-l1-1-0.dll`
- `api-ms-win-crt-heap-l1-1-0.dll`
- `api-ms-win-crt-runtime-l1-1-0.dll`
- `api-ms-win-crt-stdio-l1-1-0.dll`
- `api-ms-win-crt-string-l1-1-0.dll`
- `msvcp140.dll`
- `ucrtbase.dll`
- `vcruntime140_1.dll`

To the game directory that you opened in 1).

4) Open the `server` directory within `jre64/bin`.

5) Copy the `jvm.dll` file to the game main directory.

6) Configuring the ProjectZomboid64.json file:

In the game directory (opened in 1)), you will find a file called "ProjectZomboid64.json".
Make a backup of this file to any location you want.
Open it with any text editor (NOT WORD!).
Replace **the entire file contents** with this:

```json
{
	"mainClass": "zombie/gameStates/MainScreenState",
	"classpath": [
		"projectzomboid.jar",
		"<LOCATION_OF_YOUR_STEAM_LIBRARY>/steamapps/workshop/content/108600/3738362476/mods/ProjectRemnants/NPCFW.jar"
	],
	"vmArgs": [
		"-Djava.library.path=win64/;.;jre64/bin;jre64/bin/server",
		"-javaagent:<LOCATION_OF_YOUR_STEAM_LIBRARY>/steamapps/workshop/content/108600/3738362476/mods/ProjectRemnants/NPCFW.jar",
		"-Djava.awt.headless=true",
		"-Xmx6144m",
		"-Dzomboid.steam=1",
		"-Dzomboid.znetlog=1",
		"-XX:-CreateCoredumpOnCrash",
		"-XX:-OmitStackTraceInFastThrow"
	],
	"windows": {
		"6.1": {
			"vmArgs": [
				"-XX:+UseG1GC"
			]
		},
		"10.0.17134": {
			"vmArgs": [
				"-XX:+UseZGC"
			]
		}
	}
}
```

Note: The `-Xmx6144m` parameter represents the maximum amount of RAM ProjectZomboid can use on your computer.
You can increase (but not decrease) this value to any valid RAM value. 6144 is GB of RAM. For example 6.5GB would be 6656, or 8GB would be 8192.

7) Start the game and activate the mod.

8) Restart the game! ProjectZomboid is VERY bad at reloading mods when it is already started.

9) Play.

## Linux

This mod is NOT compatible with ZombieBuddy. Trying to run both at once will crash the game. Don't do it. Look at me. Don't.

The Linux installation is significantly easier than other systems.

1) Go to Steam, right clcick on the game, go to "Manage" > "Browse Local Files".

2) Open the mod folder in another window. On Linux it will be something like `/<YOUR_STEAM_LIBRARY_PATH>/SteamLibrary/steamapps/workshop/content/108600/3738362476/mods/ProjectRemnants`.

3) Copy the file `NPCFW.jar` from the mod directory into the game directory: `/<YOUR_STEAM_LIBRARY_PATH>/SteamLibrary/steamapps/common/ProjectZomboid/projectzomboid`.

4) Right click on the game on Steam and go to "Properties".

5) In the launch options, put this (AND ONLY THIS! And YES the double dashes at the end are MANDATORY): `-javaagent:NPCFW.jar --`.

6) In the game folder, you will find a file called "ProjectZomboid64.json". Make a backup of it and replace the WHOLE contents with this:

```json
{
	"mainClass": "zombie/gameStates/MainScreenState",
	"classpath": [
		".",
		"projectzomboid.jar"
	],
	"vmArgs": [
		"-Djava.awt.headless=true",
		"-Xmx3072m",
		"-Dzomboid.steam=1",
		"-Dzomboid.znetlog=1",
		"-Djava.library.path=linux64/:.",
		"-Djava.security.egd=file:/dev/./urandom",
		"-XX:+UseZGC",
		"-XX:-OmitStackTraceInFastThrow"
	]
}

```

Note: The `-Xmx6144m` parameter represents the maximum amount of RAM ProjectZomboid can use on your computer.
You can increase (but not decrease) this value to any valid RAM value. 6144 is GB of RAM. For example 6.5GB would be 6656, or 8GB would be 8192.

7) Play.