Skip to content

Add AGPLv3 LICENSE and initial README for ModAPI#2

Merged
Milvona merged 2 commits into
mainfrom
codex/agpl3readme.md-3bgvzz
Jun 19, 2026
Merged

Add AGPLv3 LICENSE and initial README for ModAPI#2
Milvona merged 2 commits into
mainfrom
codex/agpl3readme.md-3bgvzz

Conversation

@Milvona

@Milvona Milvona commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Motivation

  • Add an explicit open-source license to the repository to clarify terms of use and distribution for the project.
  • Provide an initial README.md describing the ModAPI project, its features and build instructions to help developers get started quickly.

Description

  • Add a LICENSE file containing the full text of the GNU Affero General Public License v3.0 to license the project under AGPL-3.0-or-later.
  • Add README.md with an overview of ModAPI, supported features, environment requirements, project structure, and build instructions including xmake f -m release and xmake.
  • Document output artifacts and where build products are copied (bin/), and point to the LICENSE from the README.

Testing

  • No automated tests were run for this change since it only adds licensing and documentation files.

Codex Task

@Milvona Milvona merged commit 422b922 into main Jun 19, 2026
1 check failed
@chatgpt-codex-connector

Copy link
Copy Markdown

💡 Codex Review

- 自定义游戏规则、世界生成特征、战利品表、状态效果和实体接口

P2 Badge Remove claims for missing registry APIs

This feature list advertises custom loot-table, status-effect, and entity APIs as available, but I checked include/ and src/ with rg and the matching files are only empty/stub headers: include/modapi/effect/CustomEffectRegistry.h is empty, while the block/entity/loot-table registry headers only include stub base headers and have no declarations or implementations. Users following the new README will look for APIs that are not present in this release, so these items should be marked as planned or removed until implemented.

ℹ️ 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".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant