sakobo/README.md

1.5 KiB

Nassiryot Government Bot (4th Era)

This is the official bot for the Nassiryot Government.

For those who don't know, the Nassiryot Republic is a Virtual State, mainly active on Discord.

Features

TODO

Usage

Installation

  • Clone the repository: git clone https://github.com/sakuragasaki46/SKoroshi.git
  • Install dependencies: npm install

Running the bot

  • Get your bot token from the Discord Developer Portal.
  • Paste it in .env, on a new line, like TOKEN=MTMy0URt0k3n_k3EPiT53CREt1.AAAAAA.AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA. .gitignore prevents your .env from being committed, so you can stay safe.
  • Paste your client ID (i.e. your bot's user ID) into .env as well, on a separate line, such as CLIENT_ID=1234567890166642069.
  • Register commands with npm run register. Please note this is needed only when the command list is updated. If you do it every single time you start the bot you may get rate limited.
  • Start the bot with npm start.

Running continuously

You can run the bot in the background, with the benefit of running it at startup and have it restart on errors, with tools such as pm2.

pm2

  • npm install -g pm2
  • pm2 start npm -- start

License

The whole code is licensed under Apache 2.0 License.

This code is available "AS IS", without any warranty, explicit or implied.

I (sakuragasaki46) am not legally liable from Your use of the code.