From 5a00c29f665d9a40fc5e87b984c8724ba1adec66 Mon Sep 17 00:00:00 2001
From: Akina <Akina@sugarsource.club>
Date: Sat, 23 May 2026 15:32:08 +0900
Subject: [PATCH] =?UTF-8?q?docs:=20=E6=B7=BB=E5=8A=A0=20AGENTS.md=20?=
 =?UTF-8?q?=E9=A1=B9=E7=9B=AE=E8=A7=84=E5=AE=9A=E4=B8=8E=E9=85=8D=E7=BD=AE?=
 =?UTF-8?q?=E6=8C=87=E5=8D=97?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 AGENTS.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 AGENTS.md

diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 0000000..2b619a5
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,43 @@
+# AGENTS.md — niri config
+
+## Structure
+
+- **`config.kdl`** — main niri compositor config (KDL format, https://kdl.dev). Includes `dms/*.kdl` at the bottom.
+- **`dms/`** — sub-configs, split by concern. Several are auto-generated by DMS (external tool) and **must not be edited** directly:
+
+  | File | Editable? |
+  |---|---|
+  | `layout.kdl`, `cursor.kdl`, `wpblur.kdl`, `alttab.kdl`, `colors.kdl` | No — auto-generated by DMS, note says changes will be overwritten |
+  | `outputs.kdl` | Yes — monitor layout (manually maintained despite auto-gen header) |
+  | `binds.kdl`, `windowrules.kdl` | Yes — empty, available for custom keybinds/window rules |
+
+- **`config.kdl.backup*`** — historical snapshots, not active configs.
+
+## Keybindings (subset referenced in config)
+
+| Keys | Action |
+|---|---|
+| Mod+E | `thunar` (file manager) |
+| Mod+D | `rofi -show drun` (app launcher) |
+| Mod+T | `kitty` (terminal) |
+| Mod+B | `firefox` (browser) |
+| Super+Alt+L | `swaylock` (screen locker) |
+
+(Mod = Super on TTY, Alt on winit window.)
+
+## Key tools
+
+- **niri** — Wayland compositor. Runtime queries: `niri msg outputs`, `niri msg action <action>`.
+- **DMS** — external config manager that re-generates auto files in `dms/`.
+- **Audio:** PipeWire + WirePlumber (`wpctl`). **Media keys:** `playerctl` (MPRIS). **Brightness:** `brightnessctl`.
+
+## Conventions
+
+- Do not edit auto-generated DMS files. Edit `config.kdl`, `dms/outputs.kdl`, `dms/binds.kdl`, or `dms/windowrules.kdl` instead.
+- After config changes, restart niri or use `niri msg` to apply per-action.
+
+## 项目规定
+
+- 使用中文交流。
+- 构建完毕后，按功能将修改拆分提交（一次提交只对应一个目的）。
+- 远程仓库：`git@git.sugarsource.club:Akn/nirion.git`，提交完后执行 `git push`。