https://github.com/raclettes/counting-bot
Simple bot to have a counting channel!
https://github.com/raclettes/counting-bot
Last synced: 4 months ago
JSON representation
Simple bot to have a counting channel!
- Host: GitHub
- URL: https://github.com/raclettes/counting-bot
- Owner: raclettes
- License: gpl-3.0
- Created: 2021-03-22T20:49:13.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-03-22T23:11:58.000Z (about 4 years ago)
- Last Synced: 2024-11-17T10:45:52.097Z (6 months ago)
- Language: TypeScript
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Counting bot
This is not meant to be a significantly powerful bot, it is merely for experimentation.
Feel free to contribute!
## Configuration
The bot has a single configuration file at the root of the repository, `config.json`.
There is a template at `config.example.json`. Rename this to `config.json` and fill in the details as per the descriptions below.
| Key | Purpose | Default |
|:----|:--------|:--------|
|token*|Your bot token|N/a|
|prefix*|Your bot prefix|N/a|
|countChannelID*|The ID of the channel counting takes place in|N/a|
|adminRolesIDs|Roles that allow the user to run `set-count`. There are no other admin commands (for now). These must be provided as strings, rather than numbers. (put " " around them.)|`[]`|
|errorOnCommandNotFound|Whether to tell the user the command wasn't found if they try to use a command that doesn't exist|`false`|
*necessary to function
## Setup
To install the required dependencies, and have `yarn` installed, run:
```sh
yarn
```
If you use solely NPM, run:
```sh
npm i
```
## Executing
To run the bot, do the following if you use yarn:
```sh
yarn start
```
Or the following for npm:
```sh
npm run start
```
This builds the typescript code to `dist/` and runs it. There are several scripts in `package.json` to build and run linters.
## Credits
This bot is written entirely in TypeScript by @stars#9093. Report any bugs on here or on Discord.