Skip to content

Commit c18efed

Browse files
authored
Update README.md for TidaLuna
1 parent 5c77a80 commit c18efed

1 file changed

Lines changed: 33 additions & 276 deletions

File tree

README.md

Lines changed: 33 additions & 276 deletions
Original file line numberDiff line numberDiff line change
@@ -1,293 +1,50 @@
1-
# [Tidal Neptune](https://github.com/Inrixia/neptunectl/releases/tag/latest) Plugins
1+
# [TidaLuna](https://github.com/Inrixia/TidaLuna) Plugins
22

3-
This is a repository containing plugins I have made for the [Tidal Neptune Client](https://github.com/Inrixia/neptunectl/releases/tag/latest).
3+
This is a repository containing plugins I have made for the [TidaLuna Client](https://github.com/Inrixia/TidaLuna).
4+
Want to chat, ask questions or hang out? Join the discord! **[discord.gg/jK3uHrJGx4](https://discord.gg/jK3uHrJGx4)**
45

5-
Want to chat, ask questions or hang out? Join the discord! **[discord.gg/jK3uHrJGx4](https://discord.gg/jK3uHrJGx4)**
6+
If you like TidaLuna and my Plugins and want to support me you can do so on my [Sponsor Page](https://github.com/sponsors/Inrixia) ❤️
67

7-
If you like the project, and want to support me can to throw some bits at my [Sponsor Page](https://github.com/sponsors/Inrixia) ❤️
8+
## Installing Plugins
89

9-
To install any of these plugins you need to have the [Tidal Neptune Client](https://github.com/Inrixia/neptunectl/releases/tag/latest) installed.
10-
11-
Then just paste the **Install Url** into the plugins page and hit enter.
12-
13-
![image](https://github.com/Inrixia/neptune-plugins/assets/6373693/a997156c-a281-46ec-992a-397a742dd146)
14-
15-
## My Public Plugins
16-
17-
You can see a list of all plugins including **unreleased** ones under the [**plugins directory**](https://github.com/Inrixia/neptune-plugins/tree/master/plugins)
18-
19-
- [TidalTags](#Tidal-Tags)
20-
- [DiscordRPC](#DiscordRPC)
21-
- [Last.fm](#Last.fm)
22-
- [ListenBrainz](#ListenBrainz)
23-
- [RealMAX](#RealMAX)
24-
- [VolumeScroll](#Volume-Scroll)
25-
- [CoverTheme](#Cover-Theme)
26-
- [NativeFullscreen](#Native-Fullscreen)
27-
- [Themer](#Themer)
28-
- [Always Exclusive](#Always-Exclusive)
29-
- [Shazam Files](#Shazam-Files)
30-
- [NoBuffer](#NoBuffer)
31-
- [Small Window](#Small-Window)
32-
- [Downloader](#Downloader)
33-
34-
## Other Plugin Repositories
35-
36-
- **[twnlink/neptune-plugins](https://github.com/twnlink/neptune-plugins)**
10+
1. Install the [TidaLuna Client](https://github.com/Inrixia/TidaLuna)
11+
2. Open **Luna Settings**
12+
![image](https://github.com/user-attachments/assets/5fbfdda5-5272-45ef-bb4f-e12eef919358)
13+
3. Click on **Plugin Store**
14+
![image](https://github.com/user-attachments/assets/86145ddd-90d4-4cc8-9abd-2a94393faf55)
15+
4. Install the plugins you want from the stores
16+
![image](https://github.com/user-attachments/assets/f9824d1f-6fb7-4c2b-b6fc-e904d6a6ad1b)
3717

3818
## Contributing
39-
40-
Contributing is super simple and really appreciated!
19+
Contributing is super simple and really appreciated!
20+
**If you want to make your own plugins please instead fork [luna-template](https://github.com/Inrixia/luna-template)**
4121

4222
1. Ensure you have **node** and **pnpm** installed.
4323
Install NVM (https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating)
24+
```bash
25+
nvm install latest
26+
nvm use latest
27+
corepack enable
28+
```
4429

45-
```bash
46-
nvm install latest
47-
nvm use latest
48-
npm i -g pnpm
49-
```
30+
2. [Fork](https://github.com/Inrixia/luna-plugins/fork) the repo
5031

5132
2. Clone the repo
52-
53-
```bash
54-
git clone github.com/Inrixia/neptune-plugins
55-
cd neptune-plugins
56-
```
33+
```bash
34+
git clone github.com/yournamehere/luna-plugins
35+
cd luna-plugins
36+
```
5737

5838
3. Install the packages
59-
60-
```bash
61-
pnpm i
62-
```
39+
```bash
40+
pnpm i
41+
```
6342

6443
4. Start dev environment
44+
```bash
45+
pnpm run watch
46+
```
6547

66-
```bash
67-
pnpm run watch
68-
```
69-
70-
5. Install dev plugins
71-
You can now install dev plugins in Neptune with the url `http://localhost:3000/PluginName`
72-
Changes will automatically rebuild so all you need to do is hit refresh in the Neptune plugins menu.
73-
74-
# Plugins
75-
76-
## Tidal Tags
77-
78-
Install Url:
79-
80-
```
81-
https://inrixia.github.io/neptune-plugins/TidalTags
82-
```
83-
84-
Adds
85-
86-
- **Track Quality Tags** next to song titles
87-
- **Sample Rate/Bit Depth/Bitrate** information for currently playing track in the bottom right.
88-
- **Sample Rate/Bit Depth/Bitrate** information for previously played tracks in library.
89-
90-
![image](https://github.com/Inrixia/neptune-plugins/assets/6373693/3883d3f5-c340-4653-beda-ac5971237ee3)
91-
![image](https://github.com/Inrixia/neptune-plugins/assets/6373693/2b30406c-d2e0-4268-92f2-5ae4cc3262af)
92-
93-
## DiscordRPC
94-
95-
Install Url:
96-
97-
```
98-
https://inrixia.github.io/neptune-plugins/DiscordRPC
99-
```
100-
101-
Exactly what you think! Show off what you are listening to in your Discord status.
102-
103-
![image](https://github.com/Inrixia/neptune-plugins/assets/6373693/5dc644a5-1645-4344-b925-09ee2062f8b2)
104-
105-
## Last.fm
106-
107-
Install Url:
108-
109-
```
110-
https://inrixia.github.io/neptune-plugins/LastFM
111-
```
112-
113-
Scrobbles and sets currently playing for [**last.fm**](https://www.last.fm/).
114-
Tidals default last.fm implementation can be very inaccurate, this tries to fix that with a focus on accuracy.
115-
116-
![image](https://github.com/Inrixia/neptune-plugins/assets/6373693/7e4ff7ad-422f-4836-b187-45217c5dd4e3)
117-
118-
## ListenBrainz
119-
120-
Install Url:
121-
122-
```
123-
https://inrixia.github.io/neptune-plugins/ListenBrainz
124-
```
125-
126-
Scrobbles and sets currently playing for [**ListenBrainz**](https://listenbrainz.org/).
127-
128-
![image](https://github.com/user-attachments/assets/2832d750-069a-461c-8500-72263a6bb5ca)
129-
130-
## RealMAX
131-
132-
Install Url:
133-
134-
```
135-
https://inrixia.github.io/neptune-plugins/RealMAX
136-
```
137-
138-
Tidal oftern has multiple versions of the same song at different qualities.
139-
With RealMAX when playing a song if there is a version available at a higher quality it will automatically be added as the next song in the queue and skipped to.
140-
This ensures you are **always listening to the best quality of a song**
141-
142-
## Volume Scroll
143-
144-
Install Url:
145-
146-
```
147-
https://inrixia.github.io/neptune-plugins/VolumeScroll
148-
```
149-
150-
Lets you scroll on the volume icon to change the volume by 10%. Can configure the step size, including different amounts for when you hold <kbd>SHIFT</kbd>.
151-
152-
![image](https://github.com/user-attachments/assets/3a795666-2ed3-4feb-8d42-9374d4f6edd3)
153-
154-
## Cover Theme
155-
156-
Install Url:
157-
158-
```
159-
https://inrixia.github.io/neptune-plugins/CoverTheme
160-
```
161-
162-
Theme Tidal based on the current playing songs cover art. Also adds CSS variables for the cover art to be used in custom themes.
163-
164-
![image](https://github.com/user-attachments/assets/cd1cd715-3032-4786-bf57-f6f6c21c0f23)
165-
166-
## Native Fullscreen
167-
168-
Install Url:
169-
170-
```
171-
https://inrixia.github.io/neptune-plugins/NativeFullscreen
172-
```
173-
174-
Add F11 hotkey for fullscreen to either make the normal UI fullscreen or tidal native fullscreen in a window!
175-
![image](https://github.com/user-attachments/assets/91619318-fd1b-4c43-93fc-fc905630197b)
176-
177-
## Themer
178-
179-
Install Url:
180-
181-
```
182-
https://inrixia.github.io/neptune-plugins/Themer
183-
```
184-
185-
Create your own theme with a built-in CSS editor, powered by [Monaco Editor](https://microsoft.github.io/monaco-editor/). Press <kbd>CTRL</kbd> + <kbd>E</kbd> to open the editor, or go to Themer's plugin settings.
186-
187-
![image](https://github.com/user-attachments/assets/905dc5d9-a694-4729-9d18-b5064bccb879)
188-
189-
## Always Exclusive
190-
191-
Install Url:
192-
193-
```
194-
https://inrixia.github.io/neptune-plugins/AlwaysExclusive
195-
```
196-
197-
While enabled will ensure that audio output is set to exclusive mode
198-
199-
![image](https://github.com/Inrixia/neptune-plugins/assets/6373693/32ff8e55-728c-4a77-9e9e-50b53e90541c)
200-
201-
## Shazam Files
202-
203-
Install Url:
204-
205-
```
206-
https://inrixia.github.io/neptune-plugins/Shazam
207-
```
208-
209-
When enabled any files you drag onto your client will be run through [**Shazam**](https://www.shazam.com/) and added to the current playlist!
210-
211-
![image](https://github.com/Inrixia/neptune-plugins/assets/6373693/f637d5a0-fea0-4ba4-984e-ccddb81341b9)
212-
213-
## NoBuffer
214-
215-
Install Url:
216-
217-
```
218-
https://inrixia.github.io/neptune-plugins/NoBuffer
219-
```
220-
221-
Kicks the Tidal cdn if the current playback stalls to make it stop so you never have to deal with constant stuttering or stalling again!
222-
223-
![image](https://github.com/Inrixia/neptune-plugins/assets/6373693/8378a9a3-2d3f-4cd7-af04-ceeac350b9e6)
224-
225-
## Small Window
226-
227-
Install Url:
228-
229-
```
230-
https://inrixia.github.io/neptune-plugins/SmallWindow
231-
```
232-
233-
Removes the minimum width and height limits on the window. Causes some UI bugs but can be useful if you want a smaller window.
234-
235-
![image](https://github.com/user-attachments/assets/cb1eb26f-fb12-480e-99b2-76f9da5787f4)
236-
237-
## Downloader
238-
239-
Install Url:
240-
241-
```
242-
https://inrixia.github.io/neptune-plugins/SongDownloader
243-
```
244-
245-
Adds a Download button to **Songs**, **Playlists** & **Albums** context menus.
246-
Supports selecting multiple songs.
247-
248-
![image](https://github.com/Inrixia/neptune-plugins/assets/6373693/4811bf7d-3377-4a9a-b33f-ae0dddd394cb)
249-
250-
Embeds full metadata including Lyrics & AlbumArtwork!
251-
252-
```
253-
General
254-
Complete name : Pink Floyd - Wish You Were Here - Shine On You Crazy Diamond (Pts. 1-5).flac
255-
Format : FLAC
256-
Format/Info : Free Lossless Audio Codec
257-
File size : 525 MiB
258-
Duration : 13 min 32 s
259-
Overall bit rate mode : Variable
260-
Overall bit rate : 5 416 kb/s
261-
Album : Wish You Were Here
262-
Album/Performer : Pink Floyd
263-
Track name : Shine On You Crazy Diamond (Pts. 1-5)
264-
Track name/Position : 1
265-
Track name/Total : 5
266-
Performer : Pink Floyd
267-
Recorded date : 1975-09-15
268-
ISRC : GBN9Y1100085
269-
Copyright : (P) 2016 The copyright in this sound recording is owned by Pink Floyd Music Ltd., marketed and distributed by Sony Music Entertainment
270-
Cover : Yes
271-
Cover type : Cover (front)
272-
Cover MIME : image/jpeg
273-
Lyrics : Remember when you were young? (Ha-ha-ha-ha) / You shone like the sun / / Shine on, you crazy diamond / / Now there's a look in your eyes / Like black holes in the sky / / Shine on, you crazy diamond / / You were caught in the crossfire / Of childhood and stardom / Blown on the steel breeze / Come on, you target for faraway laughter / Come on, you stranger / You legend, you martyr, and shine / / You reached for the secret too soon / You cried for the moon / / Shine on, you crazy diamond / / Threatened by shadows at night / And exposed in the light / / Shine on, you crazy diamond / / Well, you wore out your welcome / With random precision / Rode on the steel breeze / Come on, you raver, you seer of visions / Come on, you painter / You piper, you prisoner, and shine
274-
Comment : http://www.tidal.com/track/55391798
275-
276-
Audio
277-
Format : FLAC
278-
Format/Info : Free Lossless Audio Codec
279-
Duration : 13 min 32 s
280-
Bit rate mode : Variable
281-
Bit rate : 5 414 kb/s
282-
Channel(s) : 2 channels
283-
Channel layout : L R
284-
Sampling rate : 192 kHz
285-
Bit depth : 24 bits
286-
Compression mode : Lossless
287-
Replay gain : -2.90 dB
288-
Replay gain peak : 0.710358
289-
Stream size : 525 MiB (100%)
290-
MD5 of the unencoded content: 1401A5C520F16BADDEA6670EFF08200B
291-
```
292-
293-
**Filename format** values use tags. Available values you can use are found here: https://github.com/Inrixia/neptune-plugins/blob/0ca5ba60306fa293b767ec3736a43dd381c19c80/plugins/_lib/makeTags.ts#L68-L87
48+
5. Work on DEV plugins
49+
When running `pnpm run watch` a *DEV* store will appear in client allowing installing *DEV* versions of plugins.
50+
![image](https://github.com/user-attachments/assets/c159bf00-6feb-41c8-8884-3d9e63070c19)

0 commit comments

Comments
 (0)