A small Discord bot aimed to make it easier to record attendance at Powerbits Gameteam (PBS) Hell Let Loose trainings. See https://pbsgameteam.com for more info about joining in.
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
Currently known prerequisites:
- Clone the repo
git clone https://github.com/isaac-jordan/squad-bot-discord.git
cd squad-bot-discord
- Create a new Discord application at https://discord.com/developers/applications
- Head to the "Bot" tab, grab the token, and paste it into credentials.json as
discord_bot_token
like so
{
"discord_bot_token": "<your_token>"
}
- Head to the "OAuth2" tab:
- Select "bot" as the scope
- Select these permissions:
1.
View Channels
1.Send Messages
1.Attach Files
- Copy the URL (starting
https://discord.com/api/oauth2/authorize?
), and use it to add the bot to your test server (it can be useful to write this down inside credentials.json) - Install NPM packages
npm install
- Run locally using
npm run start:dev
- Add the bot to your Discord server
- Type
!squadbot <gamename>
in a text channel in your Discord server - The bot will respond with a text file containing the users in each voice channel under a channel category containing ""
See the open issues for a list of proposed features (and known issues).
Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE
for more information.
Create an issue!