Mods / Closed Captions

Tags:
Accessibility QoL
Author:
apocriva
Side:
Client
Created:
Feb 9th at 12:03 AM
Last modified:
6 days ago
Downloads:
948
Follow Unfollow 64
Recommended download (for Vintage Story 1.22.0 - 1.22.2):
closedcaptions_1.0.5.zip  1-click install

Adds closed captions for the sounds that play in the game. Ambient and dangerous sounds display differently so they are hopefully less (and more!) obtrusive. Now v1.0.0 to coincide with client v1.22.0 stable release!

Accessibility is for everyone! 😁

 

(I hadn't caught that someone else has been working on a CC mod (https://mods.vintagestory.at/captions)! More accessibility for everyone!)

 

For information on adding CC support to another mod, please see the README in the github repo.

Mod Version Mod IdentifierFor Game version Downloads Released Changelog Download 1-click mod install*
1.0.5 closedcaptions
1.22.0 - 1.22.2
76 6 days ago closedcaptions_1.0.5.zip 1-click install

* Fixed raccoon pup idle caption.

1.0.4 closedcaptions
1.22.0 - 1.22.2
61 May 4th at 8:10 PM closedcaptions_1.0.4.zip 1-click install
  • Added missing rope snap caption.
1.0.3 closedcaptions
1.22.0-pre.1 - 1.22.2
26 May 3rd at 1:59 PM closedcaptions_1.0.3.zip 1-click install

API

  • Added optional ignore flag for individual sounds.
1.0.2 closedcaptions
1.22.0-pre.1 - 1.22.2
8 May 3rd at 12:52 PM closedcaptions_1.0.2.zip 1-click install

* Fix for Radiance and Rust music track.

1.0.1 closedcaptions
1.22.0-pre.1 - 1.22.2
70 Apr 26th at 1:43 PM closedcaptions_1.0.1.zip 1-click install

* Added missing captions for ground crafting sounds newly added in 1.22.

1.0.0 closedcaptions
1.22.0-pre.1 - 1.22.0
52 Apr 21st at 10:35 PM closedcaptions_1.0.0.zip 1-click install

No major updates. v1.0.0 release in celebration of client v1.22.0!

0.1.7 closedcaptions 53 Apr 12th at 11:04 PM closedcaptions_0.1.7.zip 1-click install

* Fixed typo for wolf pup howls.

0.1.7-pre.1 closedcaptions
1.22.0-pre.1 - 1.22.0-rc.10
32 Apr 12th at 11:04 PM closedcaptions_0.1.7-pre.1.zip 1-click install

* Fixed typo for wolf pup howls.

0.1.6 closedcaptions 111 Mar 13th at 10:09 PM closedcaptions_0.1.6.zip 1-click install
0.1.6-pre.1 closedcaptions
1.22.0-pre.1 - 1.22.0-rc.8
58 Mar 13th at 10:09 PM closedcaptions_0.1.6-pre.1.zip 1-click install
0.1.5 closedcaptions 137 Feb 16th at 11:25 PM closedcaptions_0.1.5.zip 1-click install
  • Fleshed out story-related captions.
  • Added optional captions for music tracks.
  • Fix for config dropdowns showing lang keys.
0.1.5-pre.1 closedcaptions
1.22.0-pre.1 - 1.22.0-pre.3
49 Feb 16th at 11:25 PM closedcaptions_0.1.5-pre.1.zip 1-click install
  • Fleshed out story-related captions.
  • Added optional captions for music tracks.
  • Fix for config dropdowns showing lang keys.
0.1.4 closedcaptions 25 Feb 16th at 11:28 AM closedcaptions_0.1.4.zip 1-click install
  • Added separate formatting for "rust" captions. (ie temporal stability, temporal storms)
0.1.4-pre.1 closedcaptions
1.22.0-pre.1 - 1.22.0-pre.2
18 Feb 16th at 11:28 AM closedcaptions_0.1.4-pre.1.zip 1-click install
  • Added separate formatting for "rust" captions. (ie temporal stability, temporal storms)
0.1.3 closedcaptions 42 Feb 14th at 4:47 PM closedcaptions_0.1.3.zip 1-click install
  • Recompiled for VS v1.21.6.
0.1.3-pre.1 closedcaptions
1.22.0-pre.1 - 1.22.0-pre.2
21 Feb 14th at 4:47 PM closedcaptions_0.1.3-pre.1.zip 1-click install
  • Compiled for VS v1.22.0-pre-X.
0.1.2 closedcaptions
1.22.0-pre.1 - 1.22.0-pre.2
19 Feb 14th at 9:55 AM closedcaptions_0.1.2.zip 1-click install
  • Added option for glitched text when temporally unstable.
  • Fix for a threading issue.
0.1.1 closedcaptions
1.22.0-pre.1 - 1.22.0-pre.2
27 Feb 12th at 6:37 PM closedcaptions_0.1.1.zip 1-click install
  • More robust configuration options.
0.1.0 closedcaptions
1.22.0-pre.1 - 1.22.0-pre.2
18 Feb 12th at 8:33 AM closedcaptions_0.1.0.zip 1-click install
  • Complete refactoring of sound tracking.
  • Added a few more visual options for dangerous and ambient captions.
0.0.1 closedcaptions 35 Feb 9th at 12:04 AM closedcaptions_0.0.1.zip 1-click install

Initial release.


32 Comments (oldest first | newest first) (threaded | flat)

Cerulean_Jay, 3 days ago

I got permission from TenthArchitect to upload compatibility patches for their FotSA series. Where would you like me to send you the proof? Once confirmed, I will add them to your github repo. I did all of them in honour of my wife. :) Thank you for making such a comprehensive, easy to modify, tool for the deaf / HoH community! It means a lot to us.

