Skip to content

Commit 5feda32

Browse files
committed
docs: expand README
1 parent 154516e commit 5feda32

File tree

1 file changed

+39
-8
lines changed

1 file changed

+39
-8
lines changed

README.md

Lines changed: 39 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,44 @@
11
# Immersive Autopilot
22

3-
NeoForge 1.21.1 mod that adds the **Tower** block for sending route programs to Immersive Aircraft vehicles.
3+
NeoForge 1.21.1 mod that adds airspace control tools for Immersive Aircraft: **Tower** + **Radar** blocks, route programs, and optional auto routes.
4+
5+
## Requirements
6+
- Minecraft `1.21.1`
7+
- NeoForge `21.1.x`
8+
- Immersive Aircraft `1.2.2+` (NeoForge)
49

510
## Features
6-
- Tower block with GUI
7-
- Scan nearby aircraft and bind targets
8-
- Create/edit route programs (waypoints + speed + hold)
9-
- Pilot receives accept/decline prompt
10-
- Route data stored on aircraft
11+
- Tower block with GUI for scanning aircraft and issuing route programs.
12+
- Radar block that extends tower scan range via nearby radar bonuses.
13+
- Route programs with waypoints, links, and basic guidance (arrow + trigger radius).
14+
- Pilot route offer UI (accept/decline), plus auto routes stored server-side.
15+
- Optional Xaero Minimap integration for temporary waypoint markers.
16+
- Radar range overlay tool for visualizing coverage.
17+
18+
## Blocks & Items
19+
- `Tower` block: airspace control and route editing.
20+
- `Radar` block: range bonus when placed near the tower (5x5x5).
21+
- `Radar Lens`, `Signal Amplifier`, `Radar Range Sensor`, `Radar Identification Module`.
22+
23+
## How To Use
24+
1. Place a `Tower` and open its UI.
25+
1. Create or load a route program.
26+
1. Bind a target aircraft or target all in range.
27+
1. Send the route to the pilot and confirm the offer.
28+
1. (Optional) Use auto routes by listing route names in the aircraft UI.
29+
30+
## Auto Routes (Aircraft UI)
31+
- Each line is a route name. Optional label syntax: `route|label`.
32+
- Auto routes persist server-side and advance when leaving airspace.
33+
- Use the `X` button to clear a single line, or `Clear` to remove all.
34+
35+
## Radar Range Overlay
36+
- Hold `Radar Range Sensor` to display tower coverage.
37+
- Overlap regions render green, single coverage renders gold, boundary is cyan.
38+
39+
## Xaero Minimap
40+
- If Xaero Minimap is installed, temporary waypoints are shown on the minimap.
41+
- This is optional; the mod still works without Xaero.
1142

1243
## Build
1344
```bash
@@ -19,5 +50,5 @@ Output JARs are in `build/libs`.
1950
CI builds the mod and uploads the JAR as an artifact named `immersive-autopilot-jar`.
2051

2152
## Notes
22-
Textures are placeholders; add your own:
23-
- `src/main/resources/assets/immersive_autopilot/textures/block/tower.png`
53+
- `logo.png` is used as the mod logo (see `src/main/resources/logo.png`).
54+
- Textures live under `src/main/resources/assets/immersive_autopilot/textures/`.

0 commit comments

Comments
 (0)