Table of Contents

1. About Palcon
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About Palcon

Palcon is a CLI tool for interacting with dedicated Palworld servers using the RCON protocol. It currently supports the below features:

Command	Implemented?	Description
ban	✅	Ban a player given a Palworld UID or Steam ID
broadcast	✅	Broadcast a message to the server
exit	✅	Save the server, and then shut down the server
info	✅	Get info about the server
kick	✅	Kick a player given a Palworld UID or Steam ID
save	✅	Save the server
start	✅	Start a server on the local computer

(back to top)

Getting Started

Building From Source

# install Go https://go.dev/doc/install

# clone repo
git clone [email protected]:DavidJS01/palcon.git

# build executable
go build -o palcon.exe

Installation with Go Install

Install From Github (Recommended)

go install github.com/DavidJS01/palcon@latest

> palcon
Palcon is a CLI tool that lets you interact with dedicated palworld servers.

Install Local Project

After cloning the project locally and changing your terminal's directory into the project's root:

# clone project
git clone [email protected]:DavidJS01/palcon.git

# change working directory
cd palcon

# install project
go install

# run palcon
> palcon
Palcon is a CLI tool that lets you interact with dedicated palworld servers.

(back to top)

Usage

# CLI format:
# palcon --host <SERVER IP> --port <SERVER PORT> --password <ADMIN PASSWORD> COMMAND

# get info on server (good for checking if server is online)
palcon --host 173.194.0.0 --port 25575 --password PASSWORD info

# start a local Palworld server
palcon start

# save a server
palcon --host 173.194.0.0 --port 25575 --password PASSWORD save

# get help message with ALL commands
palcon

(back to top)

Roadmap

• Add file based configuration for default host, port, and password

See the open issues for a full list of proposed features and known issues.

(back to top)

Contributing

Contributions are appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/featureName)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/featureName)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL V3 License. See LICENSE.txt for more information.

(back to top)

Contact

David Shipman - [email protected]

(back to top)