# Asterion

## Get Started
After you invite the bot to your server, it's time to set it up
*For most commands you need to have Administrator privilege or have 'Subs Manager' role*

### **Subscribe to projects**
	- You can use `/subscribe [projectID] [custom channel]` this way you can directly subscribe to project using it's ID
		- You don't have to provide custom channel, then the default one will be used
	- **Easier** `/search [query]`
		- Where you can search for project with slug, ID or it's name
		- The subscribe button doesn't let you pick a channel, but it will use the current one and will let you select another channel

### Other commands
- `/list`
    - This will list all your subscribed projects, default is Plain which is simple text
    - Table will generate Markdown like table
- `/unsubscribe [projectID]`
    - Unsubscribe project - you can actually do that even from search
- `/unsubscribe-all`
  - Removes all subscribed projects (will require confirmation)
- `/latest-release [projectID]`
  - Gives you information about the latest release with a changelog

## Bug reports / Feature suggestions
- If something's not working and the bot is online, check [Modrinth's status page](https://status.modrinth.com/) as Modrinth can be offline
- For bug reports and feature suggestions start a [new issue](https://github.com/Zechiax/RinthBot/issues/new)

## Wiki
For more informations and guides, visit the wiki: https://zechiax.gitbook.io/rinthbot/

## Data collected
- This bot needs to store some data so it can provide you with the updates
- Data stored are
    - Guild ID
    - Update Channel ID
    - List of subscribed projects
- Additional data may be added in the future (like planned layout options etc.)

Asterion

Bot with which you can track project updates from the Modrinth platform 

为Asterion投票

你想要支持我们吗？