Skip to main content

A simple tool to install and manage a Palworld dedicated server on Linux.

Project description

Palworld Server Launcher

A simple command-line tool to help you install, manage, and run a dedicated Palworld server on Linux. This tool automates the setup process, including installing dependencies, configuring the server as a systemd service, and setting up permissions for easy management.

Features

  • Automated Installation: Installs SteamCMD and the Palworld dedicated server with a single command.
  • Package Manager Repair: Automatically attempts to fix common apt and dpkg issues before installation.
  • Service Management: Creates a systemd service to run the server in the background and start it on boot.
  • Permission Handling: Configures Polkit rules to allow server management (start, stop, restart) without needing sudo.
  • Unattended Setup: Automatically accepts the SteamCMD license agreement for a smoother setup process.

Prerequisites

  • An Ubuntu Linux distribution.
  • sudo privileges for the user running the script.

Installation

pip install palworld-server-launcher

Usage

After installation, you can use the palworld-server-launcher command:

Install the Server

This command will install the server, configure it with the specified port and player count, and set it up as a systemd service.

# Install the server with default settings (port 8211, 32 players)
palworld-server-launcher install

# Install with custom settings and start the server immediately
palworld-server-launcher install --port 8211 --players 16 --start

Manage the Server

Once installed, you can control the server state. Thanks to the Polkit setup, you do not need sudo for these commands.

# Start the server
palworld-server-launcher start

# Stop the server
palworld-server-launcher stop

# Restart the server
palworld-server-launcher restart

# Check the server's status
palworld-server-launcher status

# Enable the server to start automatically on boot
palworld-server-launcher enable

# Disable the server from starting on boot
palworld-server-launcher disable

### Update the Server

This command will update the Palworld dedicated server to the latest version using SteamCMD.

```bash
# Update the server
palworld-server-launcher update

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

palworld_server_launcher-0.1.18.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

palworld_server_launcher-0.1.18-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file palworld_server_launcher-0.1.18.tar.gz.

File metadata

File hashes

Hashes for palworld_server_launcher-0.1.18.tar.gz
Algorithm Hash digest
SHA256 fd85c0155f0d2c61f2c895f00de79bc5a42ae0a70031422c6725cb63b6a66986
MD5 7f658f46671603b053508cf9701ac042
BLAKE2b-256 27e56ec5921bd14c0ede25bae66947d1eef9dc86e8ad72908ff16fc46004d74f

See more details on using hashes here.

File details

Details for the file palworld_server_launcher-0.1.18-py3-none-any.whl.

File metadata

File hashes

Hashes for palworld_server_launcher-0.1.18-py3-none-any.whl
Algorithm Hash digest
SHA256 ecb0e8d428afe0f41098fc4a56c0e5020c7e5b3b5d6d0b83d0de97495bd5372a
MD5 52d60694bc7fbb83f0ade9dac4fc8f65
BLAKE2b-256 192f6547dcc5cc840d3a6f749333afb256461ca611497591586ee6da1e44bbbf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page