Project Zomboid

Project Zomboid

Not enough ratings
Remnants of Kentucky Getting Started Guide
By Big Bad Beaver and 1 collaborators
Looking to setup your own private Remnants of Kentucky server? This quick start guide will help you easily create your own Remnants of Kentucky server and answer many frequently asked questions.
   
Award
Favorite
Favorited
Unfavorite
About Remnants of Kentucky
Remnants of Kentucky is a PvPvE extraction gamemode for Project Zomboid heavily inspired by games like Escape from Tarkov, combining tense PVP encounters with the base game's existing survival and crafting mechanics.


It's been countless years since the Knox Event. With nearly everyone transformed into monsters by the virus, those left standing consider themselves the Remnants of Kentucky - survivors loosely strung together by a collection of settlements and all vying for the last bit of food and supplies.

With rumors of an untouched stockpile of gear at nearby Bria Isle, the very balance of power is up for grabs. Each settlement uses the last bit of their resources to send scavengers down, tasked with collecting as many supplies as possible- by any means necessary...

How to Play
Before stepping foot onto Bria Isle, survivors will start in their safehouse- their own private space away from the horrors of the apocalypse. Here, you can customize your loadout, organize your stash, purchase and sell items through the in-game shop, and prepare for the battle ahead.

When the round begins, you'll appear in a random location on the island, with 20 minutes on the clock. Your goal is to collect as much gear as possible- ranging from essentials like food and medicine, to more frivolous goods like furniture or toy plushies. Each location on the island has something unique to offer, like the military bases, loaded with ammunition and weaponry. Plan your route carefully and make sure you bring a bag!

Time is not on your side. The longer you stay on the island, the more zombies will come. Make sure you check your map for the marked extraction zones and leave before the timer hits zero. You don't want to be there when the horde arrives...

Throughout all of this, zombies won't be the only threat out there. Other survivors from rival settlements are here for the same goal. While you don't need to fight other players, the question remains: will you trust your fellow man, or will you take no chances?

Remnants of Kentukcy comes complete with a custom map, safehouses, extraction system, leaderboard, shop, and more, With support for up to 16 players in a round, you can easily create and host your own Remnants of Kentucky server.

The remainder of this guide will show you how to create, configure, and manage your Remnants of Kentucky server.
Step One: Create a Dedicated Server
Remnants of Kentucky requires you to have a dedicated server. Running a multiplayer game through the main menu's HOST option is NOT supported.

You can create a dedicated server through two methods.

  • You can use third-party server hosting providers to run a dedicated server
or
  • You can use the Project Zomboid Dedicated Server tool listed in your Steam library under Tools.

For the purpose of this guide, we'll be using a dedicated server hosted by GTXGaming[www.gtxgaming.co.uk], but you can easily adapt the steps provided to other hosts or the normal Project Zomboid Dedicated Server tool.

Access your server dashboard
After purchasing your dedicated server, you can access your server dashboard, which controls various functions of your server.


If your server is online, please turn your server offline. On GTXGaming, this is done by clicking the red STOP button. For other dashboards, there will be a similar STOP button or power icon.



Step Two: Configuring Server Files
Every Project Zomboid server creates a series of files in charge of configuring settings. For this mod, you will need to edit the .ini, _SandboxVars.lua, and _spawnregions.lua files.

Please keep in mind, the names of these files will depend on the name of your world file, like so:

  • (world_name).ini
  • (world_name)_SandboxVars.lua
  • (world_name)_spawnregions.lua

For our server, the world has been named by default GTXGaming, so our files are named:

  • GTXGaming.ini
  • GTXGaming_SandboxVars.lua
  • GTXGaming_spawnregions.lua


These files will require edits for Remnants of Kentucky to function properly.

Set correct spawn regions
Spawn regions in Project Zomboid are the starting towns you can select to begin your playthrough in when creating a character. You will need to replace the auto-generated values with the following code in your (SERVERNAME)_spawnregions.lua:
function SpawnRegions() return { { name = "ROK-Safehouses", file = "media/maps/ROK-Safehouses/spawnpoints.lua" } } end