apocriva , 2 days ago
@Cerulean_Jay: I got permission from TenthArchitect to upload compatibility patches for their FotSA series. Where would you like me to send you the proof? Once confirmed, I will add them to your github repo. I did all of them in honour of my wife. :) Thank you for makin

Incredible! I started working through FotSA but then got sidelined by a fulltime job and an injury and haven't found the time to push through.

Feel free to make a pull request on the github repo, no other red tape needed. :D

Cerulean_Jay, 4 hours ago (modified 4 hours ago)
@apocriva: Incredible! I started working through FotSA but then got sidelined by a fulltime job and an injury and haven't found the time to push through. Feel free to make a pull request on the github repo, no other red tape needed. :D

Done! Sorry to hear about the injury, glad I could help! Thanks so much. It should also catch future updates because I added a generic sound description in the defaultKey for each order/genus. 

apocriva , Apr 19th at 3:04 PM

Have added documentation on how to add CC support to other mods in the README in the github repo! 🙌

Garlicc, Apr 17th at 6:35 PM

Hey, just curious, I have a mod that adds new music, and I'm wondering if there's anything I can add on my end to make it compatable. Do you know? 

apocriva , Apr 19th at 12:44 PM
@Garlicc: Hey, just curious, I have a mod that adds new music, and I'm wondering if there's anything I can add on my end to make it compatable. Do you know?

I should really write up proper documentation... but in a nutshell:

In your mod, in the folder "assets/<yourmodid>/compatibility/closedcaptions" you can create a json file named whatever you like, with contents based on compatibility/moreanimals/patches/matchconfig-additions.json and correlating language keys in your own language file.

  • "group": wildcard that's checked first to see if the sound being played should match in this group. Usually a folder, like "<yourmodid>:music/*".
  • "defaultKey": language key if nothing more specific is found.
  • And then in "mappings"...
    • "match": wildcard match for this specific caption. For music, likely won't actually need the wildcard, so just something like "<yourmodid>:music/a_music_track.ogg".
    • "tags": probably not needed for music. Though there is a specific "event" tag if the music track plays as part of an event that is particularly ... poignant?? (Like in Dark Souls when you get to Ash Lake... the music only starts playing when you first look up. It's neat! Why is that relevant in Vintage Story?? It is a mystery!!!
      Spoiler!
      Because there is at least one event track in Vintage Story vanilla already!
      )
    • "group": likely not needed, but if you have a bunch of tracks layered and you only want one caption to show up at one time, you can look at the "music/devastation*" config in matchconfig.json to see how to set that up.
    • "captionKey": language key for the caption.

 

