diff --git a/docs/discord_roles.md b/docs/discord_roles.md new file mode 100644 index 000000000000..92090559fdf7 --- /dev/null +++ b/docs/discord_roles.md @@ -0,0 +1,137 @@ +# SkyHanni Server Roles + +This is a list of all server roles on the SkyHanni Discord server. +This explains why the roles exist and how to get them. +**You can NOT apply to any of those roles directly.** (except ping roles) + +## Full Permissions Roles + +If those users talk to you, their word is law. + +- **Admin** + - Only the most trusted members. + - Full control over the Discord server, manages role assignments. + +## Core Team Roles + +Hand-picked by **Admins** from members who have already held the **Contributor** or **Community Helper** role for some time. +If those users talk to you, you better pay attention. + +- **Staff** + - Legacy role with many permissions. May be merged into Admin in the future. + +[//]: # (This is a hidden comment: Clarify why Staff role even exists: can this get merged with Admin eventually? Jani, can this go?) + +- **Moderator** + - This role has moderation permissions (warn, mute, ban). + - Independent of coding/contributing. + - Gets selected from **Community Helper** or higher roles. +- **Mod Maintainer** + - Most trusted coders without full access. + - They know SkyHanni very well. + - If you have coding questions, ask them. +- **Main Contributor** + - Developers who help the project a lot over a long time. + - A cosmetic role between **Contributor** and **Mod Maintainer**. + +## Helper Roles + +People who help the mod. +If those users talk to you, they probably know what they're talking about. + +- **Contributor** + - The role for everyone who makes meaningful code contributions to the mod on GitHub. + - Requires one or more merged PRs on GitHub, not just suggestions or bug reports. +- **Community Helper** + - Someone who helps others in the Discord a lot around SkyHanni. + - Selected by Admins and Main Contributors from active community members. + +## Fancy Roles + +These roles are purely cosmetic and exist to recognize specific community contributions or partnerships. +If those users talk to you, you read their name in cool colors. + +- **Bug Hunter** + - Awarded to members who report important or hard-to-find bugs, or who go out of their way to test features and track down + issues. +- **Makes Good Suggestions** + - Awarded to members who suggest well-thought-out ideas for new or improved features. +- **Cool Developer** + - Developer or contributor of another SkyBlock-related resource: Third-party mods, websites, tools, etc. +- **Cool Content Creator** + - YouTuber, streamer, or admin of a third-party Discord server who helps spread the word about SkyHanni. +- **Cool Person** + - Friends of **Admins**. +- **Patreon Supporter** + - Pay to win role. +- **Server Booster** + - Automatically assigned by Discord to members who actively boost the server. + - Unlocks Discord-native visual perks. + +## Normal Roles + +If those users talk to you, congratulations, you found the chat. + +- **Member** + - Lucky users who found the invite link. + +## Ping Roles + +All those roles are self-selectable for all members. +If those users talk to you, you are yapping with a nerd. + +- **Announcements** + - When something big happens. +- **Update Ping** + - When the mod updates to a shiny new release. +- **Beta Ping** + - When a new beta version is available for testing. + +[//]: # (This is a hidden comment: This role may be renamed to Beta Tester in the future.) + +- **Leaks Ping** + - When a **Main Contributor** or higher decides to show off something new and cool. +- **Stream Ping** + - When someone actually streams while coding. It happens. Sometimes. + +## Bot Roles + +Only for bots, with different levels of permissions. +If those users talk to you, you know they aren't human. + +- **Bot** + - Generic "this is a bot" role. + - For all bots on the server. + - This doesn't mean they have rights or something, we just want them to show up high in the member list. +- **SH Bot** + - SkyHanni bot does SkyHanni-specific stuff. + - Mainly auto-tags and Pull Request linking. +- **Elite** + - Elite Farming bot offers `/weight` and other farming-related utility commands. +- **SkyHelper** + - SkyHelper is the go-to SkyBlock bot. + - `/networth`: Total worth of a player's or guild's items. + - `/missing`: Missing accessories with prices. + - `/leaderboard`: Player or guild leaderboards. + +- **Kuudra Gang** + - Kuudra Gang bot helps with math around Kuudra runs or Kuudra items. +- **Tanzanite** + - Tanzanite bot does generic Discord utility stuff like logging, banning, or setting reminders. +- **Carl Bot** + - Carl bot also does Discord utility stuff. + +[//]: # (This is a hidden comment: Does Carl Bot actually only do logging? What else?) + +- **Fire** + - Fire bot reacts to links of Discord messages with said Discord message. + +## Special Roles + +Hopefully you don't encounter such users in the wild. +If those users talk to you, you can ignore them. + +- **Muted** + - You shall not write. +- **No Reaction** + - No more pleading reactions for you.