Skip to content

Commit

Permalink
docs: add workaround for key extraction of the RBv6 database to README (
Browse files Browse the repository at this point in the history
  • Loading branch information
dylanljones committed Aug 7, 2023
1 parent e93afac commit fba8ebc
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ Pioneer's Rekordbox DJ Software. It currently supports
Tested Rekordbox versions: ``5.8.6 | 6.5.3``

Starting from version ``6.6.5`` Pioneer obfuscated the ``app.asar`` file contents, breaking the key extraction
(see [this issue](https://github.com/dylanljones/pyrekordbox/issues/64) for more details).
(see [this issue](https://github.com/dylanljones/pyrekordbox/issues/64) and the
Rekordbox 6 database section below for more details).

> **Note**: This project is **not** affiliated with Pioneer Corp. or its related companies
in any way and has been written independently! Pyrekordbox is licensed under the
Expand Down Expand Up @@ -223,6 +224,20 @@ could corrupt the library. This feature will be added after some testing.
Changing existing entries like the title, artist or file path of a track in the database
should work as expected.


If you are using Rekorbox v6.6.5 or later and have no cached key from a previous
Rekordbox version, the database can not be unlocked automatically.
In this case you have to provide the key manually until a patch fixing this issue is released:
````python
from pyrekordbox import Rekordbox6Database

db = Rekordbox6Database(key="<insert key here>")
````

The key can be found in some other projects, see issue
[#77](https://github.com/dylanljones/pyrekordbox/issues/77).


## 💡 File formats

A summary of the Rekordbox file formats can be found in the [documentation]:
Expand Down

0 comments on commit fba8ebc

Please sign in to comment.