Git Product home page Git Product logo

palbot's Introduction

PalBot - Your Palworld Server Companion

PalBot is a discord bot written in NodeJS.

It's aimed towards people who are hosting their own Palworld servers.

Features

Newest feature: Whitelist The bot will check every 5 minutes (changable in the index.js) if every user in the server is whitelisted. The whitelist is disabled by default so if you want to change that, use the /whitelist command.

Commands

/Server - Gives you basic informations about your Palworld server. Be aware though that the "current Players" is not always correct. Gamedig maybe fetches that wrong, not sure.

/rcon-edit - A simple way of managing the people that should be allowed to use the RCON commands. This is made possible through discords role system.

/rcon - This is where the magic happens. You're able to send messages to the server, save the server and also shut the server off.

/whitelist - Ability to enable/disable the whitelist.

/whitelist-edit - Gives you the option to add/remove users (steamId) from the whitelist.

/players - Displays a list of players, ther userId and their SteamId.

More commands are planned as soon as we get more informations on how the servers exactly work!

Warning

If you don't have an automatic startup script for your server, please be aware that there is no way to restart the server via the bot (for now)!

How to use

Go through the usual steps to create a bot over at https://discord.com/developers/ and copy the token and then invite the bot to your server.

Download: https://github.com/Ly-sec/PalBot/releases/

Or just clone the repo

Open the folder in your favorite code editor and then follow these quick steps:

npm install - this will install all dependencies.

Now open the config.json file and enter ALL the informations.

After that, you're basically good to go.

Just run the bot with node .

Config Explanation

Example Config:

{
  "token": "BOT_TOKEN",
  "host": "SERVER_IP",
  "port": 8211,
  "rcon_port": 25575,
  "rcon_password": "RCON_PASSWORD",
  "rcon_role": "RCON_ROLE",
  "whitelist_enabled": true
}

token: The token of your bot (get it from here https://discord.com/developers/applications) host: Your server IP port: Your server port rcon_port: Your RCON port rcon_password: Your AdminPassword (check your server settings) rcon_role: The discord role (name) that should be allowed to use rcon commands whitelist_enabled: Enables/Disables the whitelist (you can always use /whitelist to change it)

Authors

palbot's People

Contributors

ly-sec avatar lilsadpanda avatar

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.