docs: add repo instructions

This commit is contained in:
server
2026-04-14 09:08:33 +02:00
parent 7f4233402a
commit b7c54b909f
2 changed files with 65 additions and 0 deletions

55
AGENTS.md Normal file
View File

@@ -0,0 +1,55 @@
# AGENTS.md
## Repository Role
This repository contains:
- runtime files
- configs
- quests and locale data
- Debian `systemd` deployment files
- operational docs
- root-only login healthcheck wrapper
This is the runtime/deployment side of the stack, not the C++ source repository.
## Working Rules
- Do not commit production secrets.
- Do not commit host-specific overrides unless they are intended defaults.
- Do not commit generated runtime state such as live `channels/`, `pids.json`, or quest build output.
- Keep operational docs under `docs/` in sync with deployment changes.
## Important Directories
- `deploy/systemd/`: versioned Debian units and installer
- `deploy/healthcheck/`: root-only operational login check wrapper
- `docs/`: Debian/Linux-first operational documentation
- `share/conf/`: legacy runtime config files
- `sql/`: schema/bootstrap reference files
## Current Production Reality
The current VPS uses:
- runtime root: `/home/mt2.jakubkadlec.dev/metin/runtime/server`
- installed healthcheck: `/usr/local/sbin/metin-login-healthcheck`
Changes to `deploy/systemd/` or healthchecks should be validated on the VPS after merge.
## Verification After Risky Changes
For runtime/deploy changes, verify with:
```bash
systemctl restart metin-server.service
systemctl status metin-server.service --no-pager
/usr/local/sbin/metin-login-healthcheck
```
## Cross-Repo Boundaries
- C++ server logic belongs in `m2dev-server-src`
- runtime/config/deploy/docs belong here
- client protocol code belongs in `m2dev-client-src`
- client assets and root python files belong in `m2dev-client`