mirror of
https://github.com/sunnypilot/sunnypilot.git
synced 2026-09-12 08:53:42 +08:00
Jason Wen
14318d2f09
# Conflicts: # .github/labeler.yaml # .github/workflows/auto_pr_review.yaml # .github/workflows/docs.yaml # .github/workflows/release.yaml # .github/workflows/repo-maintenance.yaml # .github/workflows/tests.yaml # .github/workflows/ui_preview.yaml # README.md # SConstruct # conftest.py # docs/CARS.md # msgq_repo # opendbc_repo # openpilot/cereal/messaging/tests/validate_sp_cereal_upstream.py # openpilot/common/api.py # openpilot/common/hardware/hw.py # openpilot/common/version.py # openpilot/selfdrive/assets/fonts/Audiowide-Regular.ttf # openpilot/selfdrive/assets/sounds/prompt_single_high.wav # openpilot/selfdrive/assets/sounds/prompt_single_low.wav # openpilot/selfdrive/car/card.py # openpilot/selfdrive/car/helpers.py # openpilot/selfdrive/car/tests/test_car_interfaces.py # openpilot/selfdrive/car/tests/test_cruise_speed.py # openpilot/selfdrive/controls/lib/desire_helper.py # openpilot/selfdrive/controls/lib/longcontrol.py # openpilot/selfdrive/controls/plannerd.py # openpilot/selfdrive/controls/radard.py # openpilot/selfdrive/controls/tests/test_longcontrol.py # openpilot/selfdrive/modeld/compile_warp.py # openpilot/selfdrive/modeld/modeld.py # openpilot/selfdrive/monitoring/policy.py # openpilot/selfdrive/monitoring/test_monitoring.py # openpilot/selfdrive/selfdrived/events.py # openpilot/selfdrive/selfdrived/selfdrived.py # openpilot/selfdrive/ui/layouts/onboarding.py # openpilot/selfdrive/ui/mici/layouts/onboarding.py # openpilot/selfdrive/ui/soundd.py # openpilot/selfdrive/ui/tests/diff/replay.py # openpilot/selfdrive/ui/translations/app.pot # openpilot/system/athena/athenad.py # openpilot/system/athena/manage_athenad.py # openpilot/system/hardware/hardwared.py # openpilot/system/loggerd/config.py # openpilot/system/manager/github_runner.sh # openpilot/system/manager/manager.py # openpilot/system/updated/updated.py # panda # pyproject.toml # scripts/lint/lint.sh # system/manager/process_config.py # system/statsd.py # tinygrad_repo # tools/release/build_release.sh # tools/release/build_stripped.sh # uv.lock
22 lines
1.0 KiB
Markdown
22 lines
1.0 KiB
Markdown
# ui
|
|
|
|
The user interfaces here are built with [raylib](https://www.raylib.com/).
|
|
|
|
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`
|
|
* set `SUNNYPILOT_UI=0` to run the stock UI instead of the sunnypilot UI
|
|
* 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`](/openpilot/system/ui/widgets/__init__.py).
|
|
* Prefer a stateful widget over a function for easy migration from QT
|
|
* All internal class variables and functions should be prefixed with `_`
|