Palcon

<br/> <p align="center"> <a href="https://github.com/josephdicarlo1/palcon"> <img src="static/android-chrome-192x192.png" alt="Logo" width="80" height="80"> </a> <h3 align="center">PalCON</h3> <p align="center"> Simple web UI for your Palworld dedicated server <br/> <br/> <a href="https://github.com/josephdicarlo1/palcon/issues">Report Bug</a> . <a href="https://github.com/josephdicarlo1/palcon/issues">Request Feature</a> </p> </p>

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Installation
    • Docker
    • Standalone
    • Development
• Roadmap
• Contributing
• License
• Authors

About The Project

I wanted a simple and attractive way to manage my Palworld dedicated server with RCON, so I built this.

Built With

• Skeleton

Getting Started

Configuration

Environment variables:

• RCON_HOSTNAME
• RCON_PORT
• RCON_PASSWORD
• HOST (optional)
• PORT (optional, default: 3000)

Installation

---

Docker

1. Clone the repo

git clone https://github.com/josephdicarlo/palcon.git
cd palcon

2. Build the image

# podman works too
docker build -t palcon:latest .

3. Run the image

# podman works too
docker run -it --rm \
  -p 3000:3000 \
  -e RCON_HOSTNAME=palworld.yourserver.com \
  -e RCON_PORT=25575 \
  -e RCON_PASSWORD=wowsosecure \
  palcon:latest

Standalone

1. Clone the repo

git clone https://github.com/josephdicarlo/palcon.git
cd palcon

2. Install dependencies

npm install

3. Build the application

npm run build

4. Run the server

node build/index.js

Development

1. Clone the repo

git clone https://github.com/josephdicarlo/palcon.git
cd palcon

2. Install dependencies

npm install

3. Run the dev server

npm run dev

Roadmap

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

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.
• Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

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

License

See LICENSE

Authors

• Joseph Dicarlo - Caffeine Consumer, Palworld Enjoyer