You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Rename tools and docs to vmt-* prefix, update docs
Renamed all user-facing tools and documentation references from legacy names (e.g., qbsp, vis, light, maputil, lightpreview) to the new vmt-* naming convention (e.g., vmt-bsp, vmt-vis, vmt-light, vmt-maputil, vmt-lightpreview). Updated CMake targets, install rules, and documentation to match. Expanded and modernized documentation to clarify the transition from ericw-tools, added migration notes, and improved build and usage instructions.
Copy file name to clipboardExpand all lines: AGENTS.md
+53-41Lines changed: 53 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,12 @@
1
-
# AGENTS.md
1
+
# AGENTS.md
2
2
3
3
Instructions for AI coding agents working on VibeyMapTools.
4
4
5
+
## Philosophy
6
+
7
+
- Documentation should be playful and emoji-rich when brevity is not required, while staying technically accurate.
8
+
- When touching user-facing docs, include a short "coming from ericw-tools" note to orient legacy users.
9
+
5
10
## Project Overview
6
11
7
12
VibeyMapTools (VMT) is a BSP compilation toolset for Quake engine mapping. It is a fork of [ericw-tools](https://github.com/ericwa/ericw-tools) with rebranding and modernization.
@@ -10,38 +15,38 @@ VibeyMapTools (VMT) is a BSP compilation toolset for Quake engine mapping. It is
|`README.md`| Project overview | When features or user story changes |
155
+
|`WIKI.md`| Documentation hub | When adding docs or new tools |
156
+
|`CHANGELOG.md`| Version history | Every PR with user-visible changes |
157
+
|`BUILDING.md`| Build instructions | When build or dependency steps change |
158
+
|`CONTRIBUTING.md`| Contribution guide | When contribution flow changes |
159
+
|`docs/*.rst`| Tool reference docs | When CLI flags or behaviors change |
153
160
154
161
## Making Changes
155
162
@@ -183,6 +190,11 @@ cd docs && make html
183
190
2. Document in `docs/<tool>.rst` under appropriate section
184
191
3. Use existing key/value parsing patterns
185
192
193
+
## Versioning
194
+
195
+
VibeyMapTools uses Semantic Versioning. The `VERSION` file stores the base (next) version, and release tags `vMAJOR.MINOR.PATCH` are the source of truth.
196
+
CMake generates `version.hh` in `build/include` for compile-time version info.
197
+
186
198
## CI/CD
187
199
188
200
### GitHub Actions
@@ -208,10 +220,10 @@ cd docs && make html
208
220
209
221
## Gotchas
210
222
211
-
-**Tool naming**: Executables use `vmt-` prefix, but source directories don't (e.g., `src/qbsp/` builds `vmt-bsp`)
223
+
-**Tool naming**: Executables use `vmt-` prefix, but source directories do not (e.g., `src/qbsp/` builds `vmt-bsp`)
212
224
-**Submodules**: Run `git submodule update --init --recursive` after cloning
213
-
-**Qt6**: Only needed for `lightpreview`, disabled by default
214
-
-**Embree/TBB**: Auto-downloaded on some platforms, may need manual install on others
225
+
-**Qt6**: Only needed for `vmt-lightpreview`, disabled by default
226
+
-**Embree/TBB**: Required dependencies; set `embree_DIR`/`TBB_DIR` if CMake cannot find them
0 commit comments