Installing the required mods
First, make sure your server is shut down and wiped of any data. It should be a blank slate before installing Remnants of Kentucky.

We recommend heading using the official mod pack, which can be found here.

Open your (world_name).ini file and scroll until you find two lines that read:

Mods=
and
WorkshopItems=

Copy and paste the mod names into the Mods= section and copy and paste the workshop IDs into the WorkshopItems= section. If you are using the official mod pack, you can copy and paste the below lines.

Mods=tsarslib;TMC_TrueActions;TrueActionsDancing;MoodleFramework;modoptions;BasicCrafting;OutTheWindow;RainWash;TheStar;DylansZombieLoot;BetterFlashlights;DRAW_ON_MAP;VISIBLE_BACKPACK_BACKGROUND;BecomeDesensitized;GeneratorTimeRemaining;FuelAPI;Brita_2;BigBadBeaverMerch;VFExpansion1;P4HasBeenRead;BCGRareWeapons;MoreDescriptionForTraits4166;Skizots Visible Boxes and Garbage2;FancyHandwork;OneHandedSODBShotgun;fuelsideindicator;Gun Stock Attack Remaster;ZombiesHearYourMicrophone;eris_nightvision_goggles;NightVisionChucked;EQUIPMENT_UI;INVENTORY_TETRIS;ROK;Advanced_trajectory;diveThroughWindows;

WorkshopItems=2392709985;2487022075;2648779556;2859296947;2169435993;2621259304;2659216714;2657661246;2619072426;2686972114;2766033079;2804531012;2808679062;2627877543;2883397918;2688538916;2460154811;2992410751;2667899942;2544353492;2432621382;2685168362;2921029369;2904920097;2854697788;2616986064;3022568814;3004111200;1793461606;2842179206;2950902979;2982070344;3161952259;2895102994;2891779083;

If you want to manually choose what mods to use, please be aware that Remnants of Kentucky is not compatible with all mods. Mods that add new items to the game outside of our official mod list will not be able to be purchased in the in-game store, and may break the in-game economy depending on the rarity of the items.

We officially support VFE and Brita's Armor Pack, with more mods to be supported in the future. Remnants of Kentucky was made with Equipment UI and Inventory Tetris in mind, but they're not essential.

Adding the map
Below the Mods= line, you will find Map=. Replace it with the following line:
Map=ROK-Safehouses;ROK-BriaIsle

Configuring other settings

You can edit other server settings in the (world_name).ini file, and we recommend making some other adjustments while here.

1. Disable all anti-cheat
Remnants of Kentucky and other mods utilized in our mod pack require anti-cheat protections to be disabled. Since a server administrator needs to be online to start rounds, cheaters can hopefully be caught during the round by staff.

2. Enable PVP and disable the safety system
By disabling the safety system, players will always be in a PVP state.

3. Disable the safehouse system
Remnants of Kentucky utilizes a custom safehouse system that handles everything automatically.

4. Disable fire
Right now, if a player were to accidentally start a fire in their safehouse, they could break down the walls and potentially break out of their base, which could allow for exploits and other issues. We strongly recommend disabling fire.

5. Disable sledgehammers
Similarly, sledgehammers could be used to easily break out of the safehouse walls.

6. Disable factions
While not required, disabling factions is recommended as factions allow players to team in ways that were unintended with Remnant of Kentucky's design, disabling friendly fire to their teammates.

7. Enable voice chat and 3D voice audio
While not required, voice chat will allow for players to communicate much easier with others in the world, while giving others an opportunity to locate survivors based on their audio direction.

8. Enable trash
Enabling the trash will let players quickly discard of unnecessary items from their safehouse when placed in their trash can.

9. Disable player names entirely
While not required, disabling player names will make encounters much more tense as it'll be harder to tell survivors apart in certain conditions.

All other options can be configured as you see fit.

Configuring sandbox options

Before configuring sandbox options, we recommend you start up the server first, so that the mods you've added can be installed properly. Let the server fully launch, and then shut it down again.

