docs: add repo instructions

This commit is contained in:
server
2026-04-14 09:08:36 +02:00
committed by Jakub Kadlec
parent 3244c122e2
commit 6bbb4e9b34
2 changed files with 56 additions and 0 deletions

46
AGENTS.md Normal file
View 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`