Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nachotoast/lsb-discord-bot

Personal utility Discord bot for the LSB server.
https://github.com/nachotoast/lsb-discord-bot

discord discord-bot discord-js nodejs

Last synced: 8 days ago
JSON representation

Personal utility Discord bot for the LSB server.

Awesome Lists containing this project

README

        

# LSB Discord Bot

A [Discord.js](https://discord.js.org/#/) bot for the LSB Discord server.

# Dependencies

- [Node JS](https://nodejs.org/en/) 16.13.1 or higher

# Installation

_Follow these instructions to set up your own development version of the bot._

1. Register your bot on the [Discord Developer Portal](https://discord.com/developers/applications).

- Intents
- Presence
- Server Members
- Message Content
- Permissions
- Administrator

2. Invite the bot to your Discord server using the OAuth2 URL Generator with the `bot` scope and `Administrator` bot permission.
3. Clone [this repository](https://github.com/NachoToast/LSB-Discord-Bot).
4. Copy the [`auth.example.json`](./auth.example.json) file.
1. Rename the copy to [`auth.json`](./auth.json).
2. Replace the [`devToken`](./auth.example.json#L3) field with the token of the bot you just registered.
5. Open a terminal and use `yarn` (recommended) or `npm` to install dependencies.

```sh
# with yarn
$ yarn

# with npm
$ npm install
```

6. Start the bot in development using the provided script.

```sh
# with yarn
$ yarn dev

# with npm
$ npm run dev
```

- To start the bot in production:

1. Make sure you've run `yarn build` first, and have a `token` configured in [`auth.json`](./auth.json)
2. Start the bot with one of the following commands:

```sh
# with node
$ node .

# with yarn
$ yarn start

# with npm
$ npm run start
```

- You can install `yarn` via `npm` using `npm i -g yarn`

# Levels

If you want user levels to carry over from when Mee6 was in use, you can run the porting script using `yarn port` or `npm run port`.

You'll need to enter the ID of the server, and make sure Mee6 hasn't left it yet.

Once you do this, you'll see a message about loading legacy data when you start the bot.

After you've started it once (in development or production), you can safely delete the `archive` folder.