forked from metin-server/m2dev-client
docs: add repo instructions
This commit is contained in:
46
AGENTS.md
Normal file
46
AGENTS.md
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
# AGENTS.md
|
||||||
|
|
||||||
|
## Repository Role
|
||||||
|
|
||||||
|
This repository contains client-side data and runtime assets.
|
||||||
|
|
||||||
|
Important contents:
|
||||||
|
|
||||||
|
- `assets/root/`: Python-side client logic and UI scripts
|
||||||
|
- `assets/pack.py`: packing workflow entrypoint
|
||||||
|
- `assets/PackMaker.exe`: packing tool
|
||||||
|
- `config/`: client config defaults
|
||||||
|
|
||||||
|
## Working Rules
|
||||||
|
|
||||||
|
- Keep server endpoint changes, login UI behavior, and root python edits here.
|
||||||
|
- Do not commit private credentials, user-local secrets, or accidental personal config changes.
|
||||||
|
- Be careful with packed asset workflows: change the source asset first, then repack intentionally.
|
||||||
|
- Keep protocol-facing login behavior aligned with `m2dev-client-src` and `m2dev-server-src`.
|
||||||
|
|
||||||
|
## Important Files
|
||||||
|
|
||||||
|
Common login/server connection files:
|
||||||
|
|
||||||
|
- `assets/root/serverinfo.py`
|
||||||
|
- `assets/root/intrologin.py`
|
||||||
|
- `assets/root/networkmodule.py`
|
||||||
|
- `assets/root/constinfo.py`
|
||||||
|
- `assets/root/localeinfo.py`
|
||||||
|
|
||||||
|
## Operational Notes
|
||||||
|
|
||||||
|
This repository is where client-visible server endpoint updates usually land.
|
||||||
|
|
||||||
|
If the server address, auth/channel routing, or login UI flow changes:
|
||||||
|
|
||||||
|
- update the relevant root scripts here
|
||||||
|
- keep the packet/protocol side aligned with `m2dev-client-src`
|
||||||
|
- verify against the current Debian server deployment
|
||||||
|
|
||||||
|
## Cross-Repo Boundaries
|
||||||
|
|
||||||
|
- asset/root/python/config changes belong here
|
||||||
|
- client executable and C++ protocol code belong in `m2dev-client-src`
|
||||||
|
- server runtime/deploy/docs belong in `m2dev-server`
|
||||||
|
- server auth/packet implementation belongs in `m2dev-server-src`
|
||||||
10
CLAUDE.md
Normal file
10
CLAUDE.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# CLAUDE.md
|
||||||
|
|
||||||
|
Follow [AGENTS.md](AGENTS.md) as the canonical repo guide.
|
||||||
|
|
||||||
|
Short version:
|
||||||
|
|
||||||
|
- this repo owns client assets, root python files, and packing workflow
|
||||||
|
- server endpoint and login UI updates usually land here
|
||||||
|
- keep protocol-facing changes aligned with `m2dev-client-src` and `m2dev-server-src`
|
||||||
|
- avoid committing accidental local config or secret data
|
||||||
Reference in New Issue
Block a user