https://github.com/jayantur13/serverstate-minecraft
Minecraft server state in your Github readme or as signature in forums/boards
https://github.com/jayantur13/serverstate-minecraft
minecraft minecraft-banner minecraft-data minecraft-tools monitoring-tool readme
Last synced: 6 months ago
JSON representation
Minecraft server state in your Github readme or as signature in forums/boards
- Host: GitHub
- URL: https://github.com/jayantur13/serverstate-minecraft
- Owner: jayantur13
- License: mit
- Created: 2022-06-16T09:24:48.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-24T07:18:33.000Z (9 months ago)
- Last Synced: 2025-04-05T01:11:12.716Z (6 months ago)
- Topics: minecraft, minecraft-banner, minecraft-data, minecraft-tools, monitoring-tool, readme
- Language: JavaScript
- Homepage: https://serverstate-minecraft.vercel.app
- Size: 1.14 MB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
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
```
```
or
```
```
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
[](https://ismcserver.online/bedrock/play.craftersmc.net)
[](https://ismcserver.online/ms.pixelmonrealms.com)
Checkout themes in [All themes](https://github.com/jayantur13/tree/main/src/themes.json "All Themes") or you can get an idea of how themes may look [Theme Demo courtesy Anurag Hazra](https://github.com/anuraghazra/github-readme-stats/tree/master/themes "Theme Demo Here")
## Changelog
For all the important changelog vist [Changelog](https://github.com/jayantur13/serverstate-minecraft/blob/master/CHANGELOG.md)
## References
- [anuraghazra/github-readme-stats](https://github.com/anuraghazra/github-readme-stats)
- [ABSphreak/readme-jokes](https://github.com/ABSphreak/readme-jokes)
- [DenverCoder1/github-readme-streak-stats](https://github.com/DenverCoder1/github-readme-streak-stats)
- [Minecraft API by Jacob Gunther](https://mcstatus.io/)
## Contributing
Contributions are always welcome!
See [Contributing](https://github.com/jayantur13/serverstate-minecraft/blob/master/CONTRIBUTING.md) for ways to get started.
Please adhere to this project's [Code Of Conduct](https://github.com/jayantur13/serverstate-minecraft/blob/master/CODE_OF_CONDUCT.md).
## Support
Support the developers for this project to live long.For issues, open a new issue or use discussion.
## License
This project is licensed under the [MIT License](https://github.com/jayantur13/serverstate-minecraft/blob/master/LICENSE)