Skip to content

Commit 207070c

Browse files
committed
docs(README): update features, integrations, badges and sponsors
1 parent af69840 commit 207070c

File tree

1 file changed

+26
-4
lines changed

1 file changed

+26
-4
lines changed

README.md

+26-4
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,10 @@
66

77
Bring your Minecraft world into your Discord guild
88

9+
[![Build](https://img.shields.io/github/actions/workflow/status/axieum/minecord/release.yml?branch=main&style=for-the-badge)][ci:release]
910
[![Release](https://img.shields.io/github/v/release/axieum/minecord?style=for-the-badge&include_prereleases&sort=semver)][releases]
10-
[![Available For](https://img.shields.io/badge/dynamic/json?label=Available%20For&style=for-the-badge&color=34aa2f&query=gameVersionLatestFiles%5B0%5D.gameVersion&url=https%3A%2F%2Faddons-ecs.forgesvc.net%2Fapi%2Fv2%2Faddon%2F502254)][curseforge]
11-
[![Downloads](https://img.shields.io/badge/dynamic/json?label=Downloads&style=for-the-badge&color=f16436&query=downloadCount&url=https%3A%2F%2Faddons-ecs.forgesvc.net%2Fapi%2Fv2%2Faddon%2F502254)][curseforge:files]
11+
[![Available For](https://cf.way2muchnoise.eu/versions/Available%20For_502254_latest.svg?badge_style=for_the_badge)][curseforge]
12+
[![Downloads](https://cf.way2muchnoise.eu/full_502254_downloads.svg?badge_style=for_the_badge)][curseforge:files]
1213

1314
</div>
1415

@@ -19,6 +20,12 @@ It is a **server-side** only mod, uses [JDA][jda] to interface with Discord, is
1920
built on the [Fabric][fabric] mod loader, and is available for modern versions
2021
of [Minecraft][minecraft] Java Edition.
2122

23+
#### Integrations
24+
25+
* [TextPlaceholderAPI][text-placeholder-api] by Patbox &mdash; for text
26+
placeholders
27+
* [TydiumCraft Skin API][tydiumcraft-api] by Tydium &mdash; for embed avatars
28+
2229
## Features
2330

2431
### 💬 Chat
@@ -29,6 +36,7 @@ between Minecraft and Discord.
2936
* Multi-channel support
3037
* Filter events to Minecraft dimensions
3138
* Translate unicode emojis, e.g. 😃 -> `:smiley:`
39+
* Show player avatars in embeds where appropriate
3240
* Discord events relayed to Minecraft
3341
* A user sent a message
3442
* A user sent a message in reply to another
@@ -44,7 +52,9 @@ between Minecraft and Discord.
4452
command
4553
* A player had died
4654
* A named animal/monster (with name tag) had died
47-
* A player unlocked an advancement
55+
* A player unlocked an advancement task
56+
* A player reached an advancement goal
57+
* A player completed an advancement challenge
4858
* A player teleported to another dimension
4959
* A player joined the game
5060
* A player left the game
@@ -53,7 +63,7 @@ between Minecraft and Discord.
5363
* The server began to stop
5464
* The server stopped and is offline
5565
* The server stopped unexpectedly and is inaccessible
56-
* Optionally attach the crash report when available
66+
* Optionally attach the crash report if available
5767

5868
### 🪄 Commands
5969

@@ -67,6 +77,7 @@ commands to interact with your Minecraft server from Discord.
6777
* For example, you could manage your server's whitelist via `/whitelist`
6878
* Ability to apply cooldowns to commands
6979
* This can be configured on a per user, channel or guild basis
80+
* Detects players in commands and places their avatar in the response
7081
* Mod developers can register their own slash commands
7182

7283
### 😇 Presence
@@ -88,6 +99,13 @@ presence in Discord to show more detailed statuses.
8899
[API](minecord-api/README.md) is a gateway into the Minecord mod. It equips
89100
developers with the tools necessary to integrate their mods with Discord.
90101

102+
## Sponsors
103+
104+
We would like to extend our thanks to the following sponsors for supporting
105+
Minecord development.
106+
107+
[<img alt="BisectHosting" src="https://www.bisecthosting.com/partners/custom-banners/b9fe4fbe-8cc4-42cc-a545-dfd1b46d20e6.webp" height="80">][bisecthosting]
108+
91109
## Contributing
92110

93111
Thank you for considering contributing to Minecord! Please see the
@@ -102,6 +120,8 @@ vulnerabilities.
102120

103121
Minecord is open-sourced software licenced under the [MIT licence][licence].
104122

123+
[bisecthosting]: https://bisecthosting.com/axieum
124+
[ci:release]: https://github.com/axieum/minecord/actions/workflows/release.yml
105125
[contributing]: .github/CONTRIBUTING.md
106126
[curseforge]: https://curseforge.com/minecraft/mc-mods/minecord-for-discord
107127
[curseforge:files]: https://curseforge.com/minecraft/mc-mods/minecord-for-discord/files
@@ -111,3 +131,5 @@ Minecord is open-sourced software licenced under the [MIT licence][licence].
111131
[minecraft]: https://minecraft.net/
112132
[releases]: https://github.com/axieum/minecord/releases
113133
[security]: .github/SECURITY.md
134+
[text-placeholder-api]: https://github.com/Patbox/TextPlaceholderAPI
135+
[tydiumcraft-api]: https://www.tydiumcraft.net/docs/skinapi

0 commit comments

Comments
 (0)