Skip to content

Commit

Permalink
Bump version, update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jpenilla committed Feb 15, 2021
1 parent c133e04 commit fdfe651
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 8 deletions.
30 changes: 23 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,28 @@
![MiniMOTD logo](https://i.imgur.com/CXWwjOJ.png)


> MiniMOTD is a basic server list MOTD plugin for Paper (and Spigot) based servers, as well as Bungee and Velocity based
> proxies. MiniMOTD is compatible with servers running versions 1.8 up through 1.16 and newer, although RGB colors
> are only able to be sent from 1.16+ servers, and can only be seen by 1.16+ clients. (RGB colors will be automatically
> downsampled for outdated clients)
> MiniMOTD supports RGB colors and gradients through [MiniMessage](https://github.com/KyoriPowered/adventure-text-minimessage), which is also where MiniMOTD gets it's name.
> For more detailed info on formatting text, refer to the [MiniMessage docs](https://docs.adventure.kyori.net/minimessage.html).
### MiniMOTD is a basic server list MOTD plugin/mod for Minecraft servers and proxies

- MiniMOTD supports RGB colors and gradients through [MiniMessage](https://github.com/KyoriPowered/adventure-text-minimessage), which is also where MiniMOTD gets it's name.
- For more detailed info on formatting text, refer to the [MiniMessage docs](https://docs.adventure.kyori.net/minimessage.html).
- RGB colors are automatically downsampled for outdated clients.
- RGB colors are only able to be sent by proxies and 1.16+ servers, and can only be seen by 1.16+ clients.

![demo motd image](https://i.imgur.com/5yqJx8t.png)
#### Server Platforms
- [Paper](https://papermc.io/) / Spigot
- MiniMOTD is compatible with Spigot, however many features will not work. It is recommended to use Paper for full compatibility.
- [Sponge API 8](https://www.spongepowered.org/)
- [Fabric](https://fabricmc.net/) (requires [Fabric API](https://www.curseforge.com/minecraft/mc-mods/fabric-api))

#### Proxy Platforms
- [Velocity](https://velocitypowered.com/)
- [Waterfall](https://papermc.io/downloads#Waterfall) / Bungeecord

#### Downloads
Downloads can be obtained from [GitHub releases](https://github.com/jpenilla/MiniMOTD/releases). There is a separate jar for each platform, as well as a universal jar for all platforms. Paper and Spigot share the same jar, as do Waterfall and Bungeecord.

#### Configuration
See the [wiki](https://github.com/jpenilla/MiniMOTD/wiki) for configuration details

#### Screenshots
![demo motd image](https://i.ibb.co/1LRCV8b/minimotd-demo.png)
2 changes: 1 addition & 1 deletion build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ plugins {

allprojects {
group = "xyz.jpenilla"
version = "1.3.0+${latestCommitHash()}-SNAPSHOT"
version = "2.0.1+${latestCommitHash()}-SNAPSHOT"
description = "Use MiniMessage text formatting in your servers MOTD."
}

Expand Down

0 comments on commit fdfe651

Please sign in to comment.