Bosco

 

---

Table of Contents

• About
• Usage
  • /ping
  • /deep-dive
  • /rock-and-stone
  • /trivia
  • /invite
  • /help
• Local Development
  • Registering
  • Configuring
  • Installing
  • Linting
  • Testing
  • Executing
• Dependencies
• Deployment
• Contributing
• Special Thanks
• Disclaimer
• Legal

About

Bosco is a free, open-source Discord bot and companion for Deep Rock Galactic players. It can fetch weekly Deep Dives, provide random DRG trivia, and more!

Usage

Once Bosco has been invited to your server, it supports the following slash commands:

/ping

• Description: Ping Bosco and get latency.
• Options: None
• Syntax:

  /ping
  

• Example:

/deep-dive

• Description: Get weekly Deep Dive details.
• Options:
  • variant: An optional enum indicating which Deep Dive to fetch details for. Enum values: ALL (default), DEEP_DIVE, and ELITE_DEEP_DIVE.
• Syntax:

  /deep-dive variant=ELITE_DEEP_DIVE
  

• Example:

/rock-and-stone

• Description: You already know what this does.
• Options: None
• Syntax:

  /rock-and-stone
  

• Example:

/trivia

• Description: Get a random piece of DRG trivia.
• Options: None
• Syntax:

  /trivia
  

• Example:

/invite

• Description: Invite Bosco to your server.
• Options: None
• Syntax:

  /invite
  

• Example:

/help

• Description: View the command list and helpful links.
• Options: None
• Syntax:

  /help
  

• Example:

Local Development

In order to run Bosco locally, you will need to install Python 3 and perform some initial setup.

Registering

Go to the Discord Developer Portal and create a new application. Then, click on the "Bot" tab and copy your bot token which will be used in the next step.

Configuring

Create a file called .env within the src/ directory to hold your environment variables, and add the following (replacing <VALUE> with the real value):

DISCORD_TOKEN=<VALUE>

Installing

Install dependencies by executing the install.sh script with the -d flag. Alternatively, you can use the -i option while executing the lint.sh, test.sh, or run.sh scripts to install dependencies in a single step:

./src/scripts/install.sh -d

Linting

Run the linter by executing the lint.sh script:

./src/scripts/lint.sh [-i,-h]

Testing

Run the unit tests by executing the test.sh script:

./src/scripts/test.sh [-i,-h]

Executing

Start Bosco by executing the run.sh script:

./src/scripts/run.sh [-i,-h]

Dependencies

Dependencies are automatically scanned and updated with Dependabot every weekday at 10am UTC, as configured in dependabot.yml. For questions about security, please reference the Security Policy.

Deployment

The bot is automatically deployed to the DigitalOcean App Platform whenever a push is made to the main branch.

Contributing

Contributions are welcome! If you found a bug or have a feature request, please open an issue. If you would like to contribute changes, please fork this repository, open a pull request with your changes, and link the PR with an issue. All contributions must adhere to the Code of Conduct. PRs must pass all status checks (linting, code quality, etc.) and recieve codeowner approval before they will be merged.

Special Thanks

• The DRG API contributors for developing the API that powers Bosco
• The folks who maintain the Deep Rock Galactic Wiki for supplying game resources and data
• The Deep Rock Galactic developers for being awesome and incredibly engaged with the community

Disclaimer

Neither this project nor its contributors are associated with Deep Rock Galactic or Ghost Ship Games in any way whatsoever.

Legal

• Terms of Service
• Privacy Policy
• Security Policy
• MIT License

Copyright © 2023 Hayden Moritz