Skip to content
This repository was archived by the owner on Aug 14, 2025. It is now read-only.

Commit 04a0a87

Browse files
committed
Update the ships page with a large amount of basic information that was previously missing.
1 parent 5acc325 commit 04a0a87

File tree

1 file changed

+62
-62
lines changed

1 file changed

+62
-62
lines changed

docs/ini-editing/typed-inis/ships.md

Lines changed: 62 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,19 @@ $Top\ Speed = max\_force†/linear\_drag$
4242
[Simple]
4343
nickname = STRING
4444
DA_archetype = PATH
45-
material_library = PATH
45+
material_library = PATH ;repeatable
4646
LODranges = INT, INT, ...
4747
MinSpecLOD = INT
4848
```
4949

50-
| Parameter | Information |
51-
| ---------------- | ----------- |
52-
| nickname | |
53-
| DA_archetype | |
54-
| material_library | |
55-
| ScreenReset | |
56-
| LODranges | |
57-
| MinSpecLOD | |
50+
| Parameter | Information |
51+
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
52+
| nickname | How this simple object is referenced elsewhere in the game's files. |
53+
| DA_archetype | The path to the archetype model to use for the simple. Typically a .3db or .cmp file. |
54+
| material_library | The path to a material library (.mat) file that the `DA_archetype` uses. Missing .mat files will cause the ship, or parts of the model to render inconsistently. |
55+
| ScreenReset | |
56+
| LODranges | |
57+
| MinSpecLOD | |
5858

5959
### Ship
6060

@@ -74,7 +74,7 @@ type = STRING
7474
mass = INT
7575
hold_size = INT
7676
linear_drag = INT
77-
fuse = STRING, FLOAT, FLOAT
77+
fuse = STRING, FLOAT, FLOAT ;repeatable
7878
max_bank_angle = INT
7979
camera_offset = INT, INT
8080
camera_angular_acceleration = FLOAT
@@ -86,7 +86,7 @@ nanobot_limit = INT
8686
shield_battery_limit = INT
8787
hit_pts = INT
8888
DA_archetype = PATH
89-
material_library = PATH
89+
material_library = PATH ;repeatable
9090
envmap_material = STRING
9191
cockpit = PATH
9292
pilot_mesh = STRING
@@ -106,58 +106,58 @@ HP_bay_external = STRING
106106
num_exhaust_nozzles = INT
107107
HP_tractor_source = STRING
108108
shield_link = STRING, STRING, STRING
109-
hp_type = STRING, STRING
109+
hp_type = STRING, STRING ;repeatable
110110
```
111111

