Thank you for your interest in OpenPromptr. This project is intentionally kept small — please read the Project scope section before making larger changes.
- The platform and toolchain requirements in the README
- For signed builds: a "Developer ID Application" or "Apple Development" certificate in the keychain
The only third-party dependencies are AppUpdater and Swifter, resolved by
SwiftPM; swift build is enough.
The build, test, format and bundle commands are in
AGENTS.md, which is their one home.
The app icon and the runtime self-test are described in the README and its self-test section.
- The validation commands in
AGENTS.mdpass. - The change was checked manually with at least one source.
- Behavior changes are described in
README.md.
- Language: All user-facing text, code comments, and commit messages are in English. Symbol names are in English.
- Commits: Conventional Commits,
subject line in English, for example
fix: keep output above the menu bar. - Formatting: Four spaces for indentation, line length of 80 characters as a guideline.
- Dependencies: None. If a task can be solved without an external package, it is solved without one.
- Private APIs: Access to
CGVirtualDisplayand related APIs happens exclusively throughNSClassFromStringinSources/VirtualDisplayBridge. Private symbols are not linked.
The app does exactly one thing: capture a source, mirror or rotate the image, and output it full-screen on a target display — with the lowest possible resource usage.
Text editor, script management, scrolling text, remote control, and recording are explicitly not part of the project. Specialized teleprompter applications exist for such functions.
Please use the issue templates. Please do not create an issue for security-relevant findings; report them as described in SECURITY.md.
The Code of Conduct applies to all project areas.