https://github.com/mcbeet/beet-bot

The discord bot for the beet server.
https://github.com/mcbeet/beet-bot

beet discord-bot docker minecraft minecraft-commands

Last synced: about 1 month ago
JSON representation

The discord bot for the beet server.

• Host: GitHub
• URL: https://github.com/mcbeet/beet-bot
• Owner: mcbeet
• License: mit
• Created: 2022-04-26T20:12:37.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-23T01:52:49.000Z (11 months ago)
• Last Synced: 2024-04-24T21:20:57.286Z (9 months ago)
• Topics: beet, discord-bot, docker, minecraft, minecraft-commands
• Language: TypeScript
• Homepage:
• Size: 361 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# beet-bot

[![GitHub Actions](https://github.com/mcbeet/beet-bot/workflows/CI/badge.svg)](https://github.com/mcbeet/beet-bot/actions)

[![npm](https://img.shields.io/npm/v/beet-bot.svg)](https://www.npmjs.com/package/beet-bot)

[![Discord](https://img.shields.io/discord/900530660677156924?color=7289DA&label=discord&logo=discord&logoColor=fff)](https://discord.gg/98MdSGMm8j)

> Packages for the beet bot.

Click the following invite link to add the bot to your own server:

- https://discord.com/api/oauth2/authorize?client_id=980644229984419932&permissions=0&scope=bot%20applications.commands

## Installation

You can install the beet bot via `npm`.

```bash

$ npm install beet-bot

```

To run your own instance of the bot use the `beet-bot` command or simply run it with `npx` to install it automatically.

```bash

$ npx beet-bot --clientId=... --token=...

```

## Usage

You can provide credentials through command-line options `--clientId/--token` or by using environment variables `BEET_BOT_CLIENT_ID/BEET_BOT_TOKEN`. The bot will load the `.env` file in the working directory. The `--config` option lets you specify a json file in which you can define runner environments.

```bash

$ beet-bot --config bot.json

```

> Check out the sample [bot.json](bot.json).

## Contributing

This is a monorepo managed with [`pnpm`](https://pnpm.io/). If you don't have it installed already check out the [standalone script](https://pnpm.io/installation) for your platform or get it via [Corepack](https://github.com/nodejs/corepack) using `corepack enable`.

```bash

$ pnpm install

```

Set up packages for local development by running `pnpm -r stub`, and then launch the bot with the required credentials.

```bash

$ pnpm dev --clientId=... --token=...

```

You can also create a `.env` file at the root of the repository.

```env

BEET_BOT_CLIENT_ID=...

BEET_BOT_TOKEN=...

```

To build for production use the `pnpm -r build` command. Note that this overwrites package stubs so you will need to run `pnpm -r stub` again if you want to resume developing locally.

```bash

$ pnpm -r build

$ pnpm start --clientId=... --token=...

```

The project must type-check and `eslint` shouldn't report any error.

```bash

$ pnpm -r lint

```

---

License - [MIT](https://github.com/mcbeet/beet-bot/blob/main/LICENSE)