feat: add description for plugins

This commit is contained in:
JellyBrick
2023-11-30 11:42:34 +09:00
parent aa5c3bac4e
commit a22a8ac5c9
32 changed files with 34 additions and 4 deletions

View File

@ -38,6 +38,7 @@ interface AdblockerConfig {
export default createPlugin({
name: 'Adblocker',
description: 'Block all ads and tracking out of the box',
restartNeeded: false,
config: {
enabled: true,

View File

@ -8,6 +8,7 @@ import type { VideoDataChanged } from '@/types/video-data-changed';
export default createPlugin({
name: 'Album Color Theme',
description: 'Applies a dynamic theme and visual effects based on the album color palette',
restartNeeded: true,
config: {
enabled: false,

View File

@ -25,6 +25,7 @@ const defaultConfig: AmbientModePluginConfig = {
export default createPlugin({
name: 'Ambient Mode',
description: 'Applies a lighting effect by casting gentle colors from the video, into your screens background.',
restartNeeded: false,
config: defaultConfig,
stylesheets: [style],

View File

@ -2,7 +2,7 @@ import { createPlugin } from '@/utils';
export default createPlugin({
name: 'Audio Compressor',
description: '',
description: 'Apply compression to audio (lowers the volume of the loudest parts of the signal and raises the volume of the softest parts)',
renderer() {
document.addEventListener(

View File

@ -3,6 +3,7 @@ import style from './style.css?inline';
export default createPlugin({
name: 'Blur Navigation Bar',
description: 'makes navigation bar transparent and blurry',
restartNeeded: true,
stylesheets: [style],
renderer() {},

View File

@ -2,6 +2,7 @@ import { createPlugin } from '@/utils';
export default createPlugin({
name: 'Bypass Age Restrictions',
description: 'bypass YouTube\'s age verification',
restartNeeded: true,
// See https://github.com/zerodytrash/Simple-YouTube-Age-Restriction-Bypass#userscript

View File

@ -19,6 +19,7 @@ export default createPlugin<
CaptionsSelectorConfig
>({
name: 'Captions Selector',
description: 'Caption selector for YouTube Music audio tracks',
config: {
enabled: false,
disableCaptions: false,

View File

@ -9,6 +9,7 @@ export default createPlugin<
}
>({
name: 'Compact Sidebar',
description: 'Always set the sidebar in compact mode',
restartNeeded: false,
config: {
enabled: false,

View File

@ -30,6 +30,7 @@ export default createPlugin<
CrossfadePluginConfig
>({
name: 'Crossfade [beta]',
description: 'Crossfade between songs',
restartNeeded: true,
config: {
enabled: false,

View File

@ -20,6 +20,7 @@ export default createPlugin<
DisableAutoPlayPluginConfig
>({
name: 'Disable Autoplay',
description: 'Makes every song start in "paused" mode',
restartNeeded: false,
config: {
enabled: false,

View File

@ -36,6 +36,7 @@ export type DiscordPluginConfig = {
export default createPlugin({
name: 'Discord Rich Presence',
description: 'Show your friends what you listen to with Rich Presence',
restartNeeded: false,
config: {
enabled: false,

View File

@ -26,6 +26,7 @@ export const defaultConfig: DownloaderPluginConfig = {
export default createPlugin({
name: 'Downloader',
description: 'Downloads MP3 / source audio directly from the interface',
restartNeeded: true,
config: defaultConfig,
stylesheets: [style],

View File

@ -2,6 +2,7 @@ import { createPlugin } from '@/utils';
export default createPlugin({
name: 'Exponential Volume',
description: 'Makes the volume slider exponential so it\'s easier to select lower volumes.',
restartNeeded: true,
config: {
enabled: false,

View File

@ -8,9 +8,9 @@ export interface InAppMenuConfig {
enabled: boolean;
hideDOMWindowControls: boolean;
}
export default createPlugin({
name: 'In-App Menu',
description: 'gives menu-bars a fancy, dark or album-color look',
restartNeeded: true,
config: {
enabled: (

View File

@ -34,6 +34,7 @@ export interface LastFmPluginConfig {
export default createPlugin({
name: 'Last.fm',
description: 'Add scrobbling support for Last.fm',
restartNeeded: true,
config: {
enabled: false,

View File

@ -24,6 +24,7 @@ type LumiaData = {
export default createPlugin({
name: 'Lumia Stream [beta]',
description: 'Adds Lumia Stream support',
restartNeeded: true,
config: {
enabled: false,

View File

@ -10,6 +10,7 @@ export type LyricsGeniusPluginConfig = {
export default createPlugin({
name: 'Lyrics Genius',
description: 'Adds lyrics support for most songs',
restartNeeded: true,
config: {
enabled: false,

View File

@ -7,6 +7,7 @@ import backHTML from './templates/back.html?raw';
export default createPlugin({
name: 'Navigation',
description: 'Next/Back navigation arrows directly integrated in the interface, like in your favorite browser',
restartNeeded: true,
config: {
enabled: true,

View File

@ -3,6 +3,7 @@ import { createPlugin } from '@/utils';
export default createPlugin({
name: 'Remove Google Login',
description: 'Remove Google login buttons and links from the interface',
restartNeeded: true,
config: {
enabled: false,

View File

@ -36,6 +36,7 @@ export const defaultConfig: NotificationsPluginConfig = {
export default createPlugin({
name: 'Notifications',
description: 'Display a notification when a song starts playing (interactive notifications are available on windows)',
restartNeeded: true,
config: defaultConfig,
menu: onMenu,

View File

@ -19,6 +19,7 @@ export type PictureInPicturePluginConfig = {
export default createPlugin({
name: 'Picture In Picture',
description: 'Allows to switch the app to picture-in-picture mode',
restartNeeded: true,
config: {
'enabled': false,

View File

@ -3,6 +3,7 @@ import { onPlayerApiReady, onUnload } from './renderer';
export default createPlugin({
name: 'Playback Speed',
description: 'Listen fast, listen slow! Adds a slider that controls song speed',
restartNeeded: false,
config: {
enabled: false,

View File

@ -21,6 +21,7 @@ export type PreciseVolumePluginConfig = {
export default createPlugin({
name: 'Precise Volume',
description: 'Control the volume precisely using mousewheel/hotkeys, with a custom HUD and customizable volume steps',
restartNeeded: true,
config: {
enabled: false,

View File

@ -9,6 +9,7 @@ import type { YoutubePlayer } from '@/types/youtube-player';
export default createPlugin({
name: 'Video Quality Changer',
description: 'Allows changing the video quality with a button on the video overlay',
restartNeeded: false,
config: {
enabled: false,

View File

@ -16,6 +16,7 @@ export type ShortcutsPluginConfig = {
export default createPlugin({
name: 'Shortcuts (& MPRIS)',
description: 'Allows setting global hotkeys for playback (play/pause/next/previous) + disable media osd by overriding media keys + enable Ctrl/CMD + F to search + enable linux mpris support for mediakeys + custom hotkeys for advanced users',
restartNeeded: true,
config: {
enabled: false,

View File

@ -8,6 +8,7 @@ export type SkipSilencesPluginConfig = {
export default createPlugin({
name: 'Skip Silences',
description: 'Automatically skip silenced sections',
restartNeeded: true,
config: {
enabled: false,

View File

@ -17,6 +17,7 @@ let currentSegments: Segment[] = [];
export default createPlugin({
name: 'SponsorBlock',
description: 'Automatically Skips non-music parts like intro/outro or parts of music videos where the song isn\'t playing',
restartNeeded: true,
config: {
enabled: false,

View File

@ -1,10 +1,10 @@
import { nativeImage } from 'electron';
import playIcon from '@assets/media-icons-black/play.png?asset&asarUnpack';
import pauseIcon from '@assets/media-icons-black/pause.png?asset&asarUnpack';
import nextIcon from '@assets/media-icons-black/next.png?asset&asarUnpack';
import previousIcon from '@assets/media-icons-black/previous.png?asset&asarUnpack';
import { nativeImage } from 'electron';
import { createPlugin } from '@/utils';
import getSongControls from '@/providers/song-controls';
import registerCallback, { type SongInfo } from '@/providers/song-info';
@ -12,6 +12,7 @@ import { mediaIcons } from '@/types/media-icons';
export default createPlugin({
name: 'Taskbar Media Control',
description: 'Control playback from your Windows taskbar',
restartNeeded: true,
config: {
enabled: false,

View File

@ -6,6 +6,7 @@ import registerCallback from '@/providers/song-info';
export default createPlugin({
name: 'TouchBar',
description: 'Custom TouchBar layout for macOS',
restartNeeded: true,
config: {
enabled: false,

View File

@ -19,6 +19,7 @@ interface Data {
export default createPlugin({
name: 'Tuna OBS',
description: 'Integration with OBS\'s plugin Tuna',
restartNeeded: true,
config: {
enabled: false,

View File

@ -17,6 +17,7 @@ export type VideoTogglePluginConfig = {
export default createPlugin({
name: 'Video Toggle',
description: 'Adds a button to switch between Video/Song mode. can also optionally remove the whole video tab',
restartNeeded: true,
config: {
enabled: false,

View File

@ -58,6 +58,7 @@ export type VisualizerPluginConfig = {
export default createPlugin({
name: 'Visualizer',
description: 'Adds a visualizer to the player',
restartNeeded: true,
config: {
enabled: false,