Most settings here can be configured as you see fit, with a few exceptions.

Remnants of Kentucky uses its own zombie spawning system to make sure zombies only spawn during rounds. To ensure this doesn't interfere with Project Zomboid's default zombie spawning system, make sure that under the ZombieConfig= section, you set:

  • PopulationMultiplier to 0.0
  • PopulationStartMultiplier to 0.0
  • PopulationPeakMultiplier to 0.0
  • PopulationPeakDay to 0.0
  • RespawnHours to 0.0
  • RespawnUnseenHours to 0.0
  • RespawnMultiplier to 0.0

While not required, we strongly recommend you set EnableSearch to true under the InventoryTetris= section.

If you are using the Advanced Trajectory mod, you will need to manually enable PVP with firearms by setting playerdamage to true under the Advanced_trajectory= section.

All other settings can be configured as you see fit, but if you'd like to quickly get started, you can use our pre-made SandboxVars.lua file here[pastebin.com] by copy and pasting.

Final steps

You have now fully configured the necessary files. You can start the server and attempt to log in. Before connecting though, we recommend after the server fully loads to use the
/setaccesslevel (username) admin
command to make your account a server administrator. As stated before, Remnants of Kentucky requires an administrator to be online to begin rounds.
Step Three: The ROK admin panel and launching your first round
When you launch into the server, if everything has been configured correctly in step two, you should bypass the spawn selection screen, and after creating your character, shown the default loading screen with different text reading "Welcome, Remnants of Kentucky"


If you see this message, the mod is running correctly!

If you don't see this message, please double check your configuration files.

The ROK admin panel
To start your first round in Remnants of Kentucky, you will need to open the ROK admin panel, which can be accessed by clicking the admin panel icon, above the leaderboard button.


If you do not see this button:

  • Double check you are an admin. You can use the
    /setaccesslevel (username) admin
    command in your console to grant yourself admin perms.
or
  • Try logging in and out of the server to refresh your account state with Remnants of Kenttucky.

When open, you will have a few different options at your disposal. We will cover each option below.


Set Time
This button will let you change the time in game, which is great if you want to run a round in specific conditions. You can shift the time to day, or night.

Teleport to Safehouse
As a server admin, if you need to teleport to another player to assist them with issues, you can use this button to quickly find your way back to your own safehouse.

Manage Players
This button will open a separate menu allowing you to manage the server's user database of players.


Clicking Refresh will refresh the player list.

Clicking Wipe Player will wipe all Remnants of Kentucky data associated with the highlighted player.
  • This will delete all items in their stash, and reset their cash to $10,000.
  • This DOES NOT delete items held on the floor of their safehouse, or remove any custom furniture or items held outside of their stash.
  • The wiped player will also NOT receive a new starter kit, unless you manually press Give Starter Kit.

Clicking Give Starter Kit will spawn the default items in the selected player's stash. Keep in mind, all players are given these items upon their first time logging in, so you should only need to do this after wiping a player's database, or if they're struggling with gear.

Start Match
This is the button you're probably looking for. By pressing this button, all players connected to the server in their safehouses will be teleported to the island, with a new round starting. Make sure all players are ready before starting the round!

Managing a round
When the round begins, the ROK admin panel will shift to showing you match settings and stats.


At a glance you can see the amount of players alive in the round, and the amount of time remaining.

By clicking Match Options, you will open a new menu allowing you to customize the zombie spawn multiplier. If you want to make certain rounds easier or harder on players, feel free to change the multiplier. Make sure you apply your changes!

At any point during a round, you can immediately end a round by clicking Stop. Any players still alive will be teleported back to their safehouses. Players who have died will still have those deaths honored.

Remnants of Kentucky will automatically end a round if all players in the round have extracted or died. If there are players still remaining in the server after overtime ends, they will be killed automatically, and the round will end.

Now that you understand the ROK admin panel, you can invite your friends to join the server and start playing!
Step Four: Maintenance
Remnants of Kentucky does require some infrequent maintenance to keep running properly.

