{"id":19595493,"url":"https://github.com/jayantur13/serverstate-minecraft","last_synced_at":"2025-04-27T15:34:35.293Z","repository":{"id":41174445,"uuid":"504091899","full_name":"jayantur13/serverstate-minecraft","owner":"jayantur13","description":"Minecraft server state in your Github readme or as signature in forums/boards","archived":false,"fork":false,"pushed_at":"2025-01-24T07:18:33.000Z","size":1198,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-05T01:11:12.716Z","etag":null,"topics":["minecraft","minecraft-banner","minecraft-data","minecraft-tools","monitoring-tool","readme"],"latest_commit_sha":null,"homepage":"https://serverstate-minecraft.vercel.app","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jayantur13.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["jayantur13"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://www.buymeacoffee.com/jayantur13v"]}},"created_at":"2022-06-16T09:24:48.000Z","updated_at":"2025-01-24T07:18:37.000Z","dependencies_parsed_at":"2024-05-10T09:43:10.886Z","dependency_job_id":"d21c1924-6168-4c6f-ae41-a6def95c3385","html_url":"https://github.com/jayantur13/serverstate-minecraft","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jayantur13%2Fserverstate-minecraft","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jayantur13%2Fserverstate-minecraft/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jayantur13%2Fserverstate-minecraft/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jayantur13%2Fserverstate-minecraft/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jayantur13","download_url":"https://codeload.github.com/jayantur13/serverstate-minecraft/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251162989,"owners_count":21545858,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["minecraft","minecraft-banner","minecraft-data","minecraft-tools","monitoring-tool","readme"],"created_at":"2024-11-11T08:47:11.957Z","updated_at":"2025-04-27T15:34:30.277Z","avatar_url":"https://github.com/jayantur13.png","language":"JavaScript","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Logo\" src=\"https://i.postimg.cc/mDjCTfyJ/minecraft.png\"\u003e\n  \u003cp align=\"center\"\u003e\n    \u003cimg alt=\"Codecov\" src=\"https://img.shields.io/codecov/c/github/jayantur13/serverstate-minecraft?label=codecov\u0026logo=codecov\u0026style=flat-square\"\u003e\n    \u003cimg alt=\"GitHub Workflow Status\" src=\"https://img.shields.io/github/actions/workflow/status/jayantur13/serverstate-minecraft/test.yml?branch=master\"\u003e\n    \u003ch3 align=\"center\"\u003e\u003cb\u003eMinecraft server state in your readme/signature.\u003c/b\u003e\u003c/h3\u003e\n  \u003c/p\u003e\n  \u003cp align=\"center\"\u003e\u003ca href=\"#setup-guide\"\u003eSetup Guide\u003c/a\u003e • \u003ca href=\"#examples\"\u003eExamples\u003c/a\u003e • \u003ca href=\"#valid-format\"\u003eValid format\u003c/a\u003e • \u003ca href=\"#themes-demo\"\u003eTheme demo\u003c/a\u003e • \u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/p\u003e\n\u003c/p\u003e\n\n## Features\n\n- Easy to setup and use\n- Full customistaion\n- Variety of themes\n- Supports java and bedrock edition\n\n## Setup Guide\n\nPlease read the following for an easy setup -\n\n**Mandatory parameters for banner:**\n\nThese below,two parameters are must -\n\n- srvAddress - Pass server address i.e _hostname_,_ip_,_ip:port_ or _name with domain_\n- srvType - Pass server type _java_ for Java Edition and _bedrock_ for Bedrock edition.\n\n**Optional parameters for banner:**\n\nFollowing parameters can be used for customisation -\n\n- borderColor - pass a border color (or transparent)\n- fontWeight - pass normal/bold/bolder/lighter or 100-900\n- bgColor - pass background color\n- txtColor - pass text color\n- headingColor - pass heading color\n- iconColor - pass an icon color (or transparent)\n- themeval - pass an available theme name\n\n\u003e Note1: Color must be passed starting with %23 (encoded value for #)\n\u003e\n\u003e \u003e Note2: Customise all parameters or use theme instead (i.e themeval)\n\u003e\n\u003e \u003e Note3: There is **1 min. cache time** for now,set by default\n\u003e\n\u003e \u003e Note4: Possible to skip some optional parameters\n\u003e\n\u003e \u003e Note5: API data maybe inaccurate sometimes\n\u003e\n\u003e \u003e Note6: You can view full info. of a server,example at end\n\n## Examples\n\nYou can use **markdown** or **img** to render minecraft server state\n\n```\n\u003c!-- Markdown --\u003e\n\n![ServerState Minecraft](https://serverstate-minecraft.vercel.app/api?srvAddress=play.craftersmc.net\u0026srvType=bedrock)\n\n```\n\nor\n\n```\n\u003c!-- HTML --\u003e\n\n\u003cimg src=\"https://serverstate-minecraft.vercel.app/api?srvAddress=play.craftersmc.net\u0026srvType=bedrock alt=\"ServerState Minecraft\"/\u003e\n\n```\n\n\u003ch4\u003eValid Format\u003c/h4\u003e\n\n\u003e If you don't want icon (iconColor),border (borderColor) and fontWeight just don't pass them in query\n\nDefault usage (i.e with _random themes_)\n\n```\nhttps://serverstate-minecraft.vercel.app/api?srvAddress=play.craftersmc.net\u0026srvType=bedrock\n```\n\nWith a theme\n\n```\nhttps://serverstate-minecraft.vercel.app/api?srvAddress=play.craftersmc.net\u0026srvType=bedrock\u0026themeval=omni\n```\n\nFull customisation\n\n```\nhttps://serverstate-minecraft.vercel.app/api?srvAddress=play.craftersmc.net\u0026srvType=bedrock\u0026borderColor=%23000000\u0026fontWeight=bold\u0026bgColor=%23ffffff\u0026txtColor=%23000000\u0026headingColor=%23000000\u0026iconColor=%23000000\n```\n\nCustomise theme with borderColor and fontWeight\n\n```\nhttps://serverstate-minecraft.vercel.app/api?srvAddress=pokecentral.org\u0026srvType=java\u0026themeval=cobalt\u0026borderColor=%23ffffff\u0026fontWeight=bold\n```\n\n\u003ch4\u003eThemes Demo\u003c/h4\u003e\n\n[![ServerState Minecraft](https://serverstate-minecraft.vercel.app/api?srvAddress=play.craftersmc.net\u0026srvType=bedrock\u0026themeval=yeblu)](https://ismcserver.online/bedrock/play.craftersmc.net)\n\n[![ServerState Minecraft](https://serverstate-minecraft.vercel.app/api?srvAddress=ms.pixelmonrealms.com\u0026srvType=java\u0026themeval=panda)](https://ismcserver.online/ms.pixelmonrealms.com)\n\nCheckout 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\")\n\n## Changelog\n\nFor all the important changelog vist [Changelog](https://github.com/jayantur13/serverstate-minecraft/blob/master/CHANGELOG.md)\n\n## References\n\n- [anuraghazra/github-readme-stats](https://github.com/anuraghazra/github-readme-stats)\n- [ABSphreak/readme-jokes](https://github.com/ABSphreak/readme-jokes)\n- [DenverCoder1/github-readme-streak-stats](https://github.com/DenverCoder1/github-readme-streak-stats)\n- [Minecraft API by Jacob Gunther](https://mcstatus.io/)\n\n## Contributing\n\nContributions are always welcome!\n\nSee [Contributing](https://github.com/jayantur13/serverstate-minecraft/blob/master/CONTRIBUTING.md) for ways to get started.\n\nPlease adhere to this project's [Code Of Conduct](https://github.com/jayantur13/serverstate-minecraft/blob/master/CODE_OF_CONDUCT.md).\n\n## Support\n\nSupport the developers for this project to live long.For issues, open a new issue or use discussion.\n\n## License\n\nThis project is licensed under the [MIT License](https://github.com/jayantur13/serverstate-minecraft/blob/master/LICENSE)\n","funding_links":["https://github.com/sponsors/jayantur13","https://www.buymeacoffee.com/jayantur13v"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjayantur13%2Fserverstate-minecraft","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjayantur13%2Fserverstate-minecraft","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjayantur13%2Fserverstate-minecraft/lists"}