isaac-jordan/squad-bot-discord

A Discord bot to help record attendance at gaming groups and meetings.

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

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.

Built With

• TypeScript
• Node.js
• Discord.js

Getting Started

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.

Prerequisites

Currently known prerequisites:

• Node.js v12

Installation

1. Clone the repo

git clone https://github.com/isaac-jordan/squad-bot-discord.git
cd squad-bot-discord

1. Create a new Discord application at https://discord.com/developers/applications
2. 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>"
}

1. Head to the "OAuth2" tab:
2. Select "bot" as the scope
3. Select these permissions: 1. View Channels 1. Send Messages 1. Attach Files
4. 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)
5. Install NPM packages

npm install

1. Run locally using npm run start:dev

Usage

1. Add the bot to your Discord server
2. Type !squadbot <gamename> in a text channel in your Discord server
3. The bot will respond with a text file containing the users in each voice channel under a channel category containing ""

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Create an issue!

Acknowledgements

• README Template