Closed Captions / Subtitles for Vintage Story.
Flesh out README.md
+47
-1
+47
-1
README.md
+47
-1
README.md
···
1
1
# Closed Captions
2
2
3
-
Adds closed captions for sound effects.
3
+
Add closed captions/subtitles to Vintage Story. Make the game playable on mute!
4
+
5
+
Based heavily on goxmeor's existing subtitles mod, but now updated for v1.21, and refined visually somewhat, sorta.
6
+
7
+
## Features
8
+
9
+
### Directionality
10
+
11
+
For sounds within a normal field of view, there will be no arrows or other indicators.
12
+
13
+
For sounds at the edge of your field of view, a single directional arrow is drawn.
14
+
15
+
For sounds to your sides, double arrows are shown.
16
+
17
+
And for sounds behind you, two dots are shown on either side of the sound description.
18
+
19
+
### Colorfulness
20
+
21
+
Sounds are also color coded. "Dangerous" sounds that might alert you to a dangerous situation are highlighted in orange. A small handful of positive sound effects are highlighted in blue, like the "projectile hit" tinkle or lore unlocks.
22
+
23
+
## Completeness
24
+
25
+
As of v1.21.4, I believe I have mapped all vanilla sounds to have audio descriptions. If I've missed any, instead of displaying a description like "Drifter groans," it'll show up as "creature/drifter-aggro." If you see any like this for **vanilla** sound effects, please let me know.
26
+
27
+
## Compatibility
28
+
29
+
Only vanilla sound effects are currently added. Any sound effects added by mods will show up with a placeholder/name.
30
+
31
+
I'm happy to add support for some of the more popular mods myself, but I believe that any mod can add compatibility with this mod by adding caption keys to their language file. If you have a sound at `assets/yourmodid/sounds/creature/dave-singing.ogg`, you'd add a key like this to your language file:
32
+
33
+
```json
34
+
35
+
"captions:creature/dave-singing": "Dave sings",
36
+
37
+
```
38
+
39
+
But this is entirely untested. Let me know if you try it!
40
+
41
+
If you want to add support for a sound effect to this mod, I welcome pull requests. For just adding audio descriptions, it's not too terribly technical, so don't be afraid to jump in and ask questions!
42
+
43
+
## Limitations
44
+
45
+
Like the original mod, currently there is no way to move or resize the captions dialog. This is planned for the unknown future, but pull requests are welcome.
46
+
47
+
Currently, sounds' directions are pinned to where they start, so if the source of a sound moves while the sound is still playing, it will not update. A fix for this is planned.
48
+
49
+
Related to this, sometimes sounds that occur at your location like "Footsteps" and "Armor clatters" will occasionally flicker as showing as behind you as you walk away from your footsteps.