fix: Add install instructions for websocket plugin (#318)
* Add install instructions for websocket plugin * Add cleare description * add install instructions also into Plugin config
This commit is contained in:
parent
0f93c6516b
commit
b3ea20974c
2 changed files with 44 additions and 1 deletions
|
|
@ -13,5 +13,19 @@ Plugins that have to be enabled
|
|||
- API Websocket
|
||||
|
||||
# Installation
|
||||
- [git](https://git-scm.com/downloads)
|
||||
- [node.js](https://nodejs.org/en/download) >= 22.12.0
|
||||
- [pnpm](https://pnpm.io/installation)
|
||||
|
||||
```bash
|
||||
git clone https://github.com/th-ch/youtube-music
|
||||
cd .\youtube-music\
|
||||
git remote add johannes https://github.com/Johannes7k75/youtube-music.git
|
||||
git fetch johannes
|
||||
git merge johannes/feat/api-websocket
|
||||
pnpm install --frozen-lockfile
|
||||
pnpm dist:win
|
||||
```
|
||||
|
||||
|
||||
See the [forum thread](https://discord.com/channels/1015060230222131221/1257038407503446176/1257038407503446176) / [Vencord docs](https://docs.vencord.dev/installing/custom-plugins/)
|
||||
|
|
@ -26,6 +26,7 @@ import { Player as SpotifyPlayer } from "plugins/spotifyControls/PlayerComponent
|
|||
|
||||
import hoverOnlyStyle from "./hoverOnly.css?managed";
|
||||
import { Player } from "./PlayerComponent";
|
||||
import { Forms, MaskedLink } from "@webpack/common";
|
||||
|
||||
function toggleHoverControls(value: boolean) {
|
||||
(value ? enableStyle : disableStyle)(hoverOnlyStyle);
|
||||
|
|
@ -40,7 +41,35 @@ function isUrlValid(value: string) {
|
|||
}
|
||||
}
|
||||
|
||||
function InstallIstructions() {
|
||||
return (
|
||||
<Forms.FormSection>
|
||||
<Forms.FormTitle tag="h3">How to install</Forms.FormTitle>
|
||||
<Forms.FormText>Instructions on how to install YouTube music with websocket plugin</Forms.FormText>
|
||||
|
||||
<Forms.FormText>
|
||||
|
||||
<span>Software needed: <MaskedLink href="https://git-scm.com/downloads">git</MaskedLink>,<MaskedLink href="https://nodejs.org/en/download">node.js</MaskedLink> >= 22.12.0,<MaskedLink href="https://pnpm.io/installation">pnpm</MaskedLink></span>
|
||||
|
||||
<code className="hljs" style={{ userSelect: "text", cursor: "text" }}>
|
||||
git clone https://github.com/th-ch/youtube-music<br />
|
||||
cd .\youtube-music\<br />
|
||||
git remote add johannes https://github.com/Johannes7k75/youtube-music.git<br />
|
||||
git fetch johannes<br />
|
||||
git merge johannes/feat/api-websocket<br />
|
||||
pnpm install --frozen-lockfile<br />
|
||||
pnpm dist:win<br />
|
||||
</code>
|
||||
</Forms.FormText>
|
||||
</Forms.FormSection>
|
||||
);
|
||||
}
|
||||
|
||||
const settings = definePluginSettings({
|
||||
installYtmWithWebsocket: {
|
||||
type: OptionType.COMPONENT,
|
||||
component: () => <InstallIstructions></InstallIstructions>
|
||||
},
|
||||
hoverControls: {
|
||||
description: "Show controls on hover",
|
||||
type: OptionType.BOOLEAN,
|
||||
|
|
@ -65,7 +94,7 @@ const settings = definePluginSettings({
|
|||
|
||||
export default definePlugin({
|
||||
name: "YouTubeMusicControls",
|
||||
description: "Adds a YouTube Music player above the account panel",
|
||||
description: "Adds a YouTube Music player above the account panel, requires `https://github.com/th-ch/youtube-music` with an custom websocket plugin. See Readme of ths Plugin for instructions",
|
||||
authors: [EquicordDevs.Johannes7k75],
|
||||
settings,
|
||||
patches: [
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue