QAPI3

Fast, SQL-safe Api.

This program contains these features:

Minecraft Server validation: User can easily bind their account to api,
Chat Sync between several Minecraft Servers(WIP): This feature allows users to chat across servers.
Minecraft Server Status Query: This api will automatically show latest server status.(Need Plugin-side support)

Future RoadMaps

More codes in Kotlin

DIY player card with QCommunity WEB

Add Discord support

Guides

To install:

simply just run gradle build and that's all. Don't forget to add configurations like MySQL server and Redis!

I recommend you to just run program in docker and redirect port to nginx, etc.

To add components, sub servers, please add node object in nodes.json

[
  {
    "name": "QQ",
    "id": 0,
    "role": "SERVER",
    "token": "123456"
  },
  {
    "name": "QO",
    "id": 1,
    "role": "SERVER",
    "token": "123456"
  }
]

and then they can post messages, add new features, etc...

Database configuration

Database access is managed by Spring Data R2DBC. Connection settings continue to come from data/sql/info.json:

{
  "url": "jdbc:mysql://db.example:3306/qapi",
  "username": "qapi",
  "password": "change-me"
}

The existing jdbc:mysql: URL is converted to r2dbc:mysql: when the pool is created. The original pool defaults (initial/minimum idle 5, maximum 100, 3-second acquisition timeout, and 60-second eviction interval) are retained; do not configure a JDBC DataSource for request handling.

API Endpoint

GET /qo/download/status ->

{
    "totalcount": 0,
    "mspt_3s": 2,
    "code": 0,
    "players": [],
    "game_time": 0,
    "mspt": 2.562659,
    "recent60": [],
    "onlinecount": 0,
    "timestamp": 1727272149198
}

GET /qo/msglist/download ->

{
    "messages": [
        "服务状态更新：\nService SortMC 的状态为 null\n最新的heartbeat状态为： 1 延迟 77ms",
        "[QO] 玩家Lplayer加入了服务器。",
        "[QO] 玩家Lplayer退出了服务器，本次游玩时间 4分钟",
        "[QO] 玩家Lplayer加入了服务器。",
        "服务状态更新：\nService QAPI origin 的状态为 null\n最新的heartbeat状态为： 0 延迟 0ms",
        "[QQ] <CHJWOS_|2859972822>:wow",
        "[QQ] <CHJWOS_|2859972822>:https://www.mcmod.cn/class/14114.html",
        "[QQ] <glowingstone124|1294915648>:[CQ:reply,id=986310598][CQ:at,qq=2859972822,name=CHJWOS_] fabric mod自定义gui的话",
        "[QQ] <glowingstone124|1294915648>:是不是要拿opengl嗯写",
        "[QQ] <CHJWOS_|2859972822>:高版本可能是有原版帮你写好了的",
        "[QQ] <CHJWOS_|2859972822>:不是原版风格的就自己写",
        "[QQ] <glowingstone124|1294915648>:我不想要原版",
        "[QQ] <glowingstone124|1294915648>:我想写个现代化ui",
        "[QQ] <CHJWOS_|2859972822>:矩形啥的应该是已经内置了",
        "[QQ] <CHJWOS_|2859972822>:如果有模糊啥的",
        "[QQ] <CHJWOS_|2859972822>:可能1.20.5往上也有",
        "[QQ] <glowingstone124|1294915648>:行",
        "[QQ] <glowingstone124|1294915648>:动画呢",
        "[QQ] <glowingstone124|1294915648>:是不是要自己搓",
        "[QQ] <CHJWOS_|2859972822>:是了",
        "[QQ] <東雪蓮Official|3125265713>:累了",
        "[QQ] <東雪蓮Official|3125265713>:今天操场上测了下速",
        "[QQ] <東雪蓮Official|3125265713>:23圈",
        "[QQ] <東雪蓮Official|3125265713>:一圈400",
        "[QQ] <東雪蓮Official|3125265713>:15分钟",
        "[QQ] <東雪蓮Official|3125265713>:每小时大约36km",
        "[QQ] <東雪蓮Official|3125265713>:[CQ:image,file=6EF6BBF5A4EC9B58B3754A1E7836C689.jpg,subType=1,url=https://multimedia.nt.qq.com.cn/download?appid=1407&amp;fileid=CgozMTI1MjY1NzEzEhT-HH8woFCrx7llrTrMAfDy9YbiQBiutiMg_woo9s29x5beiAMyBHByb2RQgL2jAQ&amp;spec=0&amp;rkey=CAMSKMa3OFokB_TlE5oz_MZGn_1PxOOLL_sQeAG7OFPt_2onFxvUsjDhYv0,file_size=580398]",
        "[QQ] <CHJWOS_|2859972822>:哇啊",
        "[QQ] <CHJWOS_|2859972822>:全世界的人都在教我怎么sampler2D传入图片",
        "[QQ] <CHJWOS_|2859972822>:我想要传入当前帧画面的教程啊",
        "[QQ] <glowingstone124|1294915648>:那你把这一帧变成bytemap"
    ],
    "empty": false
}

