aoirint_mcping_server

aoirint_mcping_server

site icon
2025.01.09 0
PythonMinecraft 服务器监控游戏服务器管理其它
aoirint_mcping_server 是一个用于监控多个 Minecraft Bedrock/Java 服务器状态的服务。它通过 PostgreSQL 数据库进行持久化存储,并提供带有读写 API 密钥认证的 Web API。该服务支持 Minecraft Bedrock 1.20.x 和 Java 1.20.x 版本的服务器。
View on GitHub

Overview

基本能力

产品定位

aoirint_mcping_server 是一个专门用于监控 Minecraft 服务器状态的服务,适用于需要集中管理多个 Minecraft 服务器的场景。

核心功能

  • 监控多个 Minecraft Bedrock/Java 服务器的状态
  • 使用 PostgreSQL 数据库进行数据持久化
  • 提供带有读写 API 密钥认证的 Web API

适用场景

  • 游戏服务器管理员需要集中监控多个 Minecraft 服务器的状态
  • 开发人员需要集成 Minecraft 服务器状态监控功能到自己的应用中

工具列表

  • aoirint_mcping_server_web_api: 提供 Web API 功能
  • aoirint_mcping_server_java_updater: 用于更新 Java 服务器状态
  • aoirint_mcping_server_bedrock_updater: 用于更新 Bedrock 服务器状态

常见问题解答

  • 数据库迁移使用 golang-migrate 工具
  • 代码格式化使用 Ruff 和 Mypy

使用教程

使用依赖

  • Docker Compose
  • PostgreSQL 数据库

安装教程

  1. 将以下文件复制到新目录并配置:
  2. docker-compose.yml
  3. template.env -> .env
  4. 启动 Docker Compose 服务: shell docker compose up -d
  5. 应用数据库迁移: shell docker compose run --rm migrate -path=/migrations -database="postgres://postgres:postgres_password@postgres:5432/postgres?sslmode=disable" up

调试方式

  • 使用 Poetry 运行代码格式化和类型检查: shell poetry run ruff check --fix poetry run ruff format poetry run mypy .

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。