An open API service indexing awesome lists of open source software.

https://github.com/sglkc/moegi

๐ŸŽต A Spotify web extension for Chromium browsers to style, translate, and romanize lyrics. Supports Chinese, Japanese, Korean, Cyrillic, and more!
https://github.com/sglkc/moegi

chrome chrome-extension chromium chromium-extension cyrillic japanese javascript korean lyrics romanization spotify translation typescript

Last synced: 4 months ago
JSON representation

๐ŸŽต A Spotify web extension for Chromium browsers to style, translate, and romanize lyrics. Supports Chinese, Japanese, Korean, Cyrillic, and more!

Awesome Lists containing this project

README

          


Moegi



[![MIT License](https://img.shields.io/github/license/sglkc/moegi)](LICENSE)
[![Issues](https://img.shields.io/github/issues/sglkc/moegi)](https://github.com/sglkc/moegi/issues)
[![Pull Requests](https://img.shields.io/github/issues-pr/sglkc/moegi)](https://github.com/sglkc/moegi/pulls)
[![Latest Release](https://img.shields.io/github/v/release/sglkc/moegi)](https://github.com/sglkc/moegi/releases/latest)

An extension for Chromium browsers to customize lyrics in Spotify Web Player.

Report a Bug
ยท
Request a Feature

Features lyrics translation for over 100 languages powered by Google Translate and \
romanization for Chinese, Korean, Japanese, Cyrillic, and many more non-latin scripts! \
*Tested on Google Chrome (135.0.7049.52) and Brave Browser (137.1.79.119) on Linux*



## What's New in Version 2?

Most of the changes affects developer experience instead of users, you may not notice anything different from version 1 except some layout or text changes. My main focus is to migrate the framework from CRXJS to WXT for more streamlined development.

There are some things to do:
- Rework to WXT ๐Ÿ’š
- Auto-release on new tags (ci/cd) ๐Ÿ’š
- Reset defaults button
- DeepL translation ๐Ÿ’” (https://github.com/sglkc/moegi/pull/20)
- Reimplement fullscreen handling ๐Ÿ’š
- Implement active lyric listener
- Picture-in-picture lyrics
- Update README, video, and screenshots

## Getting Started

Chromium browsers doesn't support installing extensions directly outside of Chrome Web Store, so follow these steps carefully:

1. Download the **latest release (moegi-x.x.x.zip)** archive from https://github.com/sglkc/moegi/releases/latest
2. **Extract and remember the location** of the extracted folder (moegi-x.x.x)
3. Open Chrome extensions page at ***chrome://extensions***
4. Toggle **developer mode** at the topmost bar
5. Click on the new **Load unpacked** button
6. Find and **select the folder** you extracted earlier (moegi-x.x.x)
7. Moegi should be added to the list and switched on, pin the extension for easy access
- Click on the puzzle piece icon on the top-right
- Find Moegi and click on the pin icon
8. Open Spotify Web Player (https://open.spotify.com)
9. Play any song and open the lyrics page by clicking the microphone icon on bottom-right
10. If you click on Moegi, it should now display a popup, nice!

Steps screenshot
Moegi installation
Moegi loaded

## Features

Show full extension features screenshot
Moegi all features

### Lyrics Styling

The most basic feature to customize your Spotify lyrics screen:

| Feature | Default | Options |
|--------|---------|------------------|
| Text Align | Left | Left, Center, Right |
| Font Size | 1em | 0.5-2.5em |
| Spacing | 0px | 0-64px |
| Colors | None | Background, Passed, Active, Inactive, Translation, Romanization |

> There is an integration issue with the colors, so if you want to reset the colors, use the Reset to defaults button

### Translation

Library used: [google-translate-api-x](https://github.com/AidanWelch/google-translate-api)

Translate lyrics line-by-line using Google Translate, successful translations are cached temporarily in storage to avoid Google Translate limit.
Note that translations are not accurate and should not be used literally! [Read about privacy policy.](#privacy-policy)

| Feature | Default | Options |
|--------|---------|------------------|
| Font Size | 1em | 0.5-1.5em |
| Language Target | auto | [Over 100 languages](https://cloud.google.com/translate/docs/languages) |

### Romanization

Romanize lyrics automatically by detecting the script of each text segment. The extension will apply the appropriate romanization system based on the detected Unicode script.

Supported scripts:
1. [Japanese](#japanese) (Hiragana, Katakana, Kanji)
2. [Korean](#korean) (Hangul)
3. [Chinese](#chinese) (Hanzi)
4. [Cyrillic](#cyrillic)

Other scripts will use the [Any-ASCII fallback](#any).

| Feature | Default | Options |
|--------|---------|------------------|
| Auto-detection | Enabled | Automatic based on Unicode script |
| Font Size | 1em | 0.5-1.5em |

#### Japanese

Libraries used: [@sglkc/kuroshiro](https://github.com/sglkc/kuroshiro-ts),
[@sglkc/kuroshiro-analyzer-kuromoji](https://github.com/sglkc/kuroshiro-analyzer-kuromoji-ts)

Note that Japanese romanization may not be accurate, particularly on kanji!

| Feature | Default | Options |
|--------|---------|------------------|
| To | Romaji | Romaji, Hiragana, Katakana |
| Mode | Spaced | Normal, Spaced, Okurigana, Furigana |
| Romaji System | Hepburn | Nippon, Passport, Hepburn |
| Okurigana Delimiter | ( ) | Custom delimiters |

Differences between each mode in hiragana

**Original Text: ๆ„Ÿใ˜ๅ–ใ‚ŒใŸใ‚‰ๆ‰‹ใ‚’็น‹ใ”ใ†ใ€้‡ใชใ‚‹ใฎใฏไบบ็”Ÿใฎใƒฉใ‚คใƒณ and ใƒฌใƒŸใƒชใ‚ขๆœ€้ซ˜๏ผ**

1. Normal: \
ใ‹ใ‚“ใ˜ใจใ‚ŒใŸใ‚‰ใฆใ‚’ใคใชใ”ใ†ใ€ใ‹ใ•ใชใ‚‹ใฎใฏใ˜ใ‚“ใ›ใ„ใฎใƒฉใ‚คใƒณ and ใƒฌใƒŸใƒชใ‚ขใ•ใ„ใ“ใ†๏ผ

2. Spaced: \
ใ‹ใ‚“ใ˜ใจใ‚Œ ใŸใ‚‰ ใฆ ใ‚’ ใคใชใ” ใ† ใ€ ใ‹ใ•ใชใ‚‹ ใฎ ใฏ ใ˜ใ‚“ใ›ใ„ ใฎ ใƒฉใ‚คใƒณ and ใƒฌใƒŸ ใƒชใ‚ข ใ•ใ„ใ“ใ† ๏ผ

3. Okurigana: \
ๆ„Ÿ(ใ‹ใ‚“)ใ˜ๅ–(ใจ)ใ‚ŒใŸใ‚‰ๆ‰‹(ใฆ)ใ‚’็น‹(ใคใช)ใ”ใ†ใ€้‡(ใ‹ใ•)ใชใ‚‹ใฎใฏไบบ็”Ÿ(ใ˜ใ‚“ใ›ใ„)ใฎใƒฉใ‚คใƒณ and ใƒฌใƒŸใƒชใ‚ขๆœ€้ซ˜(ใ•ใ„ใ“ใ†)๏ผ

4. Furigana: \
ๆ„Ÿ(ใ‹ใ‚“)ใ˜ๅ–(ใจ)ใ‚ŒใŸใ‚‰ๆ‰‹(ใฆ)ใ‚’็น‹(ใคใช)ใ”ใ†ใ€้‡(ใ‹ใ•)ใชใ‚‹ใฎใฏไบบ็”Ÿ(ใ˜ใ‚“ใ›ใ„)ใฎใƒฉใ‚คใƒณ and ใƒฌใƒŸใƒชใ‚ขๆœ€้ซ˜(ใ•ใ„ใ“ใ†)๏ผ

> [Read about romaji romanization systems (for nerds).](https://github.com/sglkc/kuroshiro-ts#romanization-system)

### Korean

Library used: [@romanize/korean](https://www.npmjs.com/package/@romanize/korean)

| Feature | Default | Options |
|--------|---------|------------------|
| Hangul System | Revised | Revised, McCune, Yale |

Differences between each romanization system

**Original Text: ์šฐ๋‘์ปค๋‹ˆ ๊ทธ ์ž๋ฆฌ์— ์„œ์„œ ๊ธฐ๋‹ค๋ฆฌ๋ ค๋‚˜ ๋ด**

1. Revised ([Revised Romanization of Korean](https://en.wikipedia.org/wiki/Revised_Romanization_of_Korean)): \
udukeoni geu jarie seoseo gidariryeona bwa

2. McCune ([McCuneโ€“Reischauer romanization](https://en.wikipedia.org/wiki/McCune%E2%80%93Reischauer)): \
utuk'ลni kลญ carie sลsล kitariryลna pwa

3. Yale ([Yale romanization of Korean](https://en.wikipedia.org/wiki/Yale_romanization_of_Korean)): \
utukheni ku caliey sese kitalilyena pwa

### Cyrillic

Library used: [cyrillic-to-translit-js](https://www.npmjs.com/package/cyrillic-to-translit-js)

| Feature | Default | Options |
|--------|---------|------------------|
| Language | Russian | Russian, Ukrainian |

### Chinese

Library used: [pinyin-pro](https://www.npmjs.com/package/pinyin-pro)

| Feature | Default | Options |
|--------|---------|------------------|
| Ruby text | OFF | ON, OFF |

### Any

Library used: [any-ascii](https://github.com/anyascii/anyascii)

Provides a lot of conversions at the cost of accuracy, read more from the package repository.

## Development

### Prerequisites

- Node ^22
- [pnpm](https://pnpm.io/installation) ^10

```sh
npm install -g pnpm
```

### Steps

If you wish to make modifications or just want to build the extension yourself:

1. Clone the repository

```sh
git clone https://github.com/sglkc/moegi.git
cd moegi
```

2. Install dependencies using pnpm

```sh
pnpm install
```

3. Start extension development and launch test browser

```sh
pnpm dev
```

3. Build extension

```sh
pnpm build
```

## Contributing

Any kind of contributions are **greatly appreciated**! You can start by forking this repository then create a pull request.

1. [Fork](https://github.com/sglkc/moegi/fork) the repository
2. Clone the forked repository to your machine
3. Create your branch (`git checkout -b feat/new-feature`)
4. Commit your changes (`git commit -m 'feat: add this and that'`)
5. Push to the branch (`git push origin feat/new-feature`)
6. Open a [pull request](https://github.com/sglkc/moegi/pulls)

## Disclaimer

Moegi is not affiliated with Spotify in any way.
Moegi is for educational purposes only and should not be used to violate Spotify's terms of service.

## Privacy Policy

1. Moegi does not track your listening habits, your IP address, or any other personal information.
Everything is done locally in the web browser, except for the translation feature.

2. The translation feature uses Google Translate, which is a third-party service.
Google may collect some data about your use of the translation feature, such as the text you translate and the language you translate it to.
For more information about Google's privacy policy, please see https://policies.google.com/privacy.

3. Moegi uses a small amount of storage space on your computer to store the options that you have customized and lyrics you have translated.
It is not used to store any other personal information.

## License

Distributed under the MIT License. See [LICENSE](LICENSE) for more information.