Y'know what I have the day off today (I got another full time job just after first releasing this mod so I have been busy!). I will start putting together some better documentation. For now I hope this helps! Thank you for considering accessibility. :)

Garlicc, Apr 20th at 3:02 AM
@Garlicc: Hey, just curious, I have a mod that adds new music, and I'm wondering if there's anything I can add on my end to make it compatable. Do you know?

Hmm.... I'm slightly following along. I really struggle with the json stuff.

So I made the json in the file directory, now I'm trying to figure out what to put where.
For reference, my music is located in the directory: game:music/antique_harmony/songname.ogg

 

Could you take a look?

 

Screenshot
image
Text for coppy and pasting
[
{
"op": "addmerge",
"path": "/soundMap",
"file": "closedcaptions:config/matchconfig.json",
"value": [
{
"group": "antiqueharmony:sounds/*",
"defaultKey": "antiqueharmony:default-key",
"tags": "directionless",
"mappings": [
{
"match": "game:music/antique_harmony/antiquity.ogg",
"captionKey": "antiqueharmony:language-key",
},
{
"match": "antiqueharmony:sounds/wildcard*",
"captionKey": "antiqueharmony:another-language-key",
},
]
}
]
}
]

 

I'm confused what I do for the *, default-key language-key and another-language-key. I'm so lost 😭
Don't I need another file with waht the caption would actually say for each song too? Where would that go?
I live and breathe confussion. 

apocriva , Apr 20th at 4:51 PM
@Garlicc: Hmm.... I'm slightly following along. I really struggle with the json stuff.So I made the json in the file directory, now I'm trying to figure out what to put where.For reference, my music is located in the directory: game:music/antique_harmony/songname.o

It can be a lot of info to take in, no worries. :)

 

You will need to make a language file that holds the text to display. This would be what's translated into other languages. So you'll have two files that end up looking like these:

 

/assets/antiqueharmony/lang/en.json

 

Spoiler!

{

  "antiqueharmony:music-default-key": "Unknown Music",
  "antiqueharmony:music-antiquity": "Antiquity",
}

 

 

/assets/antiqueharmony/compatibility/closedcaptions/matchconfig-additions.json

 

Spoiler!
[
  {
    "op": "addmerge",
    "path": "/soundMap",
    "file": "closedcaptions:config/matchconfig.json",
    "value": [
      {
        "group": "antiqueharmony:music/*",
        "default": "antiqueharmony:music-default-key",
        "mappings": [
          {
            "match": "antiqueharmony:/music/antique_harmony/antiquity.ogg",
            "captionKey": "antiqueharmony:music-antiquity"
          }
        ]
      }
    ]
  }
]

 

I hope this helps! If you run into any further trouble, I will continue to be happy to provide support. :)

 

apocriva , Apr 9th at 10:18 PM

IvoryDaBean This is a client-side mod. What do you mean by "get it to work on a server"?

IvoryDaBean, Apr 7th at 7:48 AM

Hi, first of all, love this mod. I can't seem to get it to work on a server though. I'm not sure why. Has anyone else had this problem?

IssaDwarf, Mar 15th at 12:51 AM

I got so sick of wolves and bears sneaking up on me without any warning that I now play with them on passive.... I don't mess with you, you don't mess with me. Hopefully, this will help me better appreciate what's going on around me in the game and I can once again play without training wheels. Thank you very much for your effort.

FlyntDragon, Mar 14th at 2:27 AM

Eee! Thank you! More Animals end up covering much of what I have in my barn, so it'll be neat to see them show up! The Critter Pack also snuck into my list without me noticing. 

I can not put into words how much I appreciate you doing this.

Coreplant, Mar 13th at 10:49 PM

I haven't tried this yet, but thank you SO MUCH for doing this!

apocriva , Mar 13th at 10:11 PM

Neververy4 And who am I to force optional dependencies on people?? New v0.1.6 release removes forced dependency. o7

FlyntDragon I haven't had much opportunity to add other mod support, but I did slip in More Animals in v.0.1.6. :)