GET /qo/download/registry?name=glowingstone124 ->

{
    "qq": 1294915648,
    "code": 0,
    "frozen": false,
    "online": false,
    "economy": 0,
    "playtime": 1712
}

LLM Tool Calling

The OpenAI-compatible non-stream chat endpoint can execute built-in tools before returning the final assistant message.

get_server_status: query Minecraft server status and player counts.
get_player_rankings: query mining, placement, and cumulative playtime leaderboards.
query_metro_lines: search metro lines, stations, sections, and signal coordinates.
search_minecraft_knowledge: search the configured RAG knowledge base for Minecraft/QO information.
add_memory: create or update a structured per-group long-term memory.
search_memory: query structured memories for the current group.
forget_memory: delete structured memories only when explicitly requested.

Structured memories are stored in the automatically created MySQL llm_memories table. A memory is uniquely identified by group_id + subject + memory_key, so multiple facts about the same subject can coexist. On the first startup after upgrading, legacy data/llm/rag/<groupId>/memory.txt and data/llm/rag/groups/<groupId>/memory.txt files are imported once; completion is recorded in llm_memory_migrations. Legacy files are retained for rollback but are excluded from RAG after migration.

Group context always retains the newest raw messages. Older messages are incrementally summarized with deepseek-v4-flash; summaries are persisted per group and refreshed only after enough messages age out of the recent window. Boolean environment variables accept only true and false.

Related environment variables:

LLM_SYSTEM_PROMPT: fixed system prompt text. When set, it takes precedence over the prompt file.
LLM_SYSTEM_PROMPT_FILE: system prompt file. Linux inotify events, atomic replacements, Docker bind mounts, and Kubernetes ConfigMap/Secret-style replacements are reloaded without restarting the API; invalid or blank updates keep the previous valid prompt.
LLM_GROUP_SUMMARY_ENABLED: enable per-group rolling summaries for messages older than the recent window, default true.
LLM_GROUP_SUMMARY_DIR: persistent rolling-summary directory, default data/llm/summaries.
LLM_GROUP_CONTEXT_RECENT_MESSAGES: number of newest raw group messages retained, default 160.
LLM_GROUP_CONTEXT_RECENT_CHARS: maximum characters for newest raw group messages, default 60000.
LLM_GROUP_CONTEXT_PENDING_CHARS: maximum unsummarized older-message characters retained while waiting for the next summary update, default 8000.
LLM_GROUP_SUMMARY_MIN_NEW_MESSAGES: newly aged messages required before updating an existing summary, default 6.
LLM_GROUP_SUMMARY_MIN_NEW_CHARS: newly aged characters required before updating an existing summary, default 1500.
LLM_GROUP_SUMMARY_MAX_CHARS: maximum persisted summary characters per group, default 5000.
LLM_GROUP_SUMMARY_TIMEOUT_MS: maximum time spent updating a summary before falling back to raw pending history, default 15000.
LLM_MEMORY_CONTEXT_MAX_ITEMS: maximum relevant memories injected into a request, default 10.
LLM_MEMORY_CONTEXT_MAX_CHARS: maximum memory context characters, default 6000.
LLM_MEMBER_PROFILE_CONTEXT_MAX_ITEMS: maximum qbot high-activity member profiles injected into one request, default 50.
LLM_MEMBER_PROFILE_CONTEXT_MAX_FACTS: maximum self-declared facts accepted from each member profile, default 16.
LLM_MEMBER_PROFILE_CONTEXT_MAX_CHARS: maximum total qbot member-profile context characters, default 20000.

