Skip to content

Commit

Permalink
Some more small changes
Browse files Browse the repository at this point in the history
  • Loading branch information
stijnfrishert authored Apr 18, 2020
1 parent 1840463 commit ad6c52f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# liblsdj
# LibLSDJ

[Little Sound DJ](http://littlesounddj.com) is a wonderful tool that transforms your old gameboy into a music making machine. It has a thriving community of users that pushes their old hardware to its limits, in pursuit of new musical endeavours. It can however be cumbersome to manage songs and sounds outside of the gameboy.

In this light *LibLSDJ* was developed, a cross-platform and fast C utility library for interacting with the LSDJ save format (.sav), song files (.lsdsng) and more. The end goal is to deliver *LibLSDJ* with a suite of tools for working with everything LSDJ. Currently four such tools are included: *lsdsng-export*, *lsdsng-import*, *lsdj-mono* and *lsdj-wavetable-import*, and requests for other useful tools are very much welcomed.

The core library of *LibLSDJ* was rewritten in v2.0.0 to be future-proof against changes in *LSDJ*. This means that the export and import tools should never corrupt your songs, even when *LSDJ* itself adds new features after the latest *LibLSDJ* update (until the compression algorithm itself changes). Functions for tooling purposes do need to be added, but that is only a small task.

*LibLSDJ* comes with a test suite to guarantee it works with real-life save files. Whenever a new bug is found, a test is added to this suite to ensure we never run into it again.
I'm also proud to say that TommityTom's [RetroPlug](https://github.com/tommitytom/RetroPlug) is built on *LibLSDJ* for its save file management. If you're using the tools or the library yourself, let me know, I'm curious to hear who depends on this. :)

The library and tools are open source and freely available to anyone. If you'd like to show your appreciation, please consider buying one of my [albums](https://4ntler.bandcamp.com) or donate money through [PayPal](https://paypal.me/4ntler).

Expand Down

0 comments on commit ad6c52f

Please sign in to comment.