Git Product home page Git Product logo

palcon's Introduction


Logo

PalCON

Simple web UI for your Palworld dedicated server

Report Bug . Request Feature

License

Table Of Contents

About The Project

Screen Shot

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

Built With

TypeScriptNodeJSSvelteTailwindCSSVite

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
  1. Build the image
# podman works too
docker build -t palcon:latest .
  1. 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
  1. Install dependencies
npm install
  1. Build the application
npm run build
  1. Run the server
node build/index.js

Development

  1. Clone the repo
git clone https://github.com/josephdicarlo/palcon.git
cd palcon
  1. Install dependencies
npm install
  1. 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

palcon's People

Contributors

josephdicarlo1 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

palcon's Issues

Add authentication

Users should be able to secure their PalCON instance, either fully or to hide important information, like the player list and administration functions.

Add RCON command features

Users should be able to perform RCON actions on their server from the web UI

Shutdown - Params: {Seconds} {MessageText}
DoExit
Broadcast - Params: {MessageText}
KickPlayer - Params: {SteamID}
BanPlayer - Params: {SteamID}
Save

Add an error page for RCON connection failures

Currently if the app is unable to connect to RCON the first time it's accessed, it returns no data and a browser error is shown. Additionally if the app has been accessed before and then loses connection, it only shows a 500 server error with no context.

An error page with obvious error descriptions should be added. It should not expose connection details.

translate question

Is it possible to add a feature that allows you to change the default ui to different languages?

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.