shithub: ft2play

Info  •  Files  •  Log  •  Branches

Update README.md

--- a/README.md

+++ b/README.md

@@ -4,13 +4,12 @@

 # Notes

 - To compile ft2play (the test program) on macOS/Linux, you need SDL2

-- The replayer is the same in FT2.08 and FT2.09 (though the GUS routines differ in FT2.09)

-- This is <i>not</i> the same replayer/mixer code used in the FT2 clone (the FT2 clone also uses a port, but it has some audio fidelity improvements)

+- This is <i>not</i> the same replayer/mixer code used in the FT2 clone (the FT2 clone also uses a port, but it has some audio precision improvements)

 - The accuracy has only been compared against a few songs

 - The code may not be 100% safe to use as a replayer in other projects, and as such I recommend to use this only for reference

 # How to test accuracy

-1) Open FT2.08 or FT2.09 (use a fresh program start for every render) and load a song. Make sure "16-bit mixing", "Stereo" and "Interpolation" is enabled in the config screen.

-2) Save as WAV (freq=44100Hz, amp=4)

+1) Open FT2.08 or FT2.09 (use a fresh program start for every render) and load a song. Make sure "16-bit mixing", "Stereo" and "Interpolation" are enabled in the config screen

+2) Save as WAV (Freq. = 44100, Amp. = 4)

 3) Render the same song to WAV using ft2play (f.ex. "ft2play mysong.xm --render-to-wav")

-4) Use a program capable of verifying the binary integrity between the two output files. If they differ, you found a problem and should create a new issue for this project on github. :)

+4) Use a program capable of verifying the binary integrity between the two output files. If they differ, you found a problem and should create a new issue for this project on GitHub :)