Skip to content

Home

Jump to bottom
Kozejin edited this page Jan 17, 2025 · 30 revisions

Welcome to the Palworld Palbot wiki page! Here are guides on how to setup and configure Palbot for your Palworld servers.

Wiki Updated: 01/17/2025

Environment Variables .env

  • BOT_TOKEN: The token for your discord application.
  • BOT_PREFIX: The prefix that will be used for commands. Default: !
  • BOT_ACTIVITY: The text that displays in your bots activity on discord.
  • BOT_LANGUAGE: The desired language for your bot.
  • STEAM_API_KEY: Your Steam API key. Can be obtained from Steam's dev page.
  • GUILD_WHITELIST: Lets you whitelist your discord so bot can't be invited to others.
  • CHATLOG_PATH: Lets you set the file path to the Palguard logs.
  • CHATLOG_WEBHOOKURL: Defines the webhook url used to send in-game chat messages to discord.
  • CHATLOG_CHANNEL: Set the channel to broadcast your messages to.
  • CHATLOG_SERVERNAME: Name of the server your chat will be broadcasted to.

Configuring Bot

All configuration is done directly from discord now.

Server Configuration:

  • Utilize the /addserver command to add your server.
    • Server Name: The name is just a unique identifier. Can be one or two words.
    • Server Host: This is the host address to your server. Example: 127.0.0.1
    • RCON Port: This is the assigned rcon port to your server.
    • Connection Port: This is the port used to connect to your server. Example: 127.0.0.1:8211
    • Admin Password: This is the password used to access admin command in-game and over RCON.
  • Utilize the /removeserver to delete it from the bot.

Economy Configuration:

  • Utilize the /economyset settings command to configure your economy.
    • Currency Name: The name of your servers currency.
    • Invite Reward: The amount of points earned from inviting someone to discord.
    • Mini Work Reward: The minimum amount earned from working.
    • Maximum Work Reward: The maximum amount earned from working.
    • Daily Reward: The amount earned from your daily.
  • Utilize the /economyset timers to configure economy timers.
    • Work Timer (Seconds): The amount of time between each work cycle.
    • Daily Timer (Seconds): The amount of time between each daily use.
  • Utilize the /economyset misc to configure miscellanea settings.
    • Work Description: The text that will appear on /work.
    • Role Bonuses: Roles that will be awarded bonus Points when utilizing commands. Percentage based.
  • Utilize the /economyset vote to configure the vote settings for serverlist.gg
    • Vote Slug: The slugs for your server name. Example: 123456-servername
    • Vote API Key: This is the Server Key provided to your by the voting website.
    • Vote Reward: This is how many points you want to award when someone votes.

Kits Configuration:

  • Use /uploadkits to import your old kits.json file to the bot.
  • Use /exportkits to export your kits from the database.
  • Utilize the /managekits command to add or edit existing kits.
    • Kit Name: The name of the kit.
    • Commands Example: ["give {steamid} HandGun_Default_2 1", "give {steamid} HandgunBullet 250"]
    • Description: What you want the kit to say in the shop.
    • Price: The price of your kit in the shop. Setting price to 0 hides it.
  • Utilize the /deletekit command to delete a kit.

Pal Game Configuration:

  • Utilize the /gamesettings core to configure core Pal Game settings.
  • Utilize the /gamesettings adventure to configure adventure settings for Pal Game.

Pal Chat Configuration:

  • CHATLOG_PATH: Set your palguard logs path in the .env file:
    • Example: c:\path\to\server\Pal\Binaries\Win64\palguard\logs
  • CHATLOG_WEBHOOKURL: Set your webhook url which will be used to send the messages:
    • Example: https://discord.com/api/webhooks/12345678910
  • CHATLOG_CHANNEL: Copy the ID for the channel that will be used to broadcast messages.
    • Example: 12345678910
  • CHATLOG_SERVERNAME: The unique name you set for your server on the bot and is used in the selection of commands.
    • Example: Paltopia

Translation Support

Palbot now supports multiple languages and will rely on community support for translation. Translation files are location in the i18n folder or can find the default English template here.

How to submit?

  • You can translate the file and submit it in a pull request with 1 commit. Making multiple commits for a translation file will result in it being closed.
  • Submit it on my discord as a copy/paste or over a website like pastebin or my paste server. I do not take files directly from people.

Supported Languages

  • en: English
  • es: Spanish
  • de: German
  • br: Brazilian Portuguese
Clone this wiki locally