https://github.com/modrunner/discord-bot

Node.js application powering the Modrunner Discord bot.
https://github.com/modrunner/discord-bot

bot curseforge discord discord-bot discordjs modrinth nodejs

Last synced: 2 months ago
JSON representation

Node.js application powering the Modrunner Discord bot.

• Host: GitHub
• URL: https://github.com/modrunner/discord-bot
• Owner: modrunner
• License: apache-2.0
• Created: 2022-05-23T21:45:48.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-21T20:31:03.000Z (8 months ago)
• Last Synced: 2024-05-22T17:10:27.358Z (8 months ago)
• Topics: bot, curseforge, discord, discord-bot, discordjs, modrinth, nodejs
• Language: JavaScript
• Homepage: https://modrunner.net
• Size: 3.37 MB
• Stars: 11
• Watchers: 1
• Forks: 5
• Open Issues: 33
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome - modrunner/discord-bot - A bot that allows both searching for and tracking updates for projects (Discord bots/webhooks)

README

        


#

_(Formerly Modrinth Bot)_

[](https://discord.gg/HZMCRNUd5Z) [](https://github.com/beans-squared/modrunner-bot/releases) [](./LICENSE) []() [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/F1F8FFBV3)

A Discord bot to search for projects on Modrinth and CurseForge & get notified of updates to tracked projects.

Have a question about Modrunner? Open a [Q&A Discussion](https://github.com/smcmo/modrunner-bot/discussions/new) or join our [Discord](https://discord.gg/HZMCRNUd5Z).

![](./assets/search_example.png)

![](./assets/notification_example.png)

# Features

- **Quick & Easy Searching** 🔍

  - Search for all types of Minecraft projects on supported platforms within Discord

  - Links to open the project's page in your web browser

  - Easily track the project to get updates posted in Discord (see below)

- **Project Update Notifications** 📨

  - Track projects on supported platforms to get notifications posted to Discord whenever the project receives an update

  - Links to open the newly uploaded file(s) page in your web browser

  - Customize your notifications with Normal and Compact embed styles

This is list not exhaustive. Invite the bot to your server today and see what else it can offer!

- **Want to try Modrunner?** Use [this link](https://discord.com/api/oauth2/authorize?client_id=978413985722404924&permissions=2048&scope=bot%20applications.commands).

- **Need help with commands?** Visit the [docs](https://modrunner.net/docs/intro/).

- **Want to contribute to Modrunner?** See [Contributing](./CONTRIBUTING.md).

- **Enjoy Modrunner?**

  - Leave a star ⭐ on the repository!

  - [Buy me a coffee ☕](https://ko-fi.com/beansquared)!

# Invite

[Link](https://discord.com/api/oauth2/authorize?client_id=978413985722404924&permissions=2048&scope=bot%20applications.commands)

# Commands

- `/search` - Get info about projects

- `/track` - Track projects for updates

- `/list` - List all tracked projects

- `/settings` - Customize settings

See the [docs](https://modrunner.net/docs/intro/) for more detailed information.

# Contributing

`npm run dev` - Run the application


`npm run register` - Register application commands to a specific guild


`npm run create-db` - Initialize the database


`npm run reset-db` - Reset the database


`npm run alter-db` - Alter the database


Please check the [development board](https://github.com/smcmo/modrunner-bot/projects), or the [currently open issues](../../issues) before getting started. Issues marked with `good first issue` are ideal for first-time contributors.


See [Contributing](./CONTRIBUTING.md) for more detailed information.