From 0c2d6c7c9c0378b8eb122029ad84cadac14351bb Mon Sep 17 00:00:00 2001 From: server Date: Tue, 14 Apr 2026 09:08:35 +0200 Subject: [PATCH] docs: add repo instructions --- AGENTS.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ CLAUDE.md | 10 ++++++++++ 2 files changed, 59 insertions(+) create mode 100644 AGENTS.md create mode 100644 CLAUDE.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..a582456 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,49 @@ +# AGENTS.md + +## Repository Role + +This repository contains the Windows client source code and build system. + +It owns: + +- client executable source +- protocol/client networking code +- UI/client runtime C++ modules +- build-time tools such as client-side pack/proto helpers + +## Working Rules + +- Treat this repository as Windows-first. +- Prefer protocol-safe, targeted changes over broad refactors. +- Keep packet and login-flow changes aligned with `m2dev-server-src`. +- Do not mix packed asset/data changes into this repository unless they are source-side build assets. + +## Build Notes + +Typical build entrypoint: + +```bash +cmake -S . -B build +cmake --build build +``` + +In practice, most real builds happen on Windows with Visual Studio toolchains. + +## High-Risk Areas + +- `src/UserInterface/Packet.h` +- `AccountConnector` +- `PythonNetworkStream*` +- `NetStream` + +When changing login/auth/protocol behavior: + +- mirror the server-side packet expectations in `m2dev-server-src` +- verify the live asset-side flow in `m2dev-client` +- avoid silent header drift between client and server + +## Cross-Repo Boundaries + +- client executable and protocol code belong here +- packed/unpacked client data under `assets/` belong in `m2dev-client` +- server packet/auth implementation belongs in `m2dev-server-src` diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..9c7ce05 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,10 @@ +# CLAUDE.md + +Follow [AGENTS.md](AGENTS.md) as the canonical repo guide. + +Short version: + +- this is the Windows client source repo +- protocol/login changes must stay aligned with `m2dev-server-src` +- asset-side login/serverlist behavior lives in `m2dev-client` +- avoid broad refactors unless the task is explicitly architectural