Squad Training Stuff

A small Discord bot for the "Squad Training" Community.
Report a Bug · Request a Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Contact
7. Contributors
8. Acknowledgements

About The Project

A small Discord bot for the SquadTraining Community. (The File Data is so "over-done" in case it is gonna get more dynamic in the future with editing specific RoleList Embeds etc. It is not really needed right now.)

(back to top)

Built With

• 
• .js

(back to top)

Getting Started

Installation

1. Go to Discord Developers and create a new application.
2. Add a new Bot and copy the Bot Token to somewhere safe. Also make sure to turn on all intents so you don't have to deal with weird errors that may occur.
3. Go to "OAuth2" -> "URL Generator", check the boxes "Bot" and "applications.commands" and open it to invite the Bot to your Discord Guild (aka. Discord Server).
4. Clone the repo.

   git clone https://github.com/Kaffeedor/squadtraining.git

5. Install NPM packages (check package.json for dependecies).

   npm install

6. Remove all the '.example' file extensions.

npm removeExample

7. Enter all the Tokens and IDs required in your .env file.
8. Deploy the commands (This will only make them locally available in your Guild; check (deploy-commands.js)[https://github.com/Kaffeedor/squadtraining/blob/main/src/deploy-commands.js] for more).

   npm run deployCommands

(back to top)

Usage

Getting started

• For running it one time use:

  npm run start

• For keeping it running while changing and editing files use:

  npm run dev

Type "/" in your Discord Server where the bot is and you should be able to see and use all commands (that are currently working).

!! Order of images and colors: SL, FTL, Armor, Heli, Mortar !!

(back to top)

Roadmap

• Basic Bot setup
• Ping Command
• Role List
  • Command
  • Automatic updating
  • Set right pictures and colors
  • Make it better (see issues page)
• Set Presence Command
• Auto VC Member count (maybe not?)
• /endround command

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

(back to top)

Contributing

If you have a suggestion that would make this better or want to help fix something, please fork the repo and create a pull request. You can also simply open an issue with the corresponding tag.

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

(back to top)

Contact

Murphy - Discord: cato#0487

Project Link: https://github.com/Kaffeedor/squadtraining

(back to top)

Contributors

• Murphy

(back to top)

Acknowledgements

• ReadmeTemplate

(back to top)