/paimon

Primary LanguageJavaScript

Paimon Bot

Your number one travel companion in Genshin Impact.

Paimon is a discord bot that helps Genshin Impact players plan their farming routine, calculate their DPS, or get info from wiki among other useful commands.

Development Setup

  1. Download and install nodejs.
  2. Clone this repository.
  3. Create your own bot application in discord so you can get your own bot token.
  4. Create a .env file in the root folder of the project then add your own token.
# .env file

TOKEN = "<INSERT YOUR TOKEN HERE>"
  1. Add your own bot to a discord server (you can make a dev server for testing your bots).
  2. Run npm install to install node packages.
  3. Run node index.js then check if the bot will go online in discord.

UID Link

The ?uid command allows you to link a discord user to a given Genshin Impact UID. This would require you to have a linked firestore database and add your credentials to the env file.

Required .env Variables

FIREBASE_API_KEY
FIREBASE_APP_ID
FIREBASE_PROJECT_ID

Auto Swipe and Wish

The ?swipe and ?wish commands are special commands that're being used by our server. They require a specific Google sheet for them to become usable on your own server. However, these are not yet available for other servers to use. If anyone is interested in setting this up on your own server, please leave a Github issue.

Google Sheets Link

Linking to google sheets requires creating a google service account that has edit access to that sheet. Follow this link to create your own google service account.

  • Note that another account hosts/stores the google sheet, (yours or other actual google accounts) not the google service account.
  • After creating the service account, shared your google sheet to the service account with edit permissions.
  • You need to also generate a public/private key pair for your service account, follow this link to generate your keys.

Required .env Variables

EMAIL
KEY
SPREADSHEET_LINK
SPREADSHEET_ID

Variables Explanation