{"id":19952698,"url":"https://github.com/tob1as/mcstatus-httpd","last_synced_at":"2025-03-01T15:16:52.500Z","repository":{"id":82691485,"uuid":"456633886","full_name":"Tob1as/mcstatus-httpd","owner":"Tob1as","description":"Minecraft Server Status (python3 httpd with json output)","archived":false,"fork":false,"pushed_at":"2025-01-21T19:52:43.000Z","size":40,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-21T20:32:59.046Z","etag":null,"topics":["mcstatus","minecraft"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Tob1as.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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}},"created_at":"2022-02-07T18:47:12.000Z","updated_at":"2025-01-21T19:52:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"24edf869-b135-4f66-9d7c-279731e898ee","html_url":"https://github.com/Tob1as/mcstatus-httpd","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/Tob1as%2Fmcstatus-httpd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tob1as%2Fmcstatus-httpd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tob1as%2Fmcstatus-httpd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tob1as%2Fmcstatus-httpd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Tob1as","download_url":"https://codeload.github.com/Tob1as/mcstatus-httpd/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241381646,"owners_count":19953751,"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":["mcstatus","minecraft"],"created_at":"2024-11-13T01:14:06.750Z","updated_at":"2025-03-01T15:16:52.478Z","avatar_url":"https://github.com/Tob1as.png","language":"Python","readme":"# mcstatus-httpd\n\nmcstatus-httpd shows any information of a Minecraft Server via HTTP-Server as JSON. \nIt used [mcstatus](https://github.com/py-mine/mcstatus).\n\n## INFO\n\nThis is (currently) written for my benefit only.  \nYou can use it, but I won't give support if it doesn't work for you. (I'm also not a Python expert!).  \nBut you are welcome to work on it. ;-)\n\n## Minecraft Server\n\nI use Minecraft Server with Docker:\n* [Minecraft Java Edition](https://github.com/itzg/docker-minecraft-server)\n* [Minecraft Bedrock Edition](https://github.com/itzg/docker-minecraft-bedrock-server)\n\nExamples for docker-compose (minecraft.yml, minecraft-bedrock.yml) you can find here: [click](https://github.com/Tob1as/docker-kubernetes-collection/tree/master/examples_docker-compose)\n\n### Requirements\n\nMinecraft (Java) must enable [Query](https://wiki.vg/Query)!\n\n## Use\n\nwith docker-compose:  \n```yml\nversion: '2.4'\nservices:\n\n  mcstatus-httpd:\n    image: ghcr.io/tob1as/mcstatus-httpd:latest\n    container_name: mcstatus-httpd\n    restart: unless-stopped\n    ports:\n      - 8080:8080/tcp\n    environment:\n      #TZ: Europe/Berlin\n      MINECRAFT_JAVA_SERVER: minecraft.example.com\n      MINECRAFT_JAVA_SERVER_PORT: 25565\n      #MINECRAFT_JAVA_SERVER_PORT_QUERY: 25565  # set, if UDP is not equal to TCP port\n      MINECRAFT_BEDROCK_SERVER: minecraft-bedrock.example.com\n      MINECRAFT_BEDROCK_SERVER_PORT: 19132\n    healthcheck:\n      test:  wget --quiet --tries=1 --spider http://localhost:8080/healthcheck || exit 1\n      interval: 120s\n      timeout: 3s\n      retries: 3\n```\n\nlocal:\n* install: `pip3 install mcstatus`\n* set variable/env\n* start: `python3 -u ./minecraft-status.py`\n\n## Example Output\n\nURL: `http://localhost:8080`\n\n```json\n{\n\t\"date\": \"2022-08-20 00:00:00\",\n\t\"java\": {\n\t\t\"hostname\": \"minecraft.example.com\",\n\t\t\"port\": 25565,\n\t\t\"software\": {\n\t\t\t\"version\": \"1.19.2\",\n\t\t\t\"brand\": \"vanilla\",\n\t\t\t\"plugins\": \"\"\n\t\t},\n\t\t\"players\": {\n\t\t\t\"online\": 3,\n\t\t\t\"max\": 20,\n\t\t\t\"list\": \"Player1, Player2, Player3\"\n\t\t},\n\t\t\"map\": \"world\",\n\t\t\"motd\": \"A \\u00a7l\\u00a7cMinecraft\\u00a7r \\u00a7nserver\"\n\t},\n\t\"bedrock\": {\n\t\t\"hostname\": \"minecraft-bedrock.example.com\",\n\t\t\"port\": 19132,\n\t\t\"software\": {\n\t\t\t\"version\": \"1.19.20\",\n\t\t\t\"brand\": \"MCPE\",\n\t\t\t\"protocol\": \"544\"\n\t\t},\n\t\t\"players\": {\n\t\t\t\"online\": 0,\n\t\t\t\"max\": 20\n\t\t},\n\t\t\"map\": \"Bedrock level\",\n\t\t\"motd\": \"Minecraft Bedrock Server\",\n\t\t\"gamemode\": \"Survival\"\n\t}\n}\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftob1as%2Fmcstatus-httpd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftob1as%2Fmcstatus-httpd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftob1as%2Fmcstatus-httpd/lists"}