contributing
Open contributions — from humans.
Block loads into other people’s processes. A bad patch crashes a viewer mid-session. Own the diff, test it, and keep PRs focused.
Ground rules
- Human authorship. No Copilot / ChatGPT / Claude / Cursor Agent / Gemini paste-jobs — disclosed or not. See AI policy.
- Honest compatibility. Only claim a viewer you launched with your build.
- Licence. Code lands under BSD-2-Clause. Update notices when you vendor upstream.
- Focused PRs. One concern when possible. No drive-by dependency dumps.
- Brand. Lime signal
#D4FF3F, lockups inbrand/— do not invent a second look.
Ways to help
| Area | Examples |
|---|---|
| Bugs | Overlay crash, Setup mis-detect — with log text |
| OpenGL / viewers | Firestorm, Alchemy, Black Dragon — presets, Shift+B UX |
| Setup | Viewer discovery, portable browse, OTA copy |
| Vulkan / Linux | Layer hardening; Meson builds on CI |
| Docs & site | VIEWERS / PLATFORMS accuracy, Pages content |
| Review | Say what you built and ran |
Feature ideas: new issue form. Search first.
Build (Windows)
Prerequisites: Git, Visual Studio 2022 Build Tools (MSVC) for the OpenGL injector.
git clone https://github.com/ape-squared/Block.git cd Block powershell -ExecutionPolicy Bypass -File tools\build_reshade_block.ps1 powershell -ExecutionPolicy Bypass -File tools\stage_block_runtime.ps1 powershell -ExecutionPolicy Bypass -File tools\build_block_setup.ps1 tools\BlockSetup.exe
Before you open a PR
- Branch from
main - Exercise the path you changed — viewer + Shift+B for overlay work
- Paste log text, not screenshots of screenshots
- Fill the PR template, including the human-authored checkbox
- Do not commit
build/,build-win/, or viewer logs
What GitHub checks on every PR
- Human authorship gate — PR body must confirm you wrote the patch (template checklist)
- AI heuristic scan — flags common LLM watermarks in added lines
- Linux Vulkan build — Meson compile so the layer keeps building
- Doc path sanity — required docs and site files still exist
A green CI check does not replace “I ran Shift+B on my viewer.” False-positive AI heuristics: explain in the PR and ask a maintainer.
Issues
Use New issue — bug form or feature request. Public attachments are public; strip tokens from logs.