Move scripts to docgen/, remove possess_flow.png
- docgen/: generate.py, ue_parser.py, ue_markdown.py, ue_mcp_server.py - .mcp.json: update server path to docgen/ue_mcp_server.py - Update CLAUDE.md and README paths accordingly Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
18
README.md
18
README.md
@@ -4,27 +4,27 @@ Generates compact, agent-readable Markdown documentation from Unreal Engine C++
|
||||
|
||||
## How it works
|
||||
|
||||
1. **Parse** — `ue_parser.py` scans UE headers into dataclasses using a position-based scanner (handles nested braces, macros, delegates, namespaces).
|
||||
2. **Render** — `ue_markdown.py` emits one `.md` per header: only items with C++ doc comments, no deprecated functions, compact enum format.
|
||||
3. **Index** — `generate.py` produces `type-index.txt`: a flat `TypeName: path/to/File.md` lookup for instant type resolution.
|
||||
4. **Serve** — `ue_mcp_server.py` exposes the docs to Claude as callable MCP tools.
|
||||
1. **Parse** — `docgen/ue_parser.py` scans UE headers into dataclasses using a position-based scanner (handles nested braces, macros, delegates, namespaces).
|
||||
2. **Render** — `docgen/ue_markdown.py` emits one `.md` per header: only items with C++ doc comments, no deprecated functions, compact enum format.
|
||||
3. **Index** — `docgen/generate.py` produces `type-index.txt`: a flat `TypeName: path/to/File.md` lookup for instant type resolution.
|
||||
4. **Serve** — `docgen/ue_mcp_server.py` exposes the docs to Claude as callable MCP tools.
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
python generate.py <input> [input2 ...] <output_dir>
|
||||
python docgen/generate.py <input> [input2 ...] <output_dir>
|
||||
|
||||
# Examples
|
||||
python generate.py /path/to/UnrealEngine/Engine/Source/ docs/
|
||||
python generate.py Runtime/Engine/ Runtime/AIModule/ Runtime/GameplayTags/ docs/
|
||||
python generate.py Runtime/Engine/Classes/GameFramework/Actor.h docs/
|
||||
python docgen/generate.py /path/to/UnrealEngine/Engine/Source/ docs/
|
||||
python docgen/generate.py Runtime/Engine/ Runtime/AIModule/ Runtime/GameplayTags/ docs/
|
||||
python docgen/generate.py Runtime/Engine/Classes/GameFramework/Actor.h docs/
|
||||
```
|
||||
|
||||
The last argument is always the output directory. All preceding arguments are inputs (files or directories, processed recursively). Output: one `.md` per `.h` + `docs/type-index.txt`.
|
||||
|
||||
## MCP Server
|
||||
|
||||
`ue_mcp_server.py` is a Claude Code MCP server that gives Claude item-granularity access to the generated docs — fetching one class overview or one function instead of an entire file.
|
||||
`docgen/ue_mcp_server.py` is a Claude Code MCP server that gives Claude item-granularity access to the generated docs — fetching one class overview or one function instead of an entire file.
|
||||
|
||||
### Setup
|
||||
|
||||
|
||||
Reference in New Issue
Block a user