QQ group messages are archived in the llm_chat_history table through POST /qo/asking/v1/chat/history. The bot endpoint also backfills its sliding group_context, using stable source IDs and INSERT IGNORE for idempotency. The LLM can retrieve older, group-scoped records with the search_chat_history tool; results never cross group boundaries.

LLM_TOOLS_ENABLED: enable built-in tools, default true.
LLM_WEB_SEARCH_ENABLED: enable DeepSeek server-side web search for non-stream deepseek-v4-flash requests, default true.
LLM_PROVIDERS_FILE: provider configuration JSON path, default data/llm/providers.json.
LLM_PROVIDER: selected provider name. If omitted, the JSON defaultProvider is used.
LLM_RESPONSES_API_URL: legacy fallback Responses API endpoint. Provider JSON should use an explicit responsesUrl.
LLM_RESPONSES_MODELS: legacy comma-separated Responses model aliases. Provider JSON should use responsesModels.
LLM_TOOL_MAX_ROUNDS: maximum tool-call loops per request, default 3.
LLM_TOOL_METRO_MAX_RESULTS: maximum metro search results returned to the model, default 12.

Provider configuration example (data/llm/providers.json):

{
  "defaultProvider": "deepseek",
  "providers": {
    "deepseek": {
      "chatCompletionsUrl": "https://api.deepseek.com/v1/chat/completions",
      "responsesUrl": "https://api.deepseek.com/v1/responses",
      "tokenFile": "LLMAPITOKEN",
      "models": {
        "fast": "deepseek-v4-flash",
        "thinking": "deepseek-v4-pro"
      },
      "responsesModels": ["fast"]
    },
    "another-provider": {
      "chatCompletionsUrl": "https://example.com/v1/chat/completions",
      "responsesUrl": "https://example.com/v1/responses",
      "tokenFile": "data/llm/another-provider.token",
      "models": {
        "fast": "provider-fast-model",
        "thinking": "provider-thinking-model"
      },
      "responsesModels": ["fast", "thinking"]
    }
  }
}

responsesUrl is always used as written and is never derived from or truncated from chatCompletionsUrl. Set LLM_PROVIDER=another-provider to switch providers. responsesModels controls which model aliases use the Responses API; LLM_WEB_SEARCH_ENABLED only controls whether the Responses request includes web search.

For Contributors

When integrating this project with GoCi, please notice there are some flags can be use.

[SKIP CI]: when pushing a commit which description contains this, GoCi will automatically skip build this commit.

Name		Name	Last commit message	Last commit date
Latest commit History 522 Commits
.github/workflows		.github/workflows
docs		docs
src		src
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
build.gradle.kts		build.gradle.kts
gradle.properties		gradle.properties
gradlew		gradlew
gradlew.bat		gradlew.bat
settings.gradle.kts		settings.gradle.kts
test.sql		test.sql

Navigation Menu

Repository files navigation

QAPI3

Fast, SQL-safe Api.

Future RoadMaps

Guides

To install:

Database configuration

API Endpoint

LLM Tool Calling

For Contributors

About

Releases

Packages

Used by

Contributors

Languages

Folders and files

Latest commit

History

Repository files navigation

QAPI3

Fast, SQL-safe Api.

Future RoadMaps

Guides

To install:

Database configuration

API Endpoint

LLM Tool Calling

For Contributors

About

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages