https://github.com/overhash/2hex-starboard
A discord bot that runs a starboard
https://github.com/overhash/2hex-starboard
Last synced: about 1 year ago
JSON representation
A discord bot that runs a starboard
- Host: GitHub
- URL: https://github.com/overhash/2hex-starboard
- Owner: OverHash
- Created: 2019-08-21T04:27:33.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-10-03T03:28:27.000Z (almost 6 years ago)
- Last Synced: 2025-04-11T03:58:08.133Z (about 1 year ago)
- Language: JavaScript
- Size: 233 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 2hex-starboard
A discord bot that runs a starboard for users
# Requirements
**npm 6.0.0 or later is required**
Node installed with npm. I use v10.16.3 for node and 6.9.0 for npm, but earlier versions should work
# Installation
Clone the github repository, and install dependencies as follows:
```bash
npm install quick.db
npm install discord.js
```
Note that with discord.js it is required to have python 2.x (preferably 2.6) and if on windows, the Visual C++ Build Tools (`npm install --global windows-build-tools --vs2015`)
# Enviromental Variables | Config
`BOT_TOKEN` = bot token
`PREFIX` = the prefix for all the bot commands
`ROLEGIVEPREFIX` = the prefix users use to give/remove roles
`COMMUNITYGUILDID` = The community guild ID for submissions
`STARBOARDGUILDID` = The starboard guild ID
`COMMUNITYSUBMISSIONCHANNELID` = The community submission channel ID
`REACTION` = The reaction when messages are posted
`REACTIONSNEEDED` = The amount of reactions for a starboard post to be created
**NOTE: ENVIROMENTAL VARIABLES OVERRIDE CONFIG FILES**
## Usage
```js
node .
```
## License
[0BSD](https://opensource.org/licenses/0BSD)
## Demo
See a demo at [This Discord Server](http://devarchives.xyz/discord), with the starboard [Here](https://discordapp.com/invite/NnH4zTG)