112-
| Parameter | Information |
113-
| ----------------------------------- | ----------- |
114-
| ids_name | |
115-
| ids_info | |
116-
| ids_info1 | |
117-
| ids_info2 | |
118-
| ids_info3 | |
119-
| ship_class | |
120-
| nickname | |
121-
| LODranges | |
122-
| msg_id_prefix | |
123-
| mission_property | |
124-
| type | |
125-
| mass | |
126-
| hold_size | |
127-
| linear_drag | |
128-
| fuse | |
129-
| max_bank_angle | |
130-
| camera_offset | |
131-
| camera_angular_acceleration | |
132-
| camera_horizontal_turn_angle | |
133-
| camera_vertical_turn_up_angle | |
134-
| camera_vertical_turn_down_angle | |
135-
| camera_turn_look_ahead_slerp_amount | |
136-
| nanobot_limit | |
137-
| shield_battery_limit | |
138-
| hit_pts | |
139-
| DA_archetype | |
140-
| material_library | |
141-
| envmap_material | |
142-
| cockpit | |
143-
| pilot_mesh | |
144-
| explosion_arch | |
145-
| surface_hit_effects | |
146-
| steering_torque | |
147-
| angular_drag | |
148-
| rotation_inertia | |
149-
| nudge_force | |
150-
| strafe_force | |
151-
| strafe_power_usage | |
152-
| bay_door_anim | |
153-
| bay_doors_open_snd | |
154-
| bay_doors_close_snd | |
155-
| HP_bay_surface | |
156-
| HP_bay_external | |
157-
| num_exhaust_nozzles | |
158-
| HP_tractor_source | |
159-
| shield_link | |
160-
| hp_type | |
112+
| Parameter | Information |
113+
| ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
114+
| ids_name | The string ID name of the ship. |
115+
| ids_info | The stat description text used in the ship dealer. |
116+
| ids_info1 | The 'flavour text' used in a ship's description. |
117+
| ids_info2 | The stats 'fields' used in the ship infobox when examining it outside the ship dealer. In vanilla this value is typically always `66608` |
118+
| ids_info3 | The stats 'numbers' used in the ship infobox when examining it outside the ship dealer. |
119+
| ship_class | A value between 0 and 3. Determines the ship class displayed in the dealer where 0 = 'Light Fighter', 1 = 'Heavy Fighter', 2 = 'Freighter', 3 = 'Very Heavy Fighter' and 4 = |
120+
| nickname | The internal nickname of the ship, i.e. how this will be referred to elsewhere in the game's INI files. |
121+
| LODranges | |
122+
| msg_id_prefix | |
123+
| mission_property | Determines what the ship is able to dock to. Valid options seem to be `can_use_berths` (Which allows the ship to use docking rings), `can_use_med_moors` and `can_use_large_moors`. |
124+
| type | |
125+
| mass | The mass of the ship. This value attenuates any changes in speed that the ship makes. A higher value results in greater attenuation. |
126+
| hold_size | The cargo size of the ship. |
127+
| linear_drag | |
128+
| fuse | A fuse applied to the ship. Values here are typically a [`fuse`](./fuses.md), a delay in seconds and a hit_pts threshold for the fuse to trigger. |
129+
| max_bank_angle | |
130+
| camera_offset | |
131+
| camera_angular_acceleration | |
132+
| camera_horizontal_turn_angle | |
133+
| camera_vertical_turn_up_angle | |
134+
| camera_vertical_turn_down_angle | |
135+
| camera_turn_look_ahead_slerp_amount | |
136+
| nanobot_limit | Determines the maximum number of Nanobots a ship can carry. |
137+
| shield_battery_limit | Determines the maximum number of Shield Batteries a ship can carry. |
138+
| hit_pts | Determines the ship's maximum hit points. |
139+
| DA_archetype | The path to the archetype model to use for the ship. Typically a .3db or .cmp file. |
140+
| material_library | The path to a material library (.mat) file that the `DA_archetype` uses. Missing .mat files will cause the ship, or parts of the model to render inconsistently. |
141+
| envmap_material | |
142+
| cockpit | Path to a [Cockpit](./cockpits.md) ini entry. Determines the properties of the ship's cockpit when in first-person view. |
143+
| pilot_mesh | References a `[Simple]` block to attach at the HpPilot hardpoint. |
144+
| explosion_arch | |
145+
| surface_hit_effects | |
146+
| steering_torque | |
147+
| angular_drag | |
148+
| rotation_inertia | |
149+
| nudge_force | |
150+
| strafe_force | |
151+
| strafe_power_usage | |
152+
| bay_door_anim | The animation in the model file to use when opening and closing the cargo bay doors. |
153+
| bay_doors_open_snd | The [sound](./sounds.md) played when opening the bay doors. |
154+
| bay_doors_close_snd | The [sound](./sounds.md) played when closing the bay doors. |
155+
| HP_bay_surface | |
156+
| HP_bay_external | |
157+
| num_exhaust_nozzles | |
158+
| HP_tractor_source | |
159+
| shield_link | |
160+
| hp_type | |
161161

162162
### CollisionGroup
163163

@@ -184,7 +184,7 @@ linked_equip = STRING, FLOAT ;optional
184184

185185
| Parameter | Information |
186186
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
187-
| obj | |
187+
| obj | References a `[Simple]` block defined elsewhere in the Shiparch file. |
188188
| separable | |
189189
| parent_impulse | |
190190
| child_impulse | |

0 commit comments

Comments
 (0)