v1.0 TODO

[Bentroen]

With nbswave already being shipped with major, consumer-oriented tools, such as NBSTool and even Note Block Studio itself, it would be wise to think about dropping the ZeroVer versioning scheme and aiming towards a 1.0 release.

This issue aims to compile some features that would be nice to work on before we reach API stability. Not all of them may strictly be present in 1.0.0, but this list should help prioritize the most important ones:

Tasks

Preview Give feedback

1. Regression bug for 0.4.0: IndexError: list index out of range #7
   +0
2. Don't load all default instruments if they're not used
3. Most of the logic in the nbs module is unnecessary and best fitted to pynbs. Consider cleaning that up and moving things around
4. Add CLI interface for converting songs
5. Replace print() calls with proper logging
6. Implement mix_layers() interface
7. Implement looping and fade out parameters + song slicing
8. Remove unused parameters from method signatures (such as bitrate)
9. Fix typing errors; convert typing syntax to Python 3.10+ (drop support to 3.8-3.9)
10. Implement basic limiter as an option for avoiding clipping instead of normalizing the signal [article] [SO answer]
11. Explore using Pedalboard library for limiter + audio effects (maybe resampling and loading files too?)
12. Work on better documentation on the internals
13. Distribution does not include the vanilla note block sounds. Either include them in the distribution (make sure to include it as an external resource), add the option to download sounds from Mojang, and/or use the NBS default 'Sounds' folder install location as a sensible default (some groundwork has been done here: Bentroen/MinecraftAssets)