From 87d5574e7a9becb5c2a11a229a30b9bda20e1887 Mon Sep 17 00:00:00 2001 From: James <91348155+FrogAi@users.noreply.github.com> Date: Mon, 1 Dec 2025 12:00:00 -0700 Subject: [PATCH] FrogPilot README --- README.md | 239 +++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 190 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index a77a80935..6d8f8f72f 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Quick start: `bash <(curl -fsSL openpilot.comma.ai)` -[![openpilot tests](https://github.com/commaai/openpilot/actions/workflows/tests.yaml/badge.svg)](https://github.com/commaai/openpilot/actions/workflows/tests.yaml) +[![openpilot tests](https://github.com/commaai/openpilot/actions/workflows/selfdrive_tests.yaml/badge.svg)](https://github.com/commaai/openpilot/actions/workflows/selfdrive_tests.yaml) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) [![X Follow](https://img.shields.io/twitter/follow/comma_ai)](https://x.com/comma_ai) [![Discord](https://img.shields.io/discord/469524606043160576)](https://discord.comma.ai) @@ -42,70 +42,211 @@ Using openpilot in a car ------ To use openpilot in a car, you need four things: -1. **Supported Device:** a comma 3X, available at [comma.ai/shop](https://comma.ai/shop/comma-3x). -2. **Software:** The setup procedure for the comma 3X allows users to enter a URL for custom software. Use the URL `openpilot.comma.ai` to install the release version. +1. **Supported Device:** a comma 3/3X, available at [comma.ai/shop](https://comma.ai/shop/comma-3x). +2. **Software:** The setup procedure for the comma 3/3X allows users to enter a URL for custom software. Use the URL `openpilot.comma.ai` to install the release version. 3. **Supported Car:** Ensure that you have one of [the 275+ supported cars](docs/CARS.md). -4. **Car Harness:** You will also need a [car harness](https://comma.ai/shop/car-harness) to connect your comma 3X to your car. +4. **Car Harness:** You will also need a [car harness](https://comma.ai/shop/car-harness) to connect your comma 3/3X to your car. We have detailed instructions for [how to install the harness and device in a car](https://comma.ai/setup). Note that it's possible to run openpilot on [other hardware](https://blog.comma.ai/self-driving-car-for-free/), although it's not plug-and-play. - -### Branches - -Running `master` and other branches directly is supported, but it's recommended to run one of the following prebuilt branches: - -| comma four branch | comma 3X branch | URL | description | -|------------------------|------------------------|----------------------------------------|-------------------------------------------------------------------------------------| -| `release-mici` | `release-tizi` | openpilot.comma.ai | This is openpilot's release branch. | -| `release-mici-staging` | `release-tizi-staging` | openpilot-test.comma.ai | This is the staging branch for releases. Use it to get new releases slightly early. | -| `nightly` | `nightly` | openpilot-nightly.comma.ai | This is the bleeding edge development branch. Do not expect this to be stable. | -| `nightly-dev` | `nightly-dev` | installer.comma.ai/commaai/nightly-dev | Same as nightly, but includes experimental development features for some cars. | - -To start developing openpilot ------ -openpilot is developed by [comma](https://comma.ai/) and by users like you. We welcome both pull requests and issues on [GitHub](http://github.com/commaai/openpilot). +
-* Join the [community Discord](https://discord.comma.ai) -* Check out [the contributing docs](docs/CONTRIBUTING.md) -* Check out the [openpilot tools](tools/) -* Code documentation lives at https://docs.comma.ai -* Information about running openpilot lives on the [community wiki](https://github.com/commaai/openpilot/wiki) +

FrogPilot 🐸

-Want to get paid to work on openpilot? [comma is hiring](https://comma.ai/jobs#open-positions) and offers lots of [bounties](https://comma.ai/bounties) for external contributors. +[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/FrogAi/FrogPilot) +[![Discord](https://img.shields.io/discord/1137853399715549214?label=Discord)](https://discord.frogpilot.com) +[![Last Updated](https://img.shields.io/badge/Last%20Updated-October%2018th%2C%202025-brightgreen)](https://github.com/FrogAi/FrogPilot/releases/latest) +[![Wiki](https://img.shields.io/badge/Wiki-FrogPilot-blue?logo=wiki)](https://frogpilot.wiki.gg/) -Safety and Testing ----- +
-* openpilot observes [ISO26262](https://en.wikipedia.org/wiki/ISO_26262) guidelines, see [SAFETY.md](docs/SAFETY.md) for more details. -* openpilot has software-in-the-loop [tests](.github/workflows/tests.yaml) that run on every commit. -* The code enforcing the safety model lives in panda and is written in C, see [code rigor](https://github.com/commaai/panda#code-rigor) for more details. -* panda has software-in-the-loop [safety tests](https://github.com/commaai/panda/tree/master/tests/safety). -* Internally, we have a hardware-in-the-loop Jenkins test suite that builds and unit tests the various processes. -* panda has additional hardware-in-the-loop [tests](https://github.com/commaai/panda/blob/master/Jenkinsfile). -* We run the latest openpilot in a testing closet containing 10 comma devices continuously replaying routes. +------ -
-MIT Licensed +**FrogPilot** is a custom, community-driven, frog-themed fork of openpilot that grows and improves through the ideas and contributions of its users. It offers exciting new features and cutting-edge experiments that often arrive long before official releases. As an unofficial and highly experimental version of openpilot, **FrogPilot** should *always* be used with caution! -openpilot is released under the MIT license. Some parts of the software are released under other licenses as specified. +openpilot vs **FrogPilot** +------ -Any user of this software shall indemnify and hold harmless Comma.ai, Inc. and its directors, officers, employees, agents, stockholders, affiliates, subcontractors and customers from and against all allegations, claims, actions, suits, demands, damages, liabilities, obligations, losses, settlements, judgments, costs and expenses (including without limitation attorneys’ fees and costs) which arise out of, relate to or result from any use of this software by user. +#### Community +| Feature | openpilot | **FrogPilot** | +|---------|:---------:|:---------:| +| A Welcoming Community | ❌ | βœ… | +| Erich / Primary Moderators / πŸ¦‡ | βœ… | ❌ | -**THIS IS ALPHA QUALITY SOFTWARE FOR RESEARCH PURPOSES ONLY. THIS IS NOT A PRODUCT. -YOU ARE RESPONSIBLE FOR COMPLYING WITH LOCAL LAWS AND REGULATIONS. -NO WARRANTY EXPRESSED OR IMPLIED.** -
+#### Core Features +| Feature | openpilot | **FrogPilot** | +|---------|:---------:|:---------:| +| Always On Lateral (Steering) | ❌ | βœ… | +| Blind Spot Integration | βœ… | βœ… | +| Conditional Experimental Mode | ❌ | βœ… | +| Custom Themes | ❌ | βœ… | +| Driver Monitoring | βœ… | βœ… | +| Driving Model Selector | ❌ | βœ… | +| Holiday Themes | ❌ | βœ… | +| Speed Limit Support | ❌ | βœ… | +| Weather Detection | ❌ | βœ… | -
-User Data and comma Account +#### Device & Hardware +| Feature | openpilot | **FrogPilot** | +|---------|:---------:|:---------:| +| Advanced Volume Controller | ❌ | βœ… | +| Automatic Version Backups | ❌ | βœ… | +| C3 Support | ❌ | βœ… | +| comma Pedal Support | ❌ | βœ… | +| High Quality Recordings | ❌ | βœ… | +| SDSU Support | ❌ | βœ… | +| ZSS Support | ❌ | βœ… | -By default, openpilot uploads the driving data to our servers. You can also access your data through [comma connect](https://connect.comma.ai/). We use your data to train better models and improve openpilot for everyone. +#### Gas/Brake +| Feature | openpilot | **FrogPilot** | +|---------|:---------:|:---------:| +| Adaptive Cruise Control (ACC) | βœ… | βœ… | +| Advanced Live Tuning | ❌ | βœ… | +| Custom Following Distances | ❌ | βœ… | +| Faster Human-Like Acceleration | ❌ | βœ… | +| Human-Like Speed Control in Curves | ❌ | βœ… | +| Smoother Human-Like Braking | ❌ | βœ… | -openpilot is open source software: the user is free to disable data collection if they wish to do so. +#### Steering +| Feature | openpilot | **FrogPilot** | +|---------|:---------:|:---------:| +| Advanced Live Tuning | ❌ | βœ… | +| Automatic Lane Changes | ❌ | βœ… | +| Increased Steering Torque* | ❌ | βœ… | +| Lane Centering (LKAS) | βœ… | βœ… | +| Lane Change Assist | βœ… | βœ… | -openpilot logs the road-facing cameras, CAN, GPS, IMU, magnetometer, thermal sensors, crashes, and operating system logs. -The driver-facing camera and microphone are only logged if you explicitly opt-in in settings. +*Select vehicles only -By using openpilot, you agree to [our Privacy Policy](https://comma.ai/privacy). You understand that use of this software or its related services will generate certain types of user data, which may be logged and stored at the sole discretion of comma. By accepting this agreement, you grant an irrevocable, perpetual, worldwide right to comma for the use of this data. -
+And much much more! + +🌟 Highlight Features +------ + +### πŸš— Always On Lateral (AOL) + +With **"Always On Lateral"**, lane-centering stays active whenever cruise control is on, even when you press the accelerator or brake. This means steering assist won't cut out during manual speed adjustments giving you continuous support through curves, traffic, or mountain roads! + +--- + +### 🧠 Conditional Experimental Mode (CEM) + +**["Experimental Mode"](https://blog.comma.ai/090release/#experimental-mode)** lets openpilot drive at the speed it thinks a human would to allow slowing for curves, stopping at stoplights/stop signs, and adapting to traffic. This makes it powerful in complex scenarios, but it's still, well, "experimental" and less predictable than **"Chill Mode"**. But **"Conditional Experimental Mode"** gives you the best of both worlds by automatically switching between **"Chill Mode"** for steady cruising and **"Experimental Mode"** for more advanced situations to help fully automate your driving experience! + +**"Conditional Experimental Mode"** switches into **"Experimental Mode"** when conditions like these are met: +- Approaching curves and turns +- Detecting slower or stopped lead vehicles +- Driving below a set speed +- Predicting an upcoming stop (e.g. stoplight or stop sign) + +Once conditions clear it returns to **"Chill Mode"** for stability and predictability. + +**Note: Stay attentive as "Experimental Mode" is an alpha feature and mistakes are expected!** + +--- + +### 🎭 Driving Personalities + +With **"Driving Personalities"**, you choose how the vehicle behaves with four adjustable profiles: + +- **Traffic:** Catered towards stop-and-go traffic by minimizing gaps and delays +- **Aggressive:** Aimed to provide tighter following distances and quicker reactions +- **Standard:** Useful for a balanced, all-purpose driving +- **Relaxed:** A smoother driving experience with larger following distance gaps + +Each profile can be fine-tuned to change the desired following distance, acceleration, and braking style letting you shape **FrogPilot**'s behavior to match your own driving preferences! Profiles can be switched instantly using the following distance button on the steering wheel, while **"Traffic Mode"** can be enabled by simply holding down the following distance button. + +--- + +### πŸ“ Speed Limit Controller (SLC) + +With **"Speed Limit Controller"**, **FrogPilot** automatically adapts to the road's posted speed using information from downloaded **["OpenStreetMap"](https://www.openstreetmap.org)** maps, online **["Mapbox"](https://www.mapbox.com)** data, and the vehicle's dashboard (if supported). + +Offsets let you fine-tune how closely **FrogPilot** follows posted limits across different speed ranges allowing you to cruise slightly above or below for a more natural driving experience. If no speed limit is available, you can choose whether **FrogPilot** drives at the set speed, falls back to the last known speed limit, or uses **"Experimental Mode"** to estimate one with the driving model. + +Maps can be downloaded directly in settings and updated automatically on a schedule ensuring your device always has the latest speed limits! + +**Note: Speed limits are only as accurate as the available speed limit data. Always stay attentive and adjust your speed when necessary!** + +--- + +### 🎨 Themes + +With **"Themes"**, you can personalize **FrogPilot**'s driving screen to make it uniquely yours! Choose from: + +- **Color Schemes** +- **Icon Packs** +- **Sound Packs** +- **Turn Signal Animations** +- **Steering Wheel Icons** + +Enjoy pre-existing **FrogPilot** and seasonal holiday themes, or you can create your own with the **"Theme Maker"** and even share them with the community! For extra fun, enable features like the Mario Kart–style **"Rainbow Path"** or **"Random Events"** that add playful visual effects while you drive! + +--- + +And lots more! From safety enhancements to personalization options, **FrogPilot** continues to evolve with features that put you in control. Check it out today for yourself! + +--- + +πŸ”§ Branches +------ +| Branch | Install URL | Description | Recommended For | +|----------------------------|---------------------------|--------------------------------------------------------|--------------------------| +| FrogPilot | frogpilot.download | The main release branch. | Everyone | +| FrogPilot‑Staging | staging.frogpilot.download| Beta branch with upcoming features. Expect bugs! | Early Adopters | +| FrogPilot‑Testing | testing.frogpilot.download| Alpha branch with bleeding-edge features. Breaks often!| Advanced Testers | +| FrogPilot‑Development| No :) | Active development branch. Do not use! | **FrogPilot** Developers| +| MAKE‑PRS‑HERE | No :) | Workspace for pull requests. Do not use! | Contributors | + +🧰 How to Install +------ + +The easiest way to install **FrogPilot** is by entering this URL on the installation screen: + +``` +frogpilot.download +``` + +**DO NOT** install the **FrogPilot-Development** branch. I'm constantly breaking things on there, so unless you don't want to use **FrogPilot**, **NEVER** install it! + +![](https://i.imgur.com/FsufQtO.png) + +🐞 Bug Reports / Feature Requests +------ + +If you run into bugs, issues, or have ideas for new features, please post about it on the **[FrogPilot Discord](https://discord.gg/frogpilot)**! Feedback helps improve **FrogPilot** and create a better experience for everyone! + +To report a bug, please post it in [**#bug-reports**](https://discord.com/channels/1137853399715549214/1162100167110053888). +To request a feature, please post it in [**#feature-requests**](https://discord.com/channels/1137853399715549214/1160318669839147259). + +Please include as much detail as possible! Photos, videos, log files, or anything that can help explain the issue or idea are very helpful! + +I'll do my best to respond promptly, but not every request can be addressed right away. Your feedback is always appreciated and helps make **FrogPilot** the best it can be! + +πŸ“‹ Credits +------ + +* [Aidenir](https://github.com/Aidenir) +* [AlexandreSato](https://github.com/AlexandreSato) +* [cfranyota](https://github.com/cfranyota) +* [cydia2020](https://github.com/cydia2020) +* [dragonpilot-community](https://github.com/dragonpilot-community) +* [ErichMoraga](https://github.com/ErichMoraga) +* [garrettpall](https://github.com/garrettpall) +* [jakethesnake420](https://github.com/jakethesnake420) +* [jyoung8607](https://github.com/jyoung8607) +* [mike8643](https://github.com/mike8643) +* [neokii](https://github.com/neokii) +* [OPGM](https://github.com/opgm) +* [OPKR](https://github.com/openpilotkr) +* [pfeiferj](https://github.com/pfeiferj) +* [realfast](https://github.com/realfast) +* [syncword](https://github.com/syncword) +* [twilsonco](https://github.com/twilsonco) + +Star History +------ + +[![Star History Chart](https://api.star-history.com/svg?repos=FrogAi/FrogPilot&type=Date)](https://www.star-history.com/#FrogAi/FrogPilot&Date)