sunnypilot/openpilot/system/ui/README.md

ui

The user interfaces here are built with raylib.

Quick start:

• set BIG=1 to run the comma 3X UI (comma four UI runs by default)
• set SHOW_FPS=1 to show the FPS
• set STRICT_MODE=1 to kill the app if it drops too much below 60fps
• set SCALE=1.5 to scale the entire UI by 1.5x
• set BURN_IN=1 to get a burn-in heatmap version of the UI
• set GRID=50 to show a 50-pixel alignment grid overlay
• set MAGIC_DEBUG=1 to show every dropped frames (only on device)
• set RECORD=1 to record the screen, output defaults to output.mp4 but can be set with RECORD_OUTPUT
• https://www.raylib.com/cheatsheet/cheatsheet.html
• https://electronstudio.github.io/raylib-python-cffi/README.html#quickstart

Style guide:

• All graphical elements should subclass Widget.
  • Prefer a stateful widget over a function for easy migration from QT
• All internal class variables and functions should be prefixed with _