Skip to content

Commit

Permalink
make some readme notes more clear
Browse files Browse the repository at this point in the history
  • Loading branch information
gavinnn101 committed Feb 7, 2024
1 parent 01b0d3d commit 1dbefe7
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
Helper utilities for managing a Palworld dedicated server in python. Send rcon commands, backup server, etc.

* underlying rcon implementation should work fine on any OS if you want to use it directly.
* `PalworldUtil` has been tested and works on Windows and linux (ubuntu) following [Windows - (steamcmd) / Linux - (steamcmd) guides](https://tech.palworldgame.com/dedicated-server-guide)
* `PalworldUtil` has been tested and works on Windows (11) and linux (ubuntu 22.04) following [Windows - (steamcmd) / Linux - (steamcmd) guides](https://tech.palworldgame.com/dedicated-server-guide)
* * Some paths and executables are assumed but can be set by the user.

## Setup
* Install python: https://www.python.org/downloads/
* * Make sure to check the box `Add Python to PATH` when installing so you can call python from your terminal.
* Install requirements: `pip install -r requirements.txt`
* Install required python libraries: `pip install -r requirements.txt`

## Usage
* See `./src/palworld_rcon/source_rcon.py` for direct rcon usage.
* * You can call rcon commands via cli
* * You can call rcon commands via library import or via cli:
* * * Looks for environment variables: `palworld_server_ip`, `palworld_rcon_port`, `palworld_rcon_password`, otherwise they are required cli args.
```bash
$.\palworld_dedi_helper\src\palworld_rcon> python source_rcon.py -cmd Info
Expand Down

0 comments on commit 1dbefe7

Please sign in to comment.