Understanding PVP instances
To get around limitations within Project Zomboid's game engine, Remnants of Kentucky has 100 copies of Bria Island. During normal play, most players will be unable to tell the difference outside of having to center their map when playing on a new round, but as an admin, you will need to watch your available instance count carefully.

When a round starts, the island the round is played on is marked as "used"

When you go through all 100 instances, and use all of the available islands, you will not be able to play Remnants of Kentucky until you reset the instances.

This can be done in three ways:
  • JAVA MOD (RECOMMENDED)[github.com] : Install a Java mod in your Project Zomboid Dedicated Server that will automatically reset PVP instances data on each restart
  • PYTHON SCRIPT[github.com]: Delete all the data via a Python script. The script will reset PVP instances and start the server. You will need to configure config.json before you can run it.
  • You can wipe your server data and start from scratch, resetting all player and world data. This would delete all the items your players have collected in their stash, their cash balance, leaderboards, their stats, and any decorations they've made to their safehouses. This would mean all islands have been re-created though, allowing you to play again.


Moderating your server
Keep in mind, since Project Zomboid's anti-cheat has been disabled, it is possible for players to cheat in your server. If you are hosting a private lobby with only a few players, this likely won't be a concern for you, but if you are going to be hosting a more public server, you may want to consider having server moderators monitoring matches to be wary of any cheating.

It's important to keep in mind though that you may receive reports from players claiming they died from "invisible players" or from false-hits. Unfortunately, due to the current state of Project Zomboid's netcode, desync and lag isn't uncommon.

Lastly, players on the verge of death may choose to combat-log, where they simply Alt+F4 from the server to prevent their loot and items from disappearing. If you find this to be a common trend on your server, Remnants of Kentucky has features in place to punish bad actors. By enabling PunishCrashedPlayers in your (world_name)_SandboxVars.lua file, players who disconnect during a round will:

  • lose all their items carried on their person and bag
  • and pay a percentage of their total cash balance as a fee

You may find this tool powerful to counter this type of behavior, but keep in mind, this will also impact players who may disconnect due to an internet issue or game crash.
All set!
You should be ready to run a Remnants of Kentucky server!

If you still need help, you can review our FAQ here, and join the official Remnants of Kentucky Discord server here.

If you have feature suggestions or feedback for the mod, you can drop them in our Discord server as well. We plan on making many feature additions and bug fixes in the future, along with supporting Build 42.

If you enjoy this mod, please consider supporting me on YouTube and Twitch. I primarily play Project Zomboid every Monday through Thursday starting at 9:30 PM ET.

Have fun in Remnants of Kentucky, and best of luck topping the leaderboards!
19 Comments
Wmfeld 17 Jul @ 5:15am 
search zomboid dedicated server:steamhappy:
ℜ︎ic🐲 18 May @ 12:36pm 
is this still active? I can't find any info anywhere on open servers...
WidesrpdPanicNY 26 Apr @ 3:55pm 
I know I can't use a server through the host menu because it just shows a black screen but why can't I use a server through the host menu?
WiseArkAngel 24 Apr @ 8:23pm 
I see your shorts on Youtube. Keep up the good work.
Brundo 18 Apr @ 2:26am 
do i really need to do all of these some of these seem unnecessary
nurver 12 Apr @ 5:55pm 
sandbox options don't show up in-game unless you have the mod enabled in the main menu

they will also be generated in the ini when the server launches for the first time with the mod loaded

this mod needs to be hosted on a dedicated server though anyways though, you can't host from the main menu
cybersex 29 Mar @ 6:44pm 
i can't find sandox options for the inventory mod and the Advanced Trajectory mpd for some reason. Is there a solution?
Volk411 29 Mar @ 11:04am 
Отличный мод буду устанавливать на выделенный сервер :spiffo:
QQwerty 15 Mar @ 9:15am 
anybody have server to play?
kibasuku 4 Mar @ 11:35am 
@Big Bad Beaver Could you please share your main configuring server files?