Skip to content

Commit 86e7fbf

Browse files
committed
Add instructions for downloading pre-built DLLs from GitHub Actions
- Add new Installation section with two options - Document how to download artifacts from Actions tab - Recommend Release build for normal use
1 parent aba58b9 commit 86e7fbf

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,24 @@ This project exposes Cheat Engine functionality as MCP tools over SSE (Server-Se
6767
6868
## Installation
6969
70+
### Option 1: Download Pre-built DLLs (Recommended)
71+
72+
Pre-built Debug and Release DLLs are automatically generated by GitHub Actions on every commit:
73+
74+
1. Go to the [Actions tab](https://github.com/hedgehogform/ce-mcp/actions/workflows/build-dlls.yml) on GitHub
75+
2. Click on the latest successful workflow run
76+
3. Scroll down to the **Artifacts** section
77+
4. Download either:
78+
- `ce-mcp-debug` - Debug build (larger, with debugging info)
79+
- `ce-mcp-release` - Release build (optimized, recommended for normal use)
80+
5. Extract `ce-mcp.dll` from the downloaded ZIP
81+
6. Copy `ce-mcp.dll` to your Cheat Engine plugins directory
82+
7. Enable the plugin in Cheat Engine
83+
84+
### Option 2: Build from Source
85+
7086
1. Build the project: `dotnet build`
71-
2. Copy `ce-mcp.dll` from `bin/` to your Cheat Engine plugins directory
87+
2. Copy `ce-mcp.dll` from `bin/x64/Debug/net10.0-windows/` to your Cheat Engine plugins directory
7288
3. Enable the plugin in Cheat Engine
7389
7490
## Development

0 commit comments

Comments
 (0)