Skip to content

Commit 9af42e5

Browse files
committed
Update README
Signed-off-by: Octol1ttle <[email protected]>
1 parent 6e7138e commit 9af42e5

File tree

1 file changed

+18
-48
lines changed

1 file changed

+18
-48
lines changed

README.md

Lines changed: 18 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -11,58 +11,28 @@
1111
alt="Requires Fabric API"></a>
1212
<a href="https://modrinth.com/mod/flightassistant/versions?l=forge&l=neoforge">
1313
<img src="https://cdn.jsdelivr.net/npm/@intergrav/[email protected]/assets/cozy/supported/forge_vector.svg"
14-
alt="Available for Forge"></img></a>
14+
alt="Available for Forge"></a>
1515
<a href="https://discord.gg/5kcBCvnbTp">
1616
<img src="https://cdn.jsdelivr.net/npm/@intergrav/[email protected]/assets/cozy/social/discord-plural_vector.svg"
1717
alt="Chat with us on Discord"></a>
1818
</p>
1919

2020
---
2121

22-
**FlightAssistant** is a client side Minecraft mod that adds a flight style HUD
23-
(like one you would see in a flight simulator), autopilot systems, flight protections, and some more features.
24-
25-
## Main Features (2.x)
26-
27-
- Flight HUD
28-
- Stall protection<sup>1</sup>, warning and automatic recovery<sup>2</sup>
29-
- Ground Proximity Warning System (GPWS):
30-
- Sinkrate warning, protection<sup>1</sup> and automatic recovery
31-
- Unsafe terrain clearance warning, protection<sup>1</sup> and automatic recovery<sup>2</sup>
32-
- Autopilot systems:
33-
- Flight Planner
34-
- Flight Directors
35-
- Auto-firework
36-
- Auto pilot
37-
- Alerts for unsafe flight conditions:
38-
- Low elytra durability
39-
- Approaching void damage altitude
40-
- No response from fireworks
41-
- Unsafe (explosive) fireworks
42-
- Low firework count/no fireworks in inventory
43-
44-
<sup>1</sup> Protection via blocked pitch changes<br>
45-
<sup>2</sup> Automatic recovery via automatic pitch changes and firework usage
46-
47-
## HUD Features (2.x)
48-
49-
<details>
50-
<summary>Diagram</summary>
51-
<img src="images/diagram.png">
52-
</details>
53-
54-
1. Heading
55-
2. Positive pitch
56-
3. Pitch ladder
57-
4. Optimum glide pitch
58-
5. Speed
59-
6. Altitude
60-
7. Negative pitch
61-
8. Coordinates (X / Z)
62-
9. Ground Speed
63-
10. Elytra Health
64-
11. Vertical Speed
65-
12. Height above ground/void
66-
67-
#
68-
<sup><b>FlightAssistant</b> is an unofficial continuation of <a href="https://github.com/frodare/FlightHud">FlightHUD</a> mod by <a href="https://github.com/frodare">frodare</a>.</sup>
22+
**FlightAssistant** is a powerful client-side mod that adds fully configurable full-fledged avionics, situational awareness tools and advanced automation to Minecraft elytras, while still being friendly to casual users.
23+
24+
## Main Features
25+
26+
- Fully customizable flight HUD ([wiki](https://github.com/Octol1ttle/FlightAssistant/wiki/HUD))
27+
- An informative display showing flight data in real time
28+
<img src="https://github.com/Octol1ttle/FlightAssistant/wiki/img/hud/full_screenshot_alt.png">
29+
- Smart flight safety alerts ([wiki](https://github.com/Octol1ttle/FlightAssistant/wiki/Alerts))
30+
- Be aware of unsafe flight conditions before it's too late
31+
<img src="https://github.com/Octol1ttle/FlightAssistant/wiki/img/hud/alert_display_alt.png">
32+
- Non-intrusive automatic flight protections ([wiki](https://github.com/Octol1ttle/FlightAssistant/wiki/Flight-protections))
33+
- When you're not paying attention, FlightAssistant will protect you
34+
- Examples: ground collision damage avoidance, void damage avoidance, automatic elytra deploying
35+
- Advanced autopilot with flight planning capabilities: fly safely completely hands-free ([wiki](https://github.com/Octol1ttle/FlightAssistant/wiki/Autopilot%3A-overview-and-basics))
36+
- Flight plans can be saved to disk and loaded later
37+
- With flight plans, a flight can be performed completely automatically from takeoff to landing
38+
<img src="https://github.com/Octol1ttle/FlightAssistant/wiki/img/hud/full_screenshot.png">

0 commit comments

Comments
 (0)