Add AGPL-3.0-or-later license and Chinese README#1
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 50276d62a2
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| @@ -0,0 +1,62 @@ | |||
| # ModAPI | |||
|
|
|||
| ModAPI 是 GroupMountain 维护的 Minecraft Bedrock Dedicated Server 模组开发接口库，面向基于 LeviLamina 与 GMLIB 的服务器扩展开发。项目提供一组 C++20 API，用于注册和管理自定义物品、方块、配方、游戏规则、世界生成、战利品表、效果、实体等内容。 | |||
There was a problem hiding this comment.
This overview tells users the library provides registration/management APIs for blocks, loot tables, effects, and entities, but the corresponding public surface is not implemented: the block/entity/loot base headers only contain #pragma once plus includes, and include/modapi/effect/CustomEffectRegistry.h is empty. Users following the README will try to build against APIs that do not exist, so please limit the feature list to implemented modules or add the missing APIs.
Useful? React with 👍 / 👎.
| - Windows / Visual Studio C++ 工具链 | ||
| - [xmake](https://xmake.io/) | ||
| - C++20 编译环境 |
There was a problem hiding this comment.
In a fresh Windows/Visual Studio environment that follows this list, the documented build can fail before compilation because xmake.lua runs python ./scripts/header_file_patch.py in after_load and python ./scripts/include_correction.py / format_all.py in before_build. Add Python to the required tools, including any version constraint if needed, so users know the executable must be on PATH.
Useful? React with 👍 / 👎.
| @@ -0,0 +1,11 @@ | |||
| GNU Affero General Public License v3.0 or later | |||
There was a problem hiding this comment.
This file is only a short license notice, not the complete AGPL text that the README directs users to as the full license. For source archives or offline distributions, recipients still do not receive the license terms referenced by the notice itself, so replace this with the full GNU AGPL v3 text or add a separate COPYING file and point the README there.
Useful? React with 👍 / 👎.
1 participant
Motivation
README.md来说明项目用途、功能和构建说明。Description
LICENSE文件，包含 GNU Affero General Public License v3.0 或更高版本的声明并包含SPDX-License-Identifier: AGPL-3.0-or-later，同时新增中文README.md，涵盖项目概览、功能概览、环境与依赖、构建步骤、产物布局、项目结构、开发说明和许可证引用。Testing
git diff --check以检测不一致问题，检查通过。Codex Task