44 lines
1.6 KiB
Markdown
44 lines
1.6 KiB
Markdown
# Comando Sunset Security Bot
|
|
|
|
This is the official bot for [Comando Sunset](https://sunset.yusur.moe), a social promotion association.
|
|
|
|
## Features
|
|
|
|
_TODO_
|
|
|
|
## Usage
|
|
|
|
### Installation
|
|
|
|
* Clone the repository: `git clone https://github.com/yusurko/NSYv4Bot.git`
|
|
* Install dependencies: `npm install`
|
|
|
|
### Running the bot
|
|
|
|
* Get your bot token from the [Discord Developer Portal](https://discord.com/developers/applications).
|
|
* 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
|
|
|
|
Licensed under the [Apache License, Version 2.0](LICENSE), a non-copyleft free and open source license.
|
|
|
|
This is a hobby project, made available “AS IS”, with __no warranty__ express or implied.
|
|
|
|
I (sakuragasaki46) may NOT be held accountable for Your use of my code.
|
|
|
|
> It's pointless to file a lawsuit because you feel damaged, and it's only going to turn against you. What a waste of money you could have spent on a vacation or charity, or invested in stocks.
|
|
|
|
|
|
|