Skip to content

Commit 7fca887

Browse files
authored
more details on how to setup
1 parent 919311f commit 7fca887

1 file changed

Lines changed: 42 additions & 14 deletions

File tree

README.md

Lines changed: 42 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<div align="center">
22
<img src="icon/VLC.UTILS.png" width=150 height=150 alt="VLC.UTILS"/>
33
<h1> VLC.UTILS </h1>
4-
<span> A sleek TUI utility that bridges VLC Media Player with Discord Rich Presence and Last.fm scrobbling. </span> <br/>
4+
<span> A sleek Python Project utility that bridges VLC Media Player with Discord Rich Presence and Last.fm scrobbling. </span> <br/>
55
<span> Available for Windows, macOS and Linux. </span> <br/>
66

77
<img src="https://img.shields.io/badge/Made%20with-Python-3776AB?style=flat-square&logo=python&logoColor=white"/> <br/>
@@ -17,14 +17,52 @@
1717
- **iTunes**: Automatically fetches the Album art from iTunes.
1818
- **Cross-Platform**: Ready to be compiled for Windows, macOS, and Linux.
1919

20+
## Prerequisites
21+
- [VLC Media Player](https://www.videolan.org/vlc/) (bits don't matter, they're countered.)
22+
- [Offical Discord](https://discord.com/download) running the background or [arRPC](https://github.com/OpenAsar/arRPC)
23+
- A [LastFM](https://www.last.fm/) account, with [LastFM API and Secret keys](https://www.last.fm/api/accounts).
24+
2025
## Setup
2126
1. **Settings**:
22-
- Create a config.json in the root folder (see config.json template).
23-
- Enter your VLC password, Discord Application Client ID (Not your UserID), and Last.fm API credentials.
27+
- Create a `config.json` in the root folder.
28+
- Copy this json code:
29+
```json
30+
{
31+
"vlcPassword": "",
32+
"vlcPort": "8080",
33+
"discordID": "1451462308533637212",
34+
35+
"lfmKey": "",
36+
"lfmSecret": "",
37+
"lfmUser": "",
38+
"lfmPass": "",
39+
40+
"refreshRate": 0.5
41+
}
42+
```
43+
- Paste it in the `config.json`.
44+
- Enter your VLC password, and Last.fm API, Secret and credentials.
45+
- Extra notes:
46+
- `discordID` is my application ID! You can change it, but not reccomended.
47+
- `vlcPort` may be different. Please check your port in VLC settings.
48+
- `refreshRate` is set to `0.5` for performance reasons. Lowering it might be too laggy and **will** flicker.
49+
- Why your credidentals?
50+
- How else are we gonna scrobble the songs for you dummy?
51+
- Also, we're open source and we don't take anything from you whatsoever.
2452
2. **Opening the app**:
2553
- Just open the tool and that's it.
2654

2755
## Running the tool
56+
### Download the tool from nightly.link (Reccomended)
57+
1. Download the one that's compatible with your operating system
58+
- Windows: https://nightly.link/daveberrys/VLC.UTILS/workflows/building/main/VLC.UTILS-Windows.zip
59+
- macOS: https://nightly.link/daveberrys/VLC.UTILS/workflows/building/main/VLC.UTILS-MacOS.zip
60+
- Linux: https://nightly.link/daveberrys/VLC.UTILS/workflows/building/main/VLC.UTILS-Linux.zip
61+
2. Create a new folder
62+
3. Move `VLC.UTILS` to the new folder
63+
4. Create the `config.json` and configure the file.
64+
5. Open the tool
65+
2866
### Running the tool from source
2967
1. Make sure you have [Python](https://python.org/) installed.
3068
2. Clone the repository and navigate into it.
@@ -45,15 +83,5 @@
4583
8. Create the `config.json` and configure the file.
4684
9. Open the tool
4785

48-
### Download the tool from nightly.link
49-
1. Download the one that's compatible with your operating system
50-
- Windows: https://nightly.link/daveberrys/VLC.UTILS/workflows/building/main/VLC.UTILS-Windows.zip
51-
- macOS: https://nightly.link/daveberrys/VLC.UTILS/workflows/building/main/VLC.UTILS-MacOS.zip
52-
- Linux: https://nightly.link/daveberrys/VLC.UTILS/workflows/building/main/VLC.UTILS-Linux.zip
53-
2. Create a new folder
54-
3. Move `VLC.UTILS` to the new folder
55-
4. Create the `config.json` and configure the file.
56-
5. Open the tool
57-
58-
> [!CAUTION]
86+
> [!IMPORTANT]
5987
> Some of the code is made by AI (Gemini 3.0 Flash). But I've taken quiz from them and checked the code and everything is fine. Don't worry about your shit being stolen. The reason why I use LLMs is because of two things. ADHD and short-term memory loss. I struggle with trying to remember things and I need the usage of LLM to help me out on giving me quizzes so I remember and I re-learn it again.

0 commit comments

Comments
 (0)