Giter Site home page Giter Site logo

pdsxi415 / palworld-server-docker Goto Github PK

View Code? Open in Web Editor NEW

This project forked from thijsvanloef/palworld-server-docker

0.0 0.0 0.0 32 KB

A Docker Container to easily run a Palworld dedicated server.

Home Page: https://hub.docker.com/r/thijsvanloef/palworld-server-docker

License: MIT License

Shell 66.59% Dockerfile 33.41%

palworld-server-docker's Introduction

Palworld Dedicated Server Docker

Release Docker Pulls Docker Stars Image Size

View on Docker Hub

NOTE: Unsure how to get started? Check out the this guide I wrote!

This is a Docker container to help you get started with hosting your own Palworld dedicated server.

This Docker container has been tested and will work on both Linux (Ubuntu/Debian) and Windows 10.

Important

At the moment, Xbox Gamepass/Xbox Console players will not be able to join a dedicated server.

They will need to join players using the invite code and are limited to sessions of 4 players max.

How to use

Keep in mind that you'll need to change the environment variables.

Docker Compose

This repository includes an example docker-compose.yml file you can use to setup your server.

services:
   palworld:
      image: thijsvanloef/palworld-server-docker
      restart: unless-stopped
      container_name: palworld-server
      ports:
        - 8211:8211/udp
        - 27015:27015/udp
      environment:
         - PORT=8211
         - PUID=1000
         - PGID=1000
         - PLAYERS=16
         - MULTITHREADING=FALSE
         - COMMUNITY=false  # Enable this if you want your server to show up in the community servers tab, USE WITH SERVER_PASSWORD!
         # Enable the environment variables below if you have COMMUNITY=true
         # - SERVER_PASSWORD="worldofpals"
         # - SERVER_NAME="World of Pals"
         # - ADMIN_PASSWORD="someAdminPassword"
      volumes:
         - /path/to/your/palworld/folder:/palworld/

Docker Run

Change every <> to your own configuration

docker run -d \
    --name palworld-server \
    -p 8211:8211/udp \
    -p 27015:27015/udp \
    -v ./<palworld-folder>:/palworld/ \
    -e PLAYERS=16 \
    -e PORT=8211 \
    -e PUID=1000 \
    -e PGID=1000 \
    -e COMMUNITY=false \
    --restart unless-stopped \
    thijsvanloef/palworld-server-docker

Environment variables

You can use the following values to change the settings of the server on boot. It is highly recommended you set the following environment values before starting the server:

  • PLAYERS
  • PORT
  • MULTITHREADING
Variable Info Default Values Allowed Values
PLAYERS* Max amount of players that are able to join the server 16 1-31
PORT* UDP port that the server will expose 8211 1024-65535
PUID* The uid of the user the server should run as 1000 !0
PGID* The gid of the group the server should run as 1000 !0
MULTITHREADING** Improves performance in multi-threaded CPU environments. It is effective up to a maximum of about 4 threads, and allocating more than this number of threads does not make much sense. false true/false
COMMUNITY Whether or not the server shows up in the community server browser (USE WITH SERVER_PASSWORD) false true/false
PUBLIC_IP You can manually specify the global IP address of the network on which the server running.If not specified, it will be detected automatically. If it does not work well, try manual configuration. x.x.x.x
PUBLIC_PORT You can manually specify the port number of the network on which the server running.If not specified, it will be detected automatically. If it does not work well, try manual configuration. x.x.x.x
SERVER_NAME A name for your community server "string"
SERVER_PASSWORD Secure your community server with a password "string"
ADMIN_PASSWORD Secure administration access in the server with a password "string"
UPDATE_ON_BOOT** Update/Install the server when the docker container starts (THIS HAS TO BE ENABLED THE FIRST TIME YOU RUN THE CONTAINER) true true/false

*highly recommended to set

** Make sure you know what you are doing when running this this option enabled

Game Ports

Port Info note
8211 Game Port (UDP)
27015 Query Port (UDP) You are not able to change this port as of now

Reporting Issues/Feature Requests

Issues/Feature requests can be submitted by using this link.

Known Issues

Known issues are listed in the wiki

palworld-server-docker's People

Contributors

thijsvanloef avatar fryfrog avatar atwardowski avatar twinki14 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.