Start with the guides under Using CorePin when installing, configuring, or troubleshooting the app. Everything below Developing CorePin is intended for contributors working with the source code, builds, tests, or releases.
- CorePin Overview: what CorePin does, its main features, system requirements, and what to expect.
- User Guide: installation, game libraries, CPU profiles, game settings, the service, updates, maintenance, and removal.
- Performance Profiling: record a game session, understand the diagnosis and charts, select representative gameplay, and compare two runs.
- System Benchmark: run Quick and Full benchmarks, use Demo Mode, understand scores, and compare saved results.
- Troubleshooting: resolve service, game matching, library, profile, recording, benchmark, update, and database problems.
- Security and Privacy: administrator prompts, local data, network access, performance recordings, and CorePin's security boundaries.
CorePin is a personal, spare-time project provided as-is. The guides above are the primary support resources. Updates, fixes, compatibility work, and replies to questions or issue reports are not guaranteed. See Project Status and Support for the full project-maintenance expectations.
These documents describe CorePin's source code, internal contracts, diagnostic tools, automated tests, packaging, and release process. They assume familiarity with Windows development and are not required to use the app. Contributions are welcome, but review, feedback, acceptance, and merge timelines are not guaranteed; see Contributing before starting substantial work.
- Contributing: issue and pull request expectations for a personal-time project.
- Developer Notes: local build, project layout, packaging, screenshot capture, config path, and release maintenance notes.
- Developer Troubleshooting: command-line validation, service events, config reloads, runtime artifacts, detailed tracing, and test harnesses.
- Architecture: UI, shared configuration, Windows service, profiler, benchmark workload, config reload, process detection, affinity/priority application, and core isolation flow.
- Build From Source: required tools, managed and native builds, tests, package creation, and common build issues.
- Configuration: the persisted configuration contract, validation rules, generated fields, and advanced manual settings.
- Performance Session Format: native profiler file format, records, compatibility, and recovery rules.
- CorePin Benchmark: native DirectX 11/12 benchmark and demo, workload presets, safety limits, and profiler validation workflow.
- Automated Scenario Runner: standalone profile and option matrix execution, recovery, validation, and aggregate reports.
- Historical Profiling Baseline: dated before/after service-footprint measurements retained as regression evidence, not current architecture or a fixed resource budget.
- Scripts and Versioning: package scripts, product versioning, tags, releases, and release notes.
- Release Checklist: build, smoke test, package, and publish checklist.
- Release Notes Template: starter release notes format.
- GitHub Security Policy: reporting a vulnerability.
Documentation screenshots are stored in images and referenced from the relevant user guides. Keep filenames stable when replacing an existing capture so links do not need to change.
Contributors can regenerate the screenshots from the repository root with:
dotnet run --no-build --project CorePin.UI.Tests\CorePin.UI.Tests.csproj -- --capture-screenshots docs\images