Enjoy docking your Cyclops to any base with the first modded base piece for Subnautica! Allows fast base/Cyclops transitions, Cyclops powercells automatic charging and full auto-pilot mode.
Other user's assetsSome assets in this file belong to other authors. You will need to seek permission from these authors before you can use their assets
Upload permissionYou can upload this file to other sites but you must credit me as the creator of the file
Modification permissionYou must get permission from me before you are allowed to modify my files to improve it
Conversion permissionYou are not allowed to convert this file to work on other games under any circumstances
Asset use permissionYou must get permission from me before you are allowed to use any of the assets in this file
Asset use permission in mods/files that are being soldYou are not allowed to use assets from this file in any mods/files that are being sold, for money, on Steam Workshop or other platforms
Asset use permission in mods/files that earn donation pointsYou are not allowed to earn Donation Points for your mods if they use my assets
Author notes
Contributions are welcome. Please contact me on Discord for further information (user ID: osubmarin).
File credits
Special thanks to: @MrPurple and @FirEmerald (for their contribution to implement an alternative version for nautilus). @Unknown Worlds Entertainments (https://unknownworlds.com/about/).
Donation Points system
Please log in to find out whether this mod is receiving Donation Points
Added: A "Stop recording route" tooltip dedicated to "Record route" HUD button. You can edit language string in Config.txt file.
Fixed: Cases where Cyclops HUD would display a tooltip while it should not.
Fixed: Cases where Cyclops Docking Hatch base piece could transform into a vertical connector.
Fixed: Cases where signs would not display properly due to an old bugfix https://www.youtube.com/watch?v=8eGj40Xzkag (could cause conflict with mods also patching the Sign Deserialize function).
Fixed: Some inconsistencies in saved data.
Version 2.1.0
Fixed: Mod initialization messages are now being displayed correctly in BepInEx console.
Fixed: Some cases where the autopilot engine icon was not spining correctly.
Fixed: Some cases where autopilot routes state was not being restored correctly.
Fixed: Some cases where autopilot routes were not being selected correctly.
Fixed: Some cases where an incorrect savegame folder was used when loading saved base pieces and autopilot routes.
Added: Compatibility with nautilus (thanks to MrPurple and FirEmerald for their contribution).
Added: An alternative save file in JSON format in addition to the TEXT file format (thanks to FirEmerald for their contribution). Note: It is not recommanded to manually edit these files, but if you still want to do so I recommand editing the TEXT save file as it takes priority over the JSON one. If you still want to edit the JSON one instead, then you should remove the lines from the TEXT file which starts with the "id" value corresponding to the modified entries from the JSON file (so that your JSON modifications are loaded in instead of the values from the TEXT file). Also don't forget to make backups of these files before manually editing them.
Version 2.0.7
Hotfix to v2.0.6 (related to an issue introduced with the Cyclops HUD bugfix from v2.0.6).
Version 2.0.6
Fixed: Deconstructing the Cyclops Docking base piece will now clean every pieces immediately.
Fixed: A bug where the HUD buttons were not visible when in autopilot or recording modes.
Fixed: Does now installs in the correct folder when installing the mod with Vortex.
Improved: Added an in-game settings menu (the default keyboard key to open it is F7).
Added: A new setting called "openModSettingsKey" in the Config text file (which allows to change the key that opens mod settings).
Version 2.0.5
Updated: Uses latest versions of BepInEx and SMLHelper_BepInEx.
Version 2.0.4
Fixed: Removed debug logs.
Version 2.0.3
Fixed: Stabilizer bug.
Version 2.0.2
Fixed: Deconstructing things with the habitat builder does now give back the appropriate resources.
Version 2.0.1
Fixed: Updated the QMods link (the new version should make it works with latest BepInEx version for everyone).
Version 2.0.0
Fixed: Now works with latest version of Subnautica.
Added: Cyclops full auto-pilot feature.
Version 1.1.2
Fixed: Button bugs.
Version 1.1.1
Added: Full autopilot feature.
Fixed: Various bugs.
Version 1.1.0
Fixed: Connection tube now has proper color and lighting.
Fixed: Sign now has better position in case you build a hatch/reinforcement/planter/window on the wall.
Improved: Constructing a corridor on top of the docking base piece is now disabled.
Improved: Deconstruction of the sign is now disabled.
Version 1.0.2
Fixed: Config.txt loading problem.
Version 1.0.1
Fixed: Cyclops docking base piece data is now properly saved in hardcore mode.
Installation instructions for nautilus (regular version of Subnautica): 1) Install BepInEx from this link. 2) Install nautilus from this link. 3) Download latest version of this mod, and extract the archive (it will give you a folder called CyclopsDockingMod, with various files in it). 4) Move the folder CyclopsDockingMod inside folder "[...]/Subnautica/BepInEx/plugins".
Installation instructions for SML Helper (regular version of Subnautica): 1) Install BepInEx from this link. 2) Install SML Helper from this link. 3) Download version 2.0.7 of this mod, and extract the archive (it will give you a folder called CyclopsDockingMod, with various files in it). 4) Move the folder CyclopsDockingMod inside folder "[...]/Subnautica/BepInEx/plugins".
Installation instructions for SML Helper (legacy version of Subnautica): 1) Install QMods from this link. 2) Install legacy version (not the latest version) of SML Helper from this link. 3) Download version 1.1.2 of this mod, and extract the archive (it will give you a folder called CyclopsDockingMod, with various files in it). 4) Move the folder CyclopsDockingMod inside folder "[...]/Subnautica/QMods".
Update instructions: Same as the installation instructions, just start at step 3. At step 4 it will ask if you want to replace files, say Yes.
Description: Simply get your Cyclops close enough to the Cyclops Docking Hatch base piece (default range is 13 meters) and the autopilot mode will take control of the Cyclops for you to dock it. When the Cyclops is docked, its powercells will charge up if the base has some energy. To undock your Cyclops, simply start the engine and press exit key (E by default). If your Cyclops gets stuck for more than 30 seconds during docking or undocking animations you can press exit key 3 times to abort. This mod represent two new proof of concepts, as it implements: => the first modded base piece for Subnautica, proving that custom base pieces are possible. => the first autopilot mode for the Cyclops, proving that this submarine movements can be scripted.
Configuration: Most settings can be changed directly from the settings menu while in game (default key to open the menu is F7). Here's the list of what you can configure: - Auto docking trigger range (13 meters by default). - Manual or automatic docking (automatic by default). - Start docking key (letter "o" by default, only works when manual docking is enabled). - Powercells charge speed (about 1% every 30 seconds by default). - Ladder tint (no tint by default). If you modify the ladder tint while in game, you need to trigger visual refresh of your base to see the new tint (for example deconstruct/reconstruct a window). - Default signs configuration (yellow with background by default). You can also modify the style of each sign manually (they will keep their style configuration upon game save/restart). You can also change the settings from the Config text file (by default it is located inside folder "[...]/Subnautica/BepInEx/plugins/CyclopsDockingMod"). This Config text file also contains the following additional settings: - Mod settings key (Allows you to modify the keyboard key that is used to open mod settings. By default it's F7). - Recipe (Allows to modify required ingredients to build the Cyclops Docking Hatch base piece). - Enable autopilot feature (Allows you to enable or disable the autopilot feature). - Language strings (Allows to change the language of this mod).
How to create your autopilot routes: 1) Your cyclops needs to be docked to a Cyclops Docking Hatch base piece to start recording a new route, let's call it the "Start Base Piece". 2) Take Cyclops steering wheel in your hand if it is not already (so that the Cyclops HUD shows up), then select "New route" using the arrows button. 3) Now click on the steering wheel button to start recording the route (it will automatically undock your Cyclops and start recording). 4) You go to where you want your route to end, it can be a Cyclops Docking Hatch or just a random location:
If you want your route to end at a random location, click the steering wheel button again to stop recording.
If you want your route to end on a Cyclops Docking Hatch you just need to dock on it (recording will stop automatically).
5) Now the next time your Cyclops will be on the Start Base Piece, you will be able to select your route using the arrows button and click on the steering wheel button to start autopilot mode.
News & updates: March 28, 2024: Multiple bugfixes (see changelogs for details). March 12, 2024: Added alternate version for nautilus. ... ... September 5, 2020: Initial release on NexusMods.
Special thanks to: Unknown Worlds Entertainment for developping Subnautica. MrPurple6411 and FirEmerald for their help to provide an alternate version for nautilus.
"Welcome on board, captain." - Cyclops AI
Join my Discord server if you have any question: https://discord.gg/WDvjt7csWh Or contact me directly on Discord: osubmarin