An open API service indexing awesome lists of open source software.

https://github.com/team3082/ChickenPlanner2025

A powerful, user-friendly trajectory planner designed for FRC teams
https://github.com/team3082/ChickenPlanner2025

frc robitics trajectory-planning

Last synced: 8 months ago
JSON representation

A powerful, user-friendly trajectory planner designed for FRC teams

Awesome Lists containing this project

README

          

# ChickenPlanner: An Open Source FRC Trajectory Planner 🐔

ChickenPlanner Logo

**ChickenPlanner** is a powerful, user-friendly trajectory planner designed for FIRST Robotics Competition (FRC) teams. Built to make trajectory generation straightforward with bezier curves, and help plan autos.

---

## 🚀 **Open Source Project**

This project is proudly open-source! We welcome contributions from the community to improve ChickenPlanner and help it become the ultimate tool for FRC teams. Found a bug? Got an idea for a feature?

👉 **[Join our Discord Community!](https://discord.gg/Gg8XQRPKdx)**
Help us make ChickenPlanner even better by reporting bugs, discussing new features, or just hanging out with the developers.

---

## 📥 Installation

## Installation
Download the most recent App release from the distrubtions folder

---

## 🛠️ Usage

*Coming Soon:* A detailed guide on how to create, customize, and execute trajectories using ChickenPlanner and a more easier user experience with no need for maven commands
1. **Run the Application**
```bash
mvn javafx:run
```
---

## 🧑‍💻 Codebase Structure

*Coming Soon:* An overview of ChickenPlanner's codebase, including its modular components and how everything fits together. Here's what to expect:
- **Core Library**: The main trajectory generation algorithms.
- **Robot Integration**: Examples and utilities to deploy trajectories on FRC robots.
- **Testing and Simulation**: Frameworks to validate paths before deployment.

---

## 📝 Contributing

We love contributions! Whether it's fixing bugs, adding new features, improving documentation, or testing, there's a place for everyone to help. Here's how to get started:
1. Fork the repository.
2. Clone it to your machine.
3. Make your changes on a feature branch.
4. Submit a pull request.

For detailed guidelines, check out our [CONTRIBUTING.md](CONTRIBUTING.md).

---

## 🐛 Bug Reporting & Feedback

Encountered a problem? Have a suggestion? Let us know!
- Report issues via [GitHub Issues](https://github.com/Team3082/ChickenPlanner/issues).
- Join our [Discord Community](https://discord.gg/Gg8XQRPKdx) to chat with the team and other users.

---

## 📜 License

ChickenPlanner is licensed under the [MIT License](LICENSE). Feel free to use it in your projects while adhering to the license terms.

---

Join the journey and help make ChickenPlanner the best tool it can be! 🐔