Skip to content

Add tone marks and pronunciation guide clips for supported fandoms on AO3

Notifications You must be signed in to change notification settings

Cathalinaheart/AO3-Tone-Marks

Repository files navigation

AO3-Tone-Marks

This is based on GodofLaundryBaskets Google Docs Tone Mark Script. It will display the tone marks over the supported chinese names, and if the audio is available allow you to click on that name and listen to the audio guide for that name recorded by lunatique or nonplussed directly on the AO3 page.

Installation

There are two versions: One that also adds an on-page audio pronunciation guide and one that does just the pinyin replacement. For both you need to have tampermonkey/greasemonkey installed. Then you just need to click here for the pinyin replacement only to install/update it or click here for the pinyin replacement with audio guide version.

Supported Fandoms

Tone Marks

  • MXTX: MDZS/The Untamed, TGCF, SVSSS
  • Priest: Guardian, Word of Honor
  • Meatbun: Erha
  • Please don't laugh: JWQS
  • Hu Dielan: King's Avatar
  • Hai Yan: Nirvana in Fire
  • Parallel World

More are in progress.

Pronunciation Guide on Page

  • MXTX:MDZS/The Untamed, TGCF, SVSSS
  • Priest: Guardian, Word of Honor
  • Hai Yan: Nirvana in Fire
  • Parallel World

Audio guide support is currently in progress. Not every word has audio at this point that can be linked.

Contributing

If you would like to help with tone marks for fandoms that are not yet supported or could be improved, you can contribute tone marks to this google sheet. If you want to make changes to existing replacement rules, you can either change them in the spreadsheet and then mark the row red, or you can change it in the spreadsheet and submit a pull request where it is also changed in the corresponding fandoms file, noting what it is you changed.

Issues

If you spot an issue like missing or wrong tone marks, please let me know either by submitting an issue here or reaching out to me on twitter/tumblr @cathalinaheart or via email cathalinaheart {at} gmail.com.

Css tweaks

You can add this css to an AO3 site skin to tweak the appearance of this script's replacements. None of these tweaks change the script's functionality, they only change its appearance.

Underline Replacements

.replacement {
  text-decoration: underline;
}

Hide the speaker symbol

.audio-guide {
  display: none;
}

Hide audio playback progress bars

.tone-audio-button progress {
  display: none;
}

The fandom.txt file format

For each line 'some text here|fancy replacement', the script replaces all instances of 'some text here' in the doc with 'fancy replacement'.

  • capitalization on the left side is ignored
  • any spaces on the left side that are between words will match things with (a) no space there (b) a dash there or (c) a space there. Examples:
    • The line 'hanguang jun|Hánguāng-jūn' will cause the script to replace any of 'hanguang jun', 'hanguangjun', or 'hanguang-jun' with 'Hánguāng-jūn'
    • The line 'wen ke xing|Wēn Kèxíng' will cause the script to replace any of 'Wen KeXing','Wen Ke Xing', and 'wen kexing' with 'Wēn Kèxíng'
  • any spaces on the left or right that are before all words or after all words will be ignored
  • partial-word matches will be ignored (e.g., if 'lan' is part of 'plan', 'land', or 'plant' it will not be replaced; if 'lan sect' is part of 'plan section' it will not be replaced)
  • lines with only spaces on them, or that start with #, will be ignored.
  • If an audio clip is available it can be added to the file like so: "some text|replacement|direct_audio_url"

About

Add tone marks and pronunciation guide clips for supported fandoms on AO3

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published