Neververy4, Mar 13th at 11:53 AM

Your mod requires an additional mod, "ConfigLib", and that also requires yet another mod, "ImGui" :(

apocriva , Feb 28th at 11:22 AM

Melerna I know what you mean! I hear 'phantom noises' while playing all the time, and I find it's surprisingly helpful to be able to glance over and see that there is NOT a caption for what I think I hear.

FlyntDragon I'll take a look! :) It involves making JSON patching to add to /config/matchconfig.json, and then having the corresponding localization strings entered. Thank you for your feedback. <3

Coaltrain0 I've been playing without issue on pre.3. Can you share your crash log?

Coaltrain0, Feb 28th at 9:02 AM

I keep getting massive errors on Pre 3, like fatal errors that wont open my save, is this only upto pre 2?

FlyntDragon, Feb 28th at 7:35 AM (modified Feb 28th at 7:38 AM)

This mod is fantastic; I love the way you've visually flavored the sounds 'specially compared to the other captions mod. I normally listen to music when playing games, but because Vintage Story is so heavily dependent on audio awareness (I'd argue this is a good thing, mind!), I haven't been able to until getting this mod, so thank you for creating it.

Would you be able to explain what needs to be done to make this compatable with other mods, such as More Animals or the Fauna of the Stone Age, for example? I figure if it's something I want, I should try and do it myself rather than ask you to do it for us, y'know? ...If I can figure out how, anyways, 'cause of a total lack of any coding experence beyond the most basic of xml work for rimworld....

Melerna, Feb 19th at 2:44 PM

I love this so much! I struggle to tell the difference between many sounds, even with my headphones on and the volume high. I also get startled easily! For some reason, the ambient water sounds always register as a wolf growling to me. I've been wishing for cc for a while now, so this mod has made my day! Thank you for making this :D

ApollyonIch0r, Feb 17th at 4:39 PM

Yayyyy :D

bubbanubo, Feb 16th at 1:33 PM

Thank you so much! What a delightful surprise 🤩

apocriva , Feb 14th at 4:52 PM

bubbanubo RuefulRooks I've gone through the legwork to make a client v1.21 stable release, so should be usable now if it's of interest. :)

bubbanubo, Feb 13th at 9:12 AM

This is awesome (and so are you!). Gonna be the first mod I download once 1.22 drops proper. Keep up the great work, and thank you so much for the accessibility! 

apocriva , Feb 12th at 9:45 PM

RuefulRooks A lot of those are there! I forgot to include a screenshot of the display options, I've added one now. :) Thank you!

RuefulRooks, Feb 12th at 6:54 PM

This is awesome! Thank you for making this. I'm not ready to update to 1.22 yet, but I'm following to check back in later. :)

I would also love to see options to change the placement, text formatting, and opacity of the captions, if you're planning on adding more features. It's really cool to see that you already have the config available in the GUI.

apocriva , Feb 12th at 6:45 PM

Dakras v0.1.1 includes more configuration / layout options. Hopefully you can find what you need! (Also the defaults were changed to be something a little more along the lines of what you've mentioned, so if you reset to defaults either through the ConfigLib menu or by deleting ModConfig/closedcaptions.json, you might like it better out of the box.)

apocriva , Feb 12th at 6:40 PM

DeviousDoge Thank you for saying so! Accessibility is something I care deeply about, and as someone with some kind of sensory processing / hearing issues, I'm actually pleasantly surprised at how much of an impact having these captions has for myself while I'm playing. :)

DeviousDoge, Feb 12th at 8:40 AM

Not something I'd use but just wanted to drop in and say thanks for adding this. Looks like an excellent mod. Honestly hope the devs are able to contact you and integrate this on an engine level :)

apocriva , Feb 12th at 8:31 AM

Dakras Yeah, being able to configure the layout will be a high priority next up, I reckon!

CoraTora Thank you! 💜

CoraTora, Feb 10th at 3:46 AM

This is awesome!

 

Dakras, Feb 10th at 12:21 AM

Can there be an option to show it in the bottom right like how minecraft has it? Alongside options to make it smaller.