Skip to content

Commit 2408bd2

Browse files
committed
Album photo addition, some bug fixes, new features and more totally easy to follow code.
1 parent 669e169 commit 2408bd2

File tree

5 files changed

+173
-32
lines changed

5 files changed

+173
-32
lines changed

.classpath

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
</attributes>
77
</classpathentry>
88
<classpathentry kind="src" path="src"/>
9-
<classpathentry kind="lib" path="libraries/slf4j-api-2.0.7.jar"/>
10-
<classpathentry kind="lib" path="libraries/slf4j-simple-2.0.7.jar"/>
119
<classpathentry kind="lib" path="libraries/json-20210307.jar"/>
1210
<classpathentry kind="lib" path="libraries/junixsocket-common-2.0.4.3.jar"/>
11+
<classpathentry kind="lib" path="B:/Projects/Napoleon-x/Workspace/VLCDiscordRPC/libraries/slf4j-api-2.0.7.jar"/>
12+
<classpathentry kind="lib" path="B:/Projects/Napoleon-x/Workspace/VLCDiscordRPC/libraries/slf4j-simple-2.0.7.jar"/>
1313
<classpathentry kind="output" path="bin"/>
1414
</classpath>
0 Bytes
Binary file not shown.
4.53 KB
Binary file not shown.

readme.md

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,53 @@
22

33
### Table of contents:
44
* [Setup](#setup)
5-
* [Commands](#commands-and-preferances)
5+
* [Showcase](#showcase)
6+
* [Commands](#commands-and-preferences)
7+
* [larp](#why-was-this-even-made)
8+
* [Credits](#credits)
69

710
## Setup
811

9-
Download the jar from the [releases](https://github.com/Napoleon-x/VideoLAN-VLC-Discord-RPC-in-Java/releases/tag/1.0) and place in its own designated folder.
12+
Download the jar from the [Releases](https://github.com/Napoleon-x/VideoLAN-VLC-Discord-RPC-in-Java/releases/tag/1.6) and place in its own designated folder.
1013
Java is required for the next step so make sure you have installed it if not [Click here!](https://www.azul.com/downloads/?package=jdk#zulu)
1114

1215
After making sure the necessary requirements are met, navigate to the folder with the jar file within it.
1316

14-
Open a terminal in the folder and execute this command `java -jar VLCDiscord-RPC-v1.jar --keepTime true` (adjust naming if needed)
17+
Open a terminal in the folder and execute this command `java -jar VLCDiscord-RPC-v1.6.jar` (adjust naming if needed)
1518

1619
First time runs will place an extension in `\AppData\Roaming\vlc` for which you will need to activate each time when running the program (VLC limitations)
1720

1821
If you get a np_metadata_full not found, that is completely normal it means its your first start and you have not ran the extension yet in VLC, just go under view and press the extension name to activate it and then play a song. You should now be able to start the program correctly.
1922

20-
## Commands and preferances
23+
## Commands and Preferences
24+
25+
Here is a list of available commands and preferences for customizing your Rich Presence:
26+
27+
- `--help` : Displays the list of available commands.
28+
- `--keepTime <true/false>` : Keeps the elapsed time in the Rich Presence even when a different song is playing. The time won't be reset when a new song starts.
29+
- `--customCPS <message here>` : Replaces the "Currently playing: (song_name)" from the Rich Presence. Available variables: (playing_status), (song_name), (artist), (metadata_name).
30+
- `--details <message here>` : Adds an extra field in your Rich Presence with a custom message. You can use variables like: (playing_status), (song_name), (artist), (metadata_name).
31+
- `--enableArtwork <true/false>` : Enables or disables the display of thumbnail artwork associated with your file.
32+
- `--disableWarnings <true/false>` : Toggles whether to disable warnings from being printed.
33+
- `--debug <true/false>` : Enables or disables printing of debug messages.
34+
- `--showExtension <true/false>` : Shows or hides the file extension in the name of the media file on the Rich Presence.
35+
- `--hideCPS <true/false>` : Removes or includes the "Currently playing: " prefix from the Rich Presence.
36+
- `--npFullMetadataFile <file-path-to-np_metadata_full.txt>` : Use this if np_metadata_full.txt is not in the default directory on your operating system.
37+
- `--skipPlugincheck <true/false>` : Skips the checking of whether the extension exists or not.
38+
- `--checkActiveVLC <true/false>` : Shuts down the Rich Presence when VLC is deactivated.
39+
40+
Feel free to use these commands to customize your Rich Presence according to your preferences and needs.
41+
42+
## Showcase
2143

22-
### `--help: Displays the list of available commands.`
23-
### `--keepTime <true/false>: Enables or disables keeping the time in the elapsed section of your Rich Presence even when a different song is playing. The time won't be reset when a new song starts.`
24-
### `--details <message here>: Adds an extra field in your Rich Presence with a custom message.`
25-
### `--disableWarnings <true/false>: Toggles whether to disable warnings from being printed.`
26-
### `--debug <true/false>: Enables or disables printing of debug messages.`
27-
### `--showExtension <true/false>: Shows or hides the file extension in the name of the media file on the Rich Presence.`
28-
### `--hideCPS <true/false>: Removes or includes the "Currently playing: " prefix from the Rich Presence.`
29-
### `--npFullMetadataFile <file-path-to-\np_metadata_full.txt> : If you are running an operating system other than Windows or another case scenario in which \AppData\Roaming\vlc\np_metadata_full.txt does not exist in usual directory when running extension on VLC`
30-
### `--skipPlugincheck <true/false> : Skips the checking of whether the extension exists or not`
31-
### `--ignoreActiveVLC <true/false> : Ignores the check for whether VLC is running or not`
3244

33-
Report any bugs to the issues section of this repository and remember that arguments can help.
3445

3546
## Why was this even made?
3647

37-
I got bored and recently had installed VLC and wanted to see if I could make a Discord RPC for it just as a casual thing. After the first 3 hours of researching and the lack of proper documentation I still managed to continue and thought I should release this. Is it perfect? NO this seems even rather impracticle but if you want something simple and easy to use this is ok and you can do what you want with it (except sell it) and have fun playing your ~totally legit~ mp3 files or whatever.
48+
This project was born out of sheer curiosity and boredom. After installing VLC, I realised I hadn't made a java project in a while so I sought out to create a Discord Rich Presence for it as a casual experiment. Despite the initial challenges, including a lack of comprehensive documentation, I inevitably wasted over three hours. Eventually, I finally made something that seemed at the very least good enough to release.
49+
50+
Is this solution flawless? Not by a long shot. It may even seem somewhat impractical. However, if you're seeking a simple and user-friendly option, this might suit your needs. Feel free to tinker and have fun playing your ~totally legit~ mp3 files or whatever – just remember, selling it is off the table. So, go ahead, and flex your mundane music tastes to your discord friends.
3851

3952
### Credits
4053

41-
Huge thanks to the developers of these projects [Now Playing in texts by un-pogaz](https://github.com/un-pogaz/Now-Playing-in-texts) and [Discord IPC](https://github.com/jagrosh/DiscordIPC)
54+
Huge thanks to the developers of these projects [Now Playing in texts by un-pogaz](https://github.com/un-pogaz/Now-Playing-in-texts) and [Discord IPC](https://github.com/jagrosh/DiscordIPC)

0 commit comments

Comments
 (0)