Purpose:
This is a modding framework to change and extend the story for Subnautica - Below Zero.

Update:
there is now also an upload for the game version 45391 in case you're using Epic or the Steam stable branch.

If you're using the Steam Experimental branch, you should use the files for game version 48289 instead.


Please note:
This mod is not meant to be used for playing Subnautica - Below Zero. It is a framework to give other modders a basis to change or extend the story of Subnautica - Below Zero, e.g. the Encyclopedia images, Encyclopedia texts, Encyclopedia dialoges, subtitles (text and sound), calls ("talking heads"), which can be then made into a separate mod.

British PDA Voice for your playthrough
However, there is a download: "SubnauticaFanStoryProject - PDA" that can be used for your playthrough, which replaces the Indian PDA voice with a British PDA voice from ttsfree.com as in the first Subnautica game.

There is also a download: "SubnauticaFanStoryProject - Full", where all spoken dialogs in the game have been replaced with generated speech dialoges from ttsfree.com. This download should not be used for a playthough, as the generated speech dialoges do not sound too well. But it can be used as a template, e.g. if you want to replace a dialog text, as well as the spoken dialog from the vanilla game, then you can replace the included speech files with a recording from a voice actor of your own.

I hope this project finds willing enthusiasts that will extend Subnautica - Below Zero to add new exciting content to this already awesome game =)

I also plan to add the possibility to create entirely new encyclopedia entries and new dialoges in the future.


Description:

Subnautica and Subnautica - Below Zero are massively popular. There is already the Reef Editor mod that allows to change the terrain.

With this mod, modders get the possibility to change the Encyclopedia images, Encyclopedia texts, Encyclopedia dialoges, subtitles (text and sound) and calls ("talking heads").

No coding is required to do this, as this mod provides the functionality to do this.


Installation:

This is a BepInEx mod. Install the latest x64 (64 bit) version of BepInEx and extract it into the Subnautica installation directory:
https://github.com/BepInEx/BepInEx/releases

Also extract this mod into the Subnautica installation directory.

You should now have a directory: <Subnautica Directory> \ BepInEx \ plugins \ SubnauticaFanStoryProject \


Usage:

In this directory you will find an options file: <Subnautica Directory> \ BepInEx \ plugins \ SubnauticaFanStoryProject \ Options.txt

In this file you can set the following options to "true" to do the following actions below.

This actions will be performed when an existing game is loaded or a new game is started.


"Save Actors" : true => This will save the Actor images / Talking Heads to the directory: 
<Subnautica Directory> \ BepInEx \ plugins \ SubnauticaFanStoryProject \ Actors

With this, you can edit the Actor images ("Talking Heads") in the above directory. The edited images will then be loaded and displayed in the game
automatically.

Note: edited images are currently displayed a bit blurry. I will try to get this solved in the next version.

Make sure to set this option back to false after you modified the images, otherwise your modified images will be overwritten with the vanilla ones!


"Save PDA Encyclopedia Images" : true => This will save all images from unlocked Encyclopedia entries into the to the directory: 
<Subnautica Directory> \ BepInEx \ plugins \ SubnauticaFanStoryProject \ Images \ Encyclopedia

Use the command "ency all" to unlock the whole encyclopedia if you want to save all images.

With this, you can edit existing images in the above directory. The edited images will then be loaded and displayed in the game automatically.

Make sure to set this option back to false after you modified the images, otherwise your modified images will be overwritten with the
vanilla ones!


"Save empty Encyclopedia Images" : true = >This will create empty image files for Encyclopida entries that do not have an image.
You can use this option if you want to add new images to Encyclopida entries that do not have an image in the vanilla game yet.


"Debug Logging" : true => This will create a log textfile in the directory: 
<Subnautica Directory> \ BepInEx \ plugins \ SubnauticaFanStoryProject \ Log \ Log.txt

If you find any dialoges or subtitles (sounds) that I might have missed in my playthrough and which are not replaced yet, you can send me this logfile, so that I can create an entry for the sound replacement.

E.g. if there still is a PDA dialog with the Indian voice, please enable the logging and send me the logfile after the PDA dialog has been spoken in-game. With the log file I will be able to add the replacement of the Indian subtitle.


Changing Texts

In this directory you will find the texts that are displayed in Subnautica:
<Subnautica Directory> \ BepInEx \ plugins \ SubnauticaFanStoryProject \ Texts \ <Language>.txt, e.g. English.txt

In the template there is only the text file for English. This text file is a copy from the Subnautica directory:
<Subnautica Directory> \ SubnauticaZero_Data \ StreamingAssets \ SNUnmanagedData \ LanguageFiles

You can copy and use the language files for other languages directly from this directory. I recommend copying the language files to the SubnauticaFanStoryProject \ Texts \ directory, so that you can keep the original files unchanged and only modify the text files in the mod's directory.

In this language file you can change all written texts that are displayed in Subnautica.

Note that there are multiline texts, denoted by the \n (newline) character, e.g.
"EncyDesc_Pregame_Lil_Warning" : "I want to offer my sincerest condolences on the passing of your sister.\nI got to know Sam better toward the end of my mandate with Alterra on 4546B, when we were thrown together as base-mates at Outpost Zero."

Also note that the text files are in unicode format, e.g. you'll find "plant\u2019s" which will be converted to "plant's". You also need to use the \uxxxx (unicode) notation for special characters such as quotes, double-quotes, umlauts, accents etc. if you change the texts, otherwise the special characters might not be displayed correctly.


Known issues

- When replacing the image of an Actor ("Talking Head"), the replaced image is a bit blurry

- Stopping sound clips does not always work correctly:

   o When you stop the spoken dialog in the Encyclopedia, the current line will still be spoken to its end and only then the dialog will be stopped

   o If Robin (the protagonist) or the PDA speaks in-game, the spoken dialog will not be paused / interrupted, when you pause the game with the Escape key.


- Replacing existing sound clips:

   o When replacing the spoken dialog, in a few rare cases the original voices can still be heard,
      e.g. the shuttle computer dialog in the intro of the game, or when Robin (the protagonist) speaks in a cave that has an echo, e.g. Alan's Sancutary.

   o When a line of spoken dialog is replaced with a new sound file, then the length of the new line must match the original line,
      otherwise there will be pauses or overlaps. Therefore, I added the length of each spoken dialog line in the sound mapping file of this mod:
      <Subnautica Directory> \ BepInEx \ plugins \ SubnauticaFanStoryProject \ Sounds.txt
      I'll try to fix this in the next version, so that the length of the replaced sound file will be used in the game instead of the length of the vanilla sound.