Project Zomboid

Project Zomboid

[B42.13] Knox Event Expanded NPC mod (SP only) [alpha v0.3.20-1]
 This topic has been pinned, so it's probably important
Snejk  [developer] Dec 15 @ 11:04am
Installation guide - B42.12 legacy
The mod can be added mid save. In general, it is recommended to put the mod last in the load order, since this is what in my experience has worked the best during testing. Make sure to also look at the configuration section after installing the mod. The default memory settings for Project Zomboid are typically not enough, so you need to increase the amount of available memory. This is described in the configuration section,

Also, please keep in mind that this mod is still in development. Do not use this on saves you care about, or at the very least, take backups. Preferably, start on a clean save when trying out the mod.

New installation method (recommended)

The new installation method uses the fact that the workshop item now also includes a JAR archive. By modifying a file that Steam uses to launch Project Zomboid, it's possible to override the mod's required classes without having to modify the actual game files.

The most important thing it to figure out where your workshop directory of the mod is.
For Mac, this is typically at: ~/Library/Application\ Support/Steam/steamapps/workshop/content/108600/3397396843/mods/KnoxEventExpandedLegacy/java

For Linux, this is typically at: ~/.steam/steam/steamapps/workshop/content/108600/3397396843/mods/KnoxEventExpandedLegacy/java

For Windows, ii you've installed the game on the C drive on your PC, it will be at:
C:/Program Files (x86)/Steam/steamapps/workshop/content/108600/3397396843/mods/KnoxEventExpandedLegacy
If you installed Project Zomboid to another drive, the path typically looks roughly like this: D:/SteamLibrary/steamapps/workshop/content/108600/3397396843/mods/KnoxEventExpandedLegacy

NOTE: If the mod is already installed using the old method, please follow the instructions above to uninstall the mod before using the new installation method.

1. Find the file ProjectZomboid64.json in the game directory and open it with your favorite text editor e.g. Notepad.
To go to the game directory, in Steam, right-click on the Project Zomboid game and select "Manage"->"Browse local files".

2. Close to the top, there is a field called "classpath". Right below that, it says: ".", It should look roughly like this:
{
"mainClass": "zombie/gameStates/MainScreenState",
"classpath": [
".",
... // More below that is not relevant
3. Above the "." line mentioned above, add the following:
"<workshop directory>/java/KnoxEventExpanded.jar",
No backslashes are allowed. For all WIndows users, this means that you need to manually change the backslashes \ into forward slashes /.
Also, make sure to keep the same indentation as the other lines.
Finally, be sure to put the path within quotes " and end the line with a comma ,

The top of the json file should now look something like this:
{
"mainClass": "zombie/gameStates/MainScreenState",
"classpath": [
"C:/Program Files (x86)/Steam/steamapps/workshop/content/108600/3397396843/mods/KnoxEventExpandedLegacy/java/KnoxEventExpanded.jar",
".",
... // More below that is not relevant

4. Save the file.
5. Start the game using the default launch method, not alternate.
6. Remember to enable the mod.

If you struggle with the installation, feel free to ask for help in the Discord[discord.gg].

New uninstall method
  1. Open your Project Zomboid directory (In Steam, right-click on the Project Zomboid game and select "Manage"->"Browse local files".
  2. Find the file ProjectZomboid64.json and open it with your favorite text editor e.g. Notepad.
  3. Remove the line you previously added above "." (not "classpath").
  4. Save the file.
  5. The mod is now uninstalled.
NOTE: Running "Verify integrity of game files", switching to the B41 branch of the game, or completely reinstalling the game will also reset the ProjectZomboid64.json file, thus removing the mod.

How to update
No action needed. The class files are automatically updated after the mod has been updated to the new version via Steam.

Old installation method

Windows guide

How to install
  1. Make sure you are on the legacy_42_12 branch (B42) of Project Zomboid, since this version of the mod will only work on that branch.
  2. Open your Project Zomboid directory (In Steam, right-click on the Project Zomboid game and select "Manage"->"Browse local files"
  3. Go to the mod workshop directory: Steam\steamapps\workshop\content\108600\3397396843\mods\KnoxEventExpandedLegacy\java
  4. NOTE: Default directory should be: C:\Program Files (x86)\Steam\steamapps\workshop\content\108600\3397396843\mods\KnoxEventExpandedLegacy\java
  5. Copy the "knox" and "zombie" directories to your Project Zomboid directory (Default: C:\Program Files (x86)\Steam\steamapps\common\ProjectZomboid). If you are copying to the correct directory, it will ask you to replace files. Replace the files it is asking you to replace.
  6. Start the game and remember to activate the Knox Event Expanded mod in the mod list.

How to uninstall
  1. Open your Project Zomboid directory (In Steam, right-click on the Project Zomboid game and select "Manage"->"Browse local files"
  2. Remove the "knox" and "zombie" directories.
  3. In Steam, right-click on the Project Zomboid game and select "Properties"
  4. In the properties window, go to the "Installed Files" tab
  5. Press "Verify integrity of game files"
  6. Steam will now check all files and re-download all files, restoring hem to their original state.

Mac guide
The File Finder application on MacOS cannot be used to copy the files in the same way the Windows equivalent can. It will delete files not modified by the mod, hence it's not a viable option to use this.

Instead, you will use the rsync command from the terminal. The rsync command allows you to copy all files from the workshop directory into the game directory in the same way that is default for Explorer on Windows.
How to install
  1. Make sure you are on the legacy_42_12 branch (B42) of Project Zomboid, since this version of the mod will only work on that branch.
  2. Subscribe to the mod and make sure it's downloaded by Steam.
  3. Open up a terminal.
  4. In the terminal, run the following command: rsync -ahP ~/Library/Application\ Support/Steam/steamapps/workshop/content/108600/3397396843/mods/KnoxEventExpandedLegacy/java/* ~/Library/Application\ Support/Steam/steamapps/common/ProjectZomboid/Project\ Zomboid.app/Contents/Java
  5. Start the game and remember to activate the Knox Event Expanded mod in the mod list.

How to uninstall
  1. Open your Project Zomboid directory (In Steam, right-click on the Project Zomboid game and select "Manage"->"Browse local files".
  2. Right click the app icon to open “show package contents” then go to “contents” -> “java”.
  3. In this directory, remove the "knox" and "zombie" directories.
  4. In Steam, right-click on the Project Zomboid game and select "Properties".
  5. In the properties window, go to the "Installed Files" tab.
  6. Press "Verify integrity of game files".
  7. Steam will now check and re-download all files, restoring hem to their original state.

How to update
Since the mod is still very early in development, which classes exist and doesn't exist might change between updates. The best option is to uninstall the mod according to the instructions above followed by installing the mod again according to the first section of this page.

Configuration
Default memory settings will typically not work with this mod. If you are using mods that loads extra assets e.g. extra items, models etc. this will be even more true.

In order for the game to have good performance even with the mod, you need to increase the amount of available memory for Project Zomboid. There are plenty of guides for how to do this if you Google it. Here's one from Reddit.

Please also keep in mind that when you reinstall the mod (meaning that you use the "Verify integrity of game files"), the increase in memory allocated to Project Zomboid is reset. You will need to reapply the same settings again in order for the memory available for Project Zomboid to be increase.
Last edited by Snejk; Dec 17 @ 6:59am