Skip to content

Commit 0eb65f0

Browse files
committed
chore(docs): update README
1 parent 25fccc9 commit 0eb65f0

File tree

1 file changed

+1
-119
lines changed

1 file changed

+1
-119
lines changed

README.md

Lines changed: 1 addition & 119 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,12 @@
1414

1515
![Screenshot](web/screenshot.png "Screenshot")
1616

17-
Read this in other languages: [한국어](./docs/readme/README-ko.md), [Française](./docs/readme/README-fr.md), [Íslenska](./docs/readme/README-is.md), [Español](./docs/readme/README-es.md), [Pусский](./docs/readme/README-ru.md), [Українська](./docs/readme/README-uk.md), [Magyar](./docs/readme/README-hu.md), [Português](./docs/readme/README-pt.md), [日本語](./docs/readme/README-ja.md)
18-
19-
**Electron wrapper around YouTube Music featuring:**
20-
2117
- Native look & feel, aims at keeping the original interface
22-
- Framework for custom plugins: change YouTube Music to your needs (style, content, features), enable/disable plugins in
2318
one click
2419

25-
## Demo Image
26-
27-
| Player Screen (album color theme & ambient light) |
28-
|:---------------------------------------------------------------------------------------------------------:|
29-
|![Screenshot1](https://github.com/th-ch/youtube-music/assets/16558115/53efdf73-b8fa-4d7b-a235-b96b91ea77fc)|
30-
3120
## Content
3221

3322
- [Features](#features)
34-
- [Available plugins](#available-plugins)
3523
- [Translation](#translation)
3624
- [Download](#download)
3725
- [Arch Linux](#arch-linux)
@@ -49,111 +37,6 @@ Read this in other languages: [한국어](./docs/readme/README-ko.md), [Françai
4937
- [License](#license)
5038
- [FAQ](#faq)
5139

52-
## Features:
53-
54-
- **Auto confirm when paused** (Always Enabled): disable
55-
the ["Continue Watching?"](https://user-images.githubusercontent.com/61631665/129977894-01c60740-7ec6-4bf0-9a2c-25da24491b0e.png)
56-
popup that pause music after a certain time
57-
58-
- And more ...
59-
60-
## Available plugins:
61-
- **Album Actions**: Adds Undislike, Dislike, Like, and Unlike buttons to apply this to all songs in a playlist or album
62-
63-
- **Album Color Theme**: Applies a dynamic theme and visual effects based on the album color palette
64-
65-
- **Ambient Mode**: Applies a lighting effect by casting gentle colors from the video, into your screen’s background
66-
67-
- **Audio Compressor**: Apply compression to audio (lowers the volume of the loudest parts of the signal and raises the
68-
volume of the softest parts)
69-
70-
- **Blur Navigation Bar**: makes navigation bar transparent and blurry
71-
72-
- **Bypass Age Restrictions**: bypass YouTube's age verification
73-
74-
- **Captions Selector**: Enable captions
75-
76-
- **Compact Sidebar**: Always set the sidebar in compact mode
77-
78-
- **Crossfade**: Crossfade between songs
79-
80-
- **Disable Autoplay**: Makes every song start in "paused" mode
81-
82-
- **[Discord](https://discord.com/) Rich Presence**: Show your friends what you listen to
83-
with [Rich Presence](https://user-images.githubusercontent.com/28219076/104362104-a7a0b980-5513-11eb-9744-bb89eabe0016.png)
84-
85-
- **Downloader**: downloads
86-
MP3 [directly from the interface](https://user-images.githubusercontent.com/61631665/129977677-83a7d067-c192-45e1-98ae-b5a4927393be.png) [(youtube-dl)](https://github.com/ytdl-org/youtube-dl)
87-
88-
- **Equalizer**: add filters to boost or cut specific range of frequencies (e.g. bass booster)
89-
90-
- **Exponential Volume**: Makes the volume
91-
slider [exponential](https://greasyfork.org/en/scripts/397686-youtube-music-fix-volume-ratio/) so it's easier to
92-
select lower volumes
93-
94-
- **In-App Menu**: [gives bars a fancy, dark look](https://user-images.githubusercontent.com/78568641/112215894-923dbf00-8c29-11eb-95c3-3ce15db27eca.png)
95-
96-
> (see [this post](https://github.com/th-ch/youtube-music/issues/410#issuecomment-952060709) if you have problem
97-
accessing the menu after enabling this plugin and hide-menu option)
98-
99-
- **Scrobbler**: Adds scrobbling support for [Last.fm](https://www.last.fm/) and [ListenBrainz](https://listenbrainz.org/)
100-
101-
- **Lumia Stream**: Adds [Lumia Stream](https://lumiastream.com/) support
102-
103-
- **Lyrics Genius**: Adds lyrics support for most songs
104-
105-
- **Music Together**: Share a playlist with others. When the host plays a song, everyone else will hear the same song
106-
107-
- **Navigation**: Next/Back navigation arrows directly integrated in the interface, like in your favorite browser
108-
109-
- **Notifications**: Display a notification when a song starts
110-
playing ([interactive notifications](https://user-images.githubusercontent.com/78568641/114102651-63ce0e00-98d0-11eb-9dfe-c5a02bb54f9c.png)
111-
are available on windows)
112-
113-
- **Picture-in-picture**: allows to switch the app to picture-in-picture mode
114-
115-
- **Playback Speed**: Listen fast, listen
116-
slow! [Adds a slider that controls song speed](https://user-images.githubusercontent.com/61631665/129976003-e55db5ba-bf42-448c-a059-26a009775e68.png)
117-
118-
- **Precise Volume**: Control the volume precisely using mousewheel/hotkeys, with a custom hud and customizable volume
119-
steps
120-
121-
- **Shortcuts (& MPRIS)**: Allows setting global hotkeys for playback (play/pause/next/previous) +
122-
disable [media osd](https://user-images.githubusercontent.com/84923831/128601225-afa38c1f-dea8-4209-9f72-0f84c1dd8b54.png)
123-
by overriding media keys + enable Ctrl/CMD + F to search + enable linux mpris support for
124-
mediakeys + [custom hotkeys](https://github.com/Araxeus/youtube-music/blob/1e591d6a3df98449bcda6e63baab249b28026148/providers/song-controls.js#L13-L50)
125-
for [advanced users](https://github.com/th-ch/youtube-music/issues/106#issuecomment-952156902)
126-
127-
- **Skip Disliked Song**: Skips disliked songs
128-
129-
- **Skip Silences**: Automatically skip silenced sections
130-
131-
- [**SponsorBlock**](https://github.com/ajayyy/SponsorBlock): Automatically Skips non-music parts like intro/outro or
132-
parts of music videos where the song isn't playing
133-
134-
- **Synced Lyrics**: Provides synced lyrics to songs, using providers like [LRClib](https://lrclib.net).
135-
136-
- **Taskbar Media Control**: Control playback from
137-
your [Windows taskbar](https://user-images.githubusercontent.com/78568641/111916130-24a35e80-8a82-11eb-80c8-5021c1aa27f4.png)
138-
139-
- **TouchBar**: Custom TouchBar layout for macOS
140-
141-
- **Tuna OBS**: Integration with [OBS](https://obsproject.com/)'s
142-
plugin [Tuna](https://obsproject.com/forum/resources/tuna.843/)
143-
144-
- **Unobtrusive Player**: Prevents the player from popping up when playing a song
145-
146-
- **Video Quality Changer**: Allows changing the video quality with
147-
a [button](https://user-images.githubusercontent.com/78568641/138574366-70324a5e-2d64-4f6a-acdd-dc2a2b9cecc5.png) on
148-
the video overlay
149-
150-
- **Video Toggle**: Adds
151-
a [button](https://user-images.githubusercontent.com/28893833/173663950-63e6610e-a532-49b7-9afa-54cb57ddfc15.png) to
152-
switch between Video/Song mode. can also optionally remove the whole video tab
153-
154-
- **Visualizer**: Different music visualizers
155-
156-
15740
## Translation
15841

15942
You can help with translation on [Hosted Weblate](https://hosted.weblate.org/projects/youtube-music/).
@@ -343,8 +226,7 @@ export default createPlugin({
343226
enabled: false,
344227
}, // your custom config
345228
renderer() {
346-
// Remove the login button
347-
document.querySelector(".sign-in-link.ytmusic-nav-bar").remove();
229+
console.log('hello from renderer');
348230
} // define renderer hook
349231
});
350232
```

0 commit comments

Comments
 (0)