|
3 | 3 | [](https://www.codacy.com/manual/devgianlu/librespot-java?utm_source=github.com&utm_medium=referral&utm_content=librespot-org/librespot-java&utm_campaign=Badge_Grade) |
4 | 4 | [](https://maven-badges.herokuapp.com/maven-central/xyz.gianlu.librespot/librespot-java) |
5 | 5 |
|
6 | | -`librespot-java` is a port of [librespot](https://github.com/librespot-org/librespot), originally written in Rust, which as evolved into the most up-to-date open-source Spotify client. Additionally, this implementation provides an useful API to request metadata or control the player, more [here](https://github.com/librespot-org/librespot-java/blob/master/api). |
| 6 | +`librespot-java` is a port of [librespot](https://github.com/librespot-org/librespot), originally written in Rust, which has evolved into the most up-to-date open-source Spotify client. Additionally, this implementation provides a useful API to request metadata or control the player, more [here](api). |
7 | 7 |
|
8 | 8 | ## Disclaimer! |
9 | 9 | We (the librespot-org organization and me) **DO NOT** encourage piracy and **DO NOT** support any form of downloader/recorder designed with the help of this repository. If you're brave enough to put at risk this entire project, just don't publish it. This is meant to provide support for all those devices that are not officially supported by Spotify. |
@@ -43,24 +43,25 @@ This is more advanced and should only be used if you saved an authentication blo |
43 | 43 | You can download the latest release from [here](https://github.com/librespot-org/librespot-java/releases) and then run `java -jar ./librespot-core-jar-with-dependencies.jar` from the command line. |
44 | 44 |
|
45 | 45 | ### Audio output configuration |
46 | | -On some system, many mixers could be installed making librespot-java playback on the wrong one, therefore you won't hear anything and likely see an exception in the logs. If that's the case, follow the guide below: |
| 46 | +On some systems, many mixers could be installed making librespot-java playback on the wrong one, therefore you won't hear anything and likely see an exception in the logs. If that's the case, follow the guide below: |
47 | 47 |
|
48 | 48 | 1) In your configuration file (`config.toml` by default), under the `player` section, make sure `logAvailableMixers` is set to `true` and restart the application |
49 | 49 | 2) Connect to the client and start playing something |
50 | 50 | 3) Along with the previous exception there'll be a log message saying "Available mixers: ..." |
51 | | -4) Pick the right mixer and copy it's name inside the `mixerSearchKeywords` option. If you need to specify more search keywords, you can separate them with a semicolon |
| 51 | +4) Pick the right mixer and copy its name inside the `mixerSearchKeywords` option. If you need to specify more search keywords, you can separate them with a semicolon |
52 | 52 | 5) Restart and enjoy |
53 | 53 |
|
54 | 54 | ## Build it |
55 | 55 | This project uses [Maven](https://maven.apache.org/), after installing it you can compile with `mvn clean package` in the project root, if the compilation succeeds you'll be pleased with a JAR executable in `core/target`. |
56 | 56 | To run the newly build jar run `java -jar ./core/target/librespot-core-jar-with-dependencies.jar`. |
57 | 57 |
|
58 | 58 | ## Protobuf generation |
59 | | -The compiled Java protobuf definitions aren't versioned, therefore, if you want to open the project inside you're IDE, you'll need to run `mvn compile` first to ensure that all the necessary files are created. |
60 | | -The `com.spotify` package is reserved for the generated files. |
| 59 | +The compiled Java protobuf definitions aren't versioned, therefore, if you want to open the project inside your IDE, you'll need to run `mvn compile` first to ensure that all the necessary files are created. If the build fails due to missing `protoc` you can install it manually and use the `-DprotocExecutable=/path/to/protoc` flag. |
| 60 | + |
| 61 | +The `com.spotify` package is reserved for the generated files. |
61 | 62 |
|
62 | 63 | ## Logging |
63 | | -The application uses Log4J for logging purposes, the configuration file is placed inside `core/src/main/resources` or `api/src/main/resources` depending on what you're working with. |
| 64 | +The application uses Log4J for logging purposes, the configuration file is placed inside `core/src/main/resources` or `api/src/main/resources` depending on what you're working with. You can also toggle the log level with `logLevel` option in the configuration. |
64 | 65 |
|
65 | 66 | ## Related Projects |
66 | 67 | - [librespot](https://github.com/librespot-org/librespot) |
|
0 commit comments