openrocket/README.md

94 lines
4.3 KiB
Markdown
Raw Normal View History

2023-10-30 12:04:36 +01:00
# OpenRocket 🚀
OpenRocket is a free, fully featured model rocket simulator that allows you to design and simulate your rockets before actually building and flying them.
![Build Status](https://github.com/openrocket/openrocket/actions/workflows/build.yml/badge.svg)
2023-02-02 01:31:53 +00:00
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
![GitHub release](https://img.shields.io/github/release/openrocket/openrocket.svg)
[![Github Releases (by release)](https://img.shields.io/github/downloads/openrocket/openrocket/latest/total.svg)](https://GitHub.com/openrocket/openrocket/releases/)
2023-11-19 22:22:25 +01:00
[![openrocket](https://snapcraft.io/openrocket/badge.svg)](https://snapcraft.io/openrocket)
2023-11-20 21:28:46 +01:00
![Chocolatey release](https://img.shields.io/chocolatey/v/openrocket)
2023-10-03 15:42:39 +02:00
[![Join our Discord server!](https://img.shields.io/discord/1073297014814691328?logo=discord)](https://discord.gg/qD2G5v2FAw)
--------
2023-10-30 12:04:36 +01:00
## 🛠️ Design, Visualize, and Analyze
1. **Design** your rockets using a rich selection of built-in components:
![Three-stage rocket - 2D](.github/OpenRocket_home_2D.png)
2023-10-30 12:04:36 +01:00
2. **Visualize** your masterpiece in 3D:
![Three-stage rocket - 3D](.github/OpenRocket_home_3D.png)
2023-10-30 12:05:41 +01:00
3. **Plot & Analyze** your simulation results for precision and improvements:
2023-10-30 12:04:36 +01:00
![Three-stage rocket - Simulation plot](.github/OpenRocket_sim.png)
2023-10-30 12:04:36 +01:00
## 🌟 Features
2023-10-30 12:04:36 +01:00
- **Six-degree-of-freedom flight simulation**
- **Automatic design optimization**
- **Realtime simulated altitude, velocity, and acceleration display**
- **Staging and clustering support**
- **Cross-platform (Java-based)**
2023-10-30 12:04:36 +01:00
... plus many more
2023-11-05 20:29:28 +01:00
📖 Read more on [our website](https://openrocket.info/) or the [OpenRocket Wiki](http://wiki.openrocket.info).
2023-10-30 12:04:36 +01:00
## 💾 Installers
2023-11-15 17:25:55 +01:00
You can find the OpenRocket installers [here](https://openrocket.info/downloads.html).
2023-10-30 12:04:36 +01:00
## 📝 Release Notes
2020-04-18 16:34:37 -07:00
2022-02-05 00:48:26 +01:00
Release notes are available on each [release's page](https://github.com/openrocket/openrocket/releases) or on [our website](https://openrocket.info/release_notes.html).
2020-04-17 10:41:18 -07:00
2023-10-30 12:23:10 +01:00
## 🚀 Getting started
2023-10-30 12:21:59 +01:00
The easiest way to get started is to open one of our in-program example designs:
![Get started with the example designs](.github/getting-started.png)
2023-10-30 12:25:16 +01:00
Dive into the essentials: adjust component dimensions, plot a simulation, swap out motors, ... Explore the impact of your changes and, most importantly, enjoy the process! 😊
2023-10-30 12:21:59 +01:00
2023-10-30 12:04:36 +01:00
## 💪 Contribute
2023-10-30 12:04:36 +01:00
Help us soar higher! Whether it's implementing features, writing documentation, or creating design examples, every contribution matters. Interested? Check out [how to get involved](http://openrocket.sourceforge.net/getinvolved.html) and the [practicalities of contributing](CONTRIBUTING.md).
2022-01-29 11:44:27 +01:00
2023-10-30 12:04:36 +01:00
### ✨ Contributors
- [Sampo Niskanen](https://github.com/plaa) - Original developer
- [Doug Pedrick](https://github.com/rodinia814) - RockSim designs, printing
- [Kevin Ruland](https://github.com/kruland2607) - Android version
- [Bill Kuker](https://github.com/bkuker) - 3D visualization
- [Richard Graham](https://github.com/rdgraham) - Geodetic computations
- Jason Blood - Freeform fin set import
- [Boris du Reau](https://github.com/bdureau) - Internationalization
- [Daniel Williams](https://github.com/teyrana) - Pod support, maintainer
- [Joe Pfeiffer](https://github.com/JoePfeiffer) - Maintainer
- [Billy Olsen](https://github.com/wolsen) - Maintainer
- [Sibo Van Gool](https://github.com/SiboVG) - RASAero file format, 3D OBJ export, dark theme, maintainer
- [Neil Weinstock](https://github.com/neilweinstock) - Tester, icons, forum support
- [H. Craig Miller](https://github.com/hcraigmiller) - Tester
2020-04-17 10:41:18 -07:00
2023-10-30 12:10:12 +01:00
You can view the full list of contributors [here](https://github.com/openrocket/openrocket/graphs/contributors).
2023-10-30 12:04:36 +01:00
### 🌍Translators
2020-04-17 10:58:27 -07:00
- Tripoli France
- Tripoli Spain
- Stefan Lobas / ERIG
- Mauro Biasutti
2022-06-12 13:59:57 +05:00
- Sky Dart Team / Ruslan V. Uss
2020-04-17 10:58:27 -07:00
- Vladimir Beran
- Polish Rocketry Society / Łukasz & Alex Kazanski
2022-01-29 11:44:27 +01:00
- Sibo Van Gool
- Mohamed Amin Elkebsi
2023-10-30 12:04:36 +01:00
2023-10-30 12:10:12 +01:00
## 📜 License
OpenRocket is proudly open-source under the [GNU GPL](https://www.gnu.org/licenses/gpl-3.0.en.html) license. Feel free to use, study, and extend.
2023-10-30 12:04:36 +01:00
---
⭐ Please give us a star if you find OpenRocket useful, and spread the word! ⭐
2023-10-30 12:10:12 +01:00
[![Star History Chart](https://api.star-history.com/svg?repos=openrocket/openrocket&type=Date)](https://star-history.com/#openrocket/openrocket&Date)