{"id":19510992,"url":"https://github.com/shotakitazawa/minecraft-bot","last_synced_at":"2025-04-26T03:32:30.908Z","repository":{"id":37978967,"uuid":"259847732","full_name":"ShotaKitazawa/minecraft-bot","owner":"ShotaKitazawa","description":"Minecraft Notification Bot \u0026 Prometheus exporter","archived":false,"fork":false,"pushed_at":"2023-11-06T08:57:11.000Z","size":83581,"stargazers_count":9,"open_issues_count":7,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-04T07:36:06.596Z","etag":null,"topics":["minecraft","minecraft-bot","prometheus-exporter"],"latest_commit_sha":null,"homepage":"","language":"Go","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/ShotaKitazawa.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":"2020-04-29T06:50:45.000Z","updated_at":"2024-04-07T03:50:00.000Z","dependencies_parsed_at":"2024-06-20T14:00:20.421Z","dependency_job_id":"7290d0e9-9999-4f45-b217-ef5286fb09b4","html_url":"https://github.com/ShotaKitazawa/minecraft-bot","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShotaKitazawa%2Fminecraft-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShotaKitazawa%2Fminecraft-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShotaKitazawa%2Fminecraft-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShotaKitazawa%2Fminecraft-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ShotaKitazawa","download_url":"https://codeload.github.com/ShotaKitazawa/minecraft-bot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250926923,"owners_count":21509057,"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-bot","prometheus-exporter"],"created_at":"2024-11-10T23:18:48.993Z","updated_at":"2025-04-26T03:32:25.900Z","avatar_url":"https://github.com/ShotaKitazawa.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"minecraft-bot\n===\n\n![License](https://img.shields.io/github/license/ShotaKitazawa/minecraft-bot)\n![test](https://github.com/ShotaKitazawa/minecraft-bot/workflows/test/badge.svg)\n![Go Report Card](https://goreportcard.com/badge/github.com/ShotaKitazawa/minecraft-bot)\n\nminecraft-bot has the following features.\n\n* **notification Bot** : notify Minecraft login/logout events to some chat-tool (LINE/Slack/Discord)\n* **operation of Minecraft whitelist** : operate to whitelist of Minecraft Server through ChatBot\n* **Prometheus exporter** : support some Minecraft metrics in Prometheus exporter format\n* **source is only RCON** : minecraft-bot is not required any Mod, not required reading Minecraft world data, only using RCON\n\n## Demo\n\n### operation by chat \u0026 Login/Logout notification to chat\n\n![demo.gif](./images/demo_1.gif)\n\n### using multi chat platform\n\n![demo.gif](./images/demo_2.gif)\n\n### Dashboard\n\n* using `./dashboard/minecraft_users.json`\n    * pre-install `vonage-status-panel` Panel Plugin\n\n![minecraft_users](./images/minecraft_users.png)\n\n## Installation\n\n* only download binary from [release](https://github.com/ShotaKitazawa/minecraft-bot/releases)\n\n* or execute bellow command\n\n```\ngo get -u github.com/ShotaKitazawa/minecraft-bot/cmd/minecraft-bot\n```\n\n## Usage\n\n```\n$ minecraft-bot -h\nUsage of minecraft-bot:\n  -f string\n        TOML configuration filepath\n  -v    show application version\n```\n\n* TOML Configuration File\n\n```\n# Minecraft Server Hostname (requirement)\nminecraft-hostname = \"your_domain\"\n\n# basic setting (option)\nbind-addr = \"0.0.0.0\"  # default: \"0.0.0.0\"\nbind-port = 8080       # default: 8080\nlog-level = \"info\"     # default: \"info\",  support \"debug\", \"info\", \"warn\", or \"error\"\n\n\n[bot]\n# bot basic Configuration (option)\nnotification-mode = \"XXX\"  # default: \"all\", support \"none\", or \"all\"\n\n[[bot.line]]\n# LINE Bot Configuration (requirement)\nendpoint = \"/linebot\"\nchannel-secret = \"XXX\"\nchannel-token = \"XXX\"\n\n# LINE Bot Configuration (option)\ngroup-ids = \"XXX\"  # default: none, cannot push notification without this\n\n\n[[bot.slack]]\n# Slack Bot Configuration (requirement)\ntoken = \"XXX\"\n\n# Slack Bot Configuration (option)\nchannel-ids = \"XXX\"  # default: none, cannot push notification without this\n\n\n[[bot.discord]]\n# Discord Bot Configuration (requirement)\ntoken = \"XXX\"\n\n# Discord Bot Configuration (option)\nchannel-ids = \"XXX\"  # default: none, cannot push notification without this\n\n\n[rcon]\n# connect in RCON to Minecraft (option)\nhost = \"127.0.0.1\"    # default: \"127.0.0.1\"\nport = 25575          # default: 25575\n\n# RCON password (requirement)\npassword = \"XXX\"\n\n\n[sharedmem]\n# place to store state (support \"redis\" (recommended), or \"local\")\nmode = \"redis\"        # default: \"local\"\n\n\n[sharedmem.redis]\n# Redis info (option if sharedmem.mode == \"redis\")\nhost = \"127.0.0.1\"    # default: \"127.0.0.1\"\nport = 6379           # default: 6379\n```\n\n## For more informations\n\nhttps://github.com/ShotaKitazawa/minecraft-bot/blob/master/docs\n\n## Reference\n\n* [Mod 無し Minecraft で動く Chat Bot + α](https://zenn.dev/kanatakita/articles/5883c5de1b40e17febad)\n\n## Author\n\n[twitter](https://twitter.com/kanatakita)\n\n## Licence\n\n[MIT](https://github.com/ShotaKitazawa/minecraft-bot/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshotakitazawa%2Fminecraft-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshotakitazawa%2Fminecraft-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshotakitazawa%2Fminecraft-bot/lists"}