Minor doc updates.

This commit is contained in:
Chris Hodges 2023-07-26 09:30:09 +02:00
parent 5d95ed156c
commit 19dd1304ab

View File

@ -1,7 +1,7 @@
# Raspberry Casket # Raspberry Casket
A fast and small open source Pretracker replayer A fast and small open source Pretracker replayer
## Raspberry Casket Player V1.1 (28-Dec-2022) ## Raspberry Casket Player V2.x (26-Jul-2023)
Provided by Chris 'platon42' Hodges <chrisly@platon42.de> Provided by Chris 'platon42' Hodges <chrisly@platon42.de>
@ -21,13 +21,17 @@ song-end detection and precalc progress support.
It took me more than a month and it was not fun. It took me more than a month and it was not fun.
Also: Open source. It's 2022, keeping the code closed is just not Also: Open source. It's 2023, keeping the code closed is just not
part of the demoscene spirit (anymore?), at least for a replayer. part of the demoscene spirit (anymore?), at least for a replayer.
Also note that this is not the final state of the source code. Also note that this is not the final state of the source code.
I could go over many places still and try to rework them. I could go over many places still and try to rework them.
But I wanted the code to be out in public. But I wanted the code to be out in public.
Productions that I know have been using Raspberry Casket so far:
- [Smooth Flowing/Dekadence](https://www.pouet.net/prod.php?which=94347)
### Verification ### Verification
The replayer has been verified on about 60 Pretracker tunes to The replayer has been verified on about 60 Pretracker tunes to
@ -72,7 +76,7 @@ The source needs two common include files to compile (`custom.i` and
This will create the samples, too. This will create the samples, too.
4. After that, regularly call `pre_PlayerTick` with `MyPlayer` in `a0` 4. After that, regularly call `pre_PlayerTick` with `MyPlayer` in `a0`
and optionally the copperlist in a1 if you're using that mode). and optionally the copperlist in `a1` if you're using that mode).
### Size ### Size
@ -84,7 +88,7 @@ The original code compressed with *Blueberry's* Shrinkler goes from
18052 bytes down to 9023 bytes. 18052 bytes down to 9023 bytes.
Raspberry Casket, depending on the features compiled in, is about Raspberry Casket, depending on the features compiled in, is about
6216 bytes and goes down to ~4348 bytes (in isolation). 5992 bytes and goes down to ~4238 bytes (in isolation).
So this means that the optimization is not just "on the outside". So this means that the optimization is not just "on the outside".
@ -127,6 +131,7 @@ solve this problem.
- Optimized some more code paths for Raspberry Casket replayer. - Optimized some more code paths for Raspberry Casket replayer.
- In the wave generator optimized away a table (32 words), replacement code is even smaller! - In the wave generator optimized away a table (32 words), replacement code is even smaller!
- Added Presto player draft. - Added Presto player draft.
- Drop-in replacement code size: 5992 bytes.
### V1.x (unreleased) ### V1.x (unreleased)
- Fixed a bug regarding the copper output mode with looping waves having a loop-offset. - Fixed a bug regarding the copper output mode with looping waves having a loop-offset.
@ -150,4 +155,4 @@ solve this problem.
### V1.0 (26-Dec-22) ### V1.0 (26-Dec-22)
- Initial release. - Initial release.
- Drop-in replacement code size: 6446 bytes. - Drop-in replacement code size: 6446 bytes.