SirPepperPot's Community Toolkit
An unofficial community modding toolkit for For The King II.
This is the technical SDK area of the larger SirPepperPot Wiki. It covers the standalone FTK2.ModAPI, FTK2.ModAPI.SDK, and FTK2.ModAPI.ExampleMod toolchain. It remains intentionally independent of FTK2 Enhanced Overhaul Remix/EOR.
Important
The toolkit is in the 0.5.x development line and is being prepared for a first Beta release. Documentation labels behavior conservatively as Runtime proven, Implemented, Experimental, Planned, or Unsupported.
Start here
- Introduction — what the toolkit is and what it is not.
- Requirements — the currently tested FTK2/BepInEx/Unity environment.
- Installation — installation model and folder expectations.
- Current capability status — the most important page before depending on a feature.
- Custom items — definitions, activation, localization, visuals and save compatibility.
- Custom abilities — current public boundary and remaining acceptance work.
- API Reference — generated from the public compiled SDK surface when public metadata has been produced.
- Troubleshooting — what to collect before reporting a bug.
Current target environment
| Component | Current target |
|---|---|
| For The King II | 1.14.6 |
| BepInEx | 5.4.23.5 |
| Harmony | 2.9.x |
| Unity | 2022.3.41f1 |
| Toolkit | 0.5.x development line |
Compatibility outside this matrix is not implied unless a release page explicitly says otherwise.
Public docs, private source
The wiki can publish the public C# API surface without publishing the SDK implementation. The private-source workflow generates DocFX metadata locally from release DLLs and XML documentation, then commits only the generated public documentation to this wiki repository.
See the repository README.md and DEPLOYMENT.md for the maintainer workflow.