Minecraft server status in readme/signature

Minecraft server state in your readme/signature.

Setup Guide • Examples • Valid format • Theme demo • Contributing

Features

• Easy to setup and use
• Full customistaion
• Variety of themes
• Supports java and bedrock edition

Setup Guide

Please read the following for an easy setup -

Mandatory parameters for banner:

These below,two parameters are must -

• srvAddress - Pass server address i.e hostname,ip,ip:port or name with domain
• srvType - Pass server type java for Java Edition and bedrock for Bedrock edition.

Optional parameters for banner:

Following parameters can be used for customisation -

• borderColor - pass a border color (or transparent)
• fontWeight - pass normal/bold/bolder/lighter or 100-900
• bgColor - pass background color
• txtColor - pass text color
• headingColor - pass heading color
• iconColor - pass an icon color (or transparent)
• themeval - pass an available theme name

Note1: Color must be passed starting with %23 (encoded value for #)

Note2: Customise all parameters or use theme instead (i.e themeval)

Note3: There is 1 min. cache time for now,set by default

Note4: Possible to skip some optional parameters

Note5: API data maybe inaccurate sometimes

Note6: You can view full info. of a server,example at end

Examples

You can use markdown or img to render minecraft server state

<!-- Markdown -->

![ServerState Minecraft](https://serverstate-minecraft.vercel.app/api?srvAddress=play.craftersmc.net&srvType=bedrock)

or

<!-- HTML -->

<img src="https://serverstate-minecraft.vercel.app/api?srvAddress=play.craftersmc.net&srvType=bedrock alt="ServerState Minecraft"/>

Valid Format

If you don't want icon (iconColor),border (borderColor) and fontWeight just don't pass them in query

Default usage (i.e with random themes)

https://serverstate-minecraft.vercel.app/api?srvAddress=play.craftersmc.net&srvType=bedrock

With a theme

https://serverstate-minecraft.vercel.app/api?srvAddress=play.craftersmc.net&srvType=bedrock&themeval=omni

Full customisation

https://serverstate-minecraft.vercel.app/api?srvAddress=play.craftersmc.net&srvType=bedrock&borderColor=%23000000&fontWeight=bold&bgColor=%23ffffff&txtColor=%23000000&headingColor=%23000000&iconColor=%23000000

Customise theme with borderColor and fontWeight

https://serverstate-minecraft.vercel.app/api?srvAddress=pokecentral.org&srvType=java&themeval=cobalt&borderColor=%23ffffff&fontWeight=bold

Themes Demo (Click link for live preview)

ServerState Minecraft1

ServerState Minecraft2

Checkout themes in All themes or you can get an idea of how themes may look Theme Demo courtesy Anurag Hazra

Changelog

For all the important changelog vist Changelog

References

• anuraghazra/github-readme-stats
• ABSphreak/readme-jokes
• DenverCoder1/github-readme-streak-stats
• Minecraft API by Jacob Gunther

Contributing

Contributions are always welcome!

See Contributing for ways to get started.

Please adhere to this project's Code Of Conduct.

Support

For issues, open a new issue or use discussion.

License

This project is licensed under the MIT License

Follow for more such posts. Feedbacks are welcome.