=====================================================================================
Airships
Author: Kaedius
Version 0.2.14
=====================================================================================

INDEX:

-> About this Mod
-> Features
-> Installation
-> Playing this Mod
-> Known Bugs & Issues
-> Version History
-> Incompatibilities & Save Game Warnings

=====================================================================================
ABOUT THIS MOD:
=====================================================================================

This mod adds an airship for the player to purchase and fly.

=====================================================================================
FEATURES:
=====================================================================================

Fully controllable airship to operate.
Click on a location on the world map, and the ship will automatically fly there.
You can freely walk around on the ship while the ship is in-transit.
You may safely store your loot on the airship.
Charter a flight to travel as a passenger from all major cities.
Configurable air traffic. See other airships zooming across the map!

=====================================================================================
INSTALLATION:
=====================================================================================

Open the downloaded archive and place the .dfmod in the foler of your operating system into DaggerfallUnity_Data/StreamingAssets/Mods folder in your Daggerfall Unity installation directory.

To configure the mod, use the in-game mod configuration menu.

=====================================================================================
PLAYING THIS MOD:
=====================================================================================

Be sure to visit Mod Settings prior to launching to set a few settings to your taste.

Ship cost: The cost of each available ship. You may set the price to 0 for quick access.

Air traffic spawn: You may set the rate of spawn or disable it completely. Keep in mind that at the moment no effort is made to ensure air traffic actually crosses the players path and other airships spawn away from the players view, so even high frequency settings may have limited encounters. The ships will currently destroy themselves when far enough away, but they are slower and can be followed to see their destination.

Instant ship summon: Calling the airship will spawn the ship in the world and it will fly to the player and drop ropes for the player to board. Instant-summon will instantly spawn the ship and place the player at the ships wheel.

Rope Physics: By default the ship ropes will sway with physics. Disable if it causes performance issues or if you prefer static ropes.

Dream Enabled: Toggling this will remove the airship button added to the transport menu, allowing DREAM to take over. Instead, the Ship button is used to call the airship and a prompt will appear if you own both a ship and an airship.

How to Use

There are airship merchants outside of each gate at every large city, as well as a small chance to be in smaller villages. They are standing still and are wearing red. Speak with them to buy/sell an airship, or to charter a flight.

Once bought, bring up the transport window, and click on the airship to call it. If instant summon is not enabled and the ship is inactive, the ship will appear nearby and fly to the player. Use the ropes that drop in order to board the ship. If the ship is already active, the ship will attempt to fly to the players current position but not drop boarding ropes.

Activating the ship itself will bring up the ship window with a few options:

Toggle Ropes: Click to either deploy or reel in the boarding ropes. This occurs once the window is closed and is the main way to board the ship when on foot.

Stop: Clears any active town targets and autopilot. Use to quickly stop the ship if you are away from the ship wheel.

Send Away: Use this to send the ship away for any reason. Can only be used when not on the ship.

Customize: Various customizations for the ship. Currently, only changing the sail color is available. Press Esc to exit the color changing window.

How to Fly

Activate the ship wheel at the back of the ship to begin flying. Use your turn/strafe left and right keys to turn the ship. Tap forwards to increase the speed, tap backwards to decrease speed. The max speed is a value of 10. Press float up to increase vertical speed, and float down to decrease vertical speed. The max vertical speed is 3. Horizontal movement is currently disabled.

The window at the top of the screen displays the current speed settings, with forward speed at the top and vertical on the bottom

Click and hold the left mouse button to bring up the mouse cursor, and hover it over the Autopilot button to activate autopilot. Autopilot will take over the vertical speed and ensure you do not fly into mountains, while you still control forward speed and turning.

Pressing spacebar clears all speed settings as well as autopilot.

Click again on the ship wheel or press escape to exit control. The ship will continue to fly at the last speed settings, so leaving autopilot on is recommended to not fly into the terrain.

Bring up the map menu and click on any location to set a target for the ship to fly to.

Note:The rotation of the ship is currently not in sync with the player. What that means is, try to stay still while the ship rotates before flying to the destination. You may accidentally plummet over the edge!

This is a work-in-progress, with more features and refinements in the works. Please expect there to be bugs, and please report them when you find them!

=====================================================================================
KNOWN ISSUES OR BUGS:
=====================================================================================

The rotation of the ship is currently not in sync with the player. Try to stay still while the ship rotates before flying to its destination, and be careful once it arrives as well. You may accidentally plummet over the edge!

There is currently no max vertical distance. It's not recommended you fly directly upwards beyond view limit as I don't know what exactly would happen...

Using levitate to board the ship doesn't work. For now, use the ropes to board the ship

The world map does not show your position when you fly over the middle of the map, so it can be easy to lose your position. Generally flying south, east, or north will hit land eventually.

Terrain collision is a work-in-progress. If you collide with the terrain, try backing back out or flying up. You'll pop out eventually. It is possible to keep flying into the terrain and entering no-mans-land. Ship-on-ship collision hasn't been tested much and will probably act strangely.

It's not recommended you attempt to board another ship. This may have unknown consequences.

Flying in weather can cause weather to stream behind the ship rather than around the player.

Be cautious in the small compartment in the front of the ship and in the bottom deck. You can walk up through the ceiling/wall.

You cannot jump while on the airship.



=====================================================================================
VERSION HISTORY
=====================================================================================
0.2.14 [9-March-2024]
* Fixed problems with entering the lower deck of each ship. Big thanks to General209 for the fix to the large ship
as well as correcting the textures.
* Added Locked Loot Container compatbility for the ships loot chest. If your chest ever turned into a chest on its
side this is fixed.
* Eased up collisions. Collision with the terrain will stop the ship, but it no longer will try to make sure you don't
continue through the terrain. This should prevent getting stuck in slow mo until I rework collisions.
* Increased acceleration slightly for med and large ships to help avoid modded terrains.

0.2.13 [ 6-Feb-2023]
* Updated Travel Options compatibility.
* Added Language Skills Overhaul - An NPC Follower Mod compatibility.

0.2.12 [ 30-Jan-2023]
* Fix for custom keybinds.

0.2.11 [20-Dec-2022]
* Updated to work with 0.14.5 Beta.

0.2.10 [4-July-2021]
* Fix for potentially losing items in containers placed using Decorator.

0.2.9 [7-June-2021]
* Compatibility with DFU 0.11.4

0.2.8 [24-May-2021]
* Compatibility with DFU 0.11.3

0.2.7 [22-Sept-2020]
* Compatibility with TravelOptions

0.2.6 [26-May-2020]
* Fixed the rope embarking bug
* Increased max rope length (56->100)
* Made ropes slightly thicker.

0.2.5 [5-May-2020]
* Updated for DFUnity 0.10.23
* Added custom texture support (DREAM etc.)
* Fixed Decorator hotkey compatibility.

0.2.4 [22-Feb-2020]
* Added Decorator hotkey compatibility.

0.2.3 [20-Feb-2020]
* Added Decorator mod compatibility.
* Added configure charter gold cost.
* Charter flights only go to other cities.
* Fixed occasional floating airship merchant.

0.2.2 [28-Sept-2019]:
* Updated for DFUnity version 0.10.8

0.2.1 [28-Sept-2019]:
* Minor messagebox bug fixes.
* Increased height large ship summons at.
* Fixed large ship rope getting stuck.

0.2.0 [27-Sept-2019]:
* Added large ship and small ship.
* Added cargo capacity.
* Added ability to charter flights.
* Changed versioning to reflect feature-adding state.

1.0.0 [07-May-2019]:
* Initial release.

=====================================================================================
INCOMPATIBILITIES & SAVED GAME WARNINGS:
=====================================================================================

D.R.E.A.M by King of Worms: This mod adds an airship option to the transport menu, and therefore will conflict with DREAMS transport menu. There is a compatibility option in mod settings to remove the airship button and instead use the Ship button to call the airship.

Tedious Travel by jedidia: Compatible. If you have a current destination and open the travel map while on the ship, be sure to click "No" if it prompts whether to continue journey.

Should be compatible with most other mods.