README.md

This repository is meant to help people use zrok to run Palworld.

Prerequisites

• follow the Palworld tech guide to install the Palworld dedicated server
• download the latest zrok for windows (zrok_0.4.23_windows_amd64.tar.gz as of feb 9 2024)
• use windows explorer (win11+) or 7zip or something to ungzip and untar the download
• put the zrok.exe somewhere you can find, for example c:\zrok\zrok.exe
• invite yourself to zrok using: zrok invite. see https://docs.zrok.io/docs/getting-started/#generating-an-invitation

On the Palworld server:

• zrok enable the server. see Enabling Your zrok Environment

• download: the start-server script

• edit the start-server script and update the PATH_TO_ZROK with the location of your zrok.exe

• run start-server.ps1 (the script is not signed, research this if you don't understand it):

  powershell.exe -ExecutionPolicy Bypass -File start-server.ps1
  

• after zrok starts, there will be a private token that you need to distribute to the people you want to allow to access the Palworld server:

• 

On the Palworld clients:

• zrok enable the client. see Enabling Your zrok Environment

• download the start-client script

• update the start-client script and update the PATH_TO_ZROK with the location of your zrok.exe

• run start-client.ps1 (the script is not signed, research this if you don't understand it):

  powershell.exe -ExecutionPolicy Bypass -File start-client.ps1
  

• when the start-client.ps1 script executes, you'll be prompted to enter the secret token from the server:

YouTube Video Overview: