Repository navigation
docs: add a one-page cheat sheet - #280
hansfbaier wants to merge 2 commits into
Conversation
A single A4 page in three columns: the buttons and their combinations, the screen map, saving and rendering, the files that sit beside the binary, all 25 phrase and table commands, the sample instrument screen, and MIDI. It follows the wiki pages, but was checked against the sources, which disagree in four places: - The instrument row labelled "type" is bound to SIP_FILTMIX, so it is the filter mix, not a filter type. SampleInstrument.cpp passes FLT_LOWPASS at both set_filter() call sites, so the low-pass to high-pass morph the wiki describes is not in this code. - The filter Mode values are "original", "bassy" and "scream". - "looper sync" retunes a loop to 16 rows, not 16 bars: the arithmetic is tickSampleCount * 6 * 16. - detune is missing from the wiki's instrument list, and the loop modes are spelled "ping pong" and "looper sync". The keyboard equivalents come from the mapping.xml shipped for DEB, X86, STEAM and X64, which agree with each other: Q and W for the shoulders, the arrow keys for the D-pad, space for Start, and the A and S keys producing B and A respectively. The wiki's "LT is right Ctrl" is not what those files say. build.sh points TEXMFVAR at a directory it creates. The default ~/.texlive/texmf-var is not writable on every machine, and without it pdflatex cannot generate the fonts it needs and stops on the first \normalsize. The PDF is committed so the sheet can be read without a TeX installation.
|
Hey, I like it! |
|
Good catch. It is not built automatically — the PDF is checked in so the package and readers do not need a TeX installation. I will add the checked-in PDF to |
The PDF is checked in, so packaging does not need a TeX installation. Add it to the shared docs block in lgpt_package.sh so every platform zip contains it.
|
Added in b09e0c0: the checked-in PDF is now in the shared docs |
A single A4 page, three columns, meant to be printed or left open next to the
tracker: buttons and their combinations, the screen map, saving and rendering,
the files that sit beside the binary, all 25 phrase and table commands, the
sample instrument screen, and MIDI.
Sources. Written from
docs/wiki/, then checked against the sources, whichdisagree in four places. The sheet follows the code:
typerowSIP_FILTMIX, so it is the filter mix;set_filter()getsFLT_LOWPASSat both call sitesModevaluesoriginal,bassy,screamlooper synctickSampleCount * 6 * 16, so 16 rowspingpongping pong;detuneis also missing from the listI have left the wiki pages alone, since correcting them seemed like a separate
call — happy to fold that in if you would rather it came as one change.
Keyboard equivalents are taken from the
mapping.xmlshipped for DEB, X86,STEAM and X64, which agree with each other: Q and W for the shoulders, the
arrow keys for the D-pad, space for Start, and the A and S keys producing B and
A respectively. The wiki's "LT is right Ctrl, RT is left Ctrl" is not what those
files say, so the sheet follows the files.
Building.
build.shcreates a directory and pointsTEXMFVARat it. Thedefault
~/.texlive/texmf-varis not writable everywhere, and without awritable one pdflatex cannot generate the fonts it needs and stops on the first
\normalsize. It uses pdflatex rather than lualatex/xelatex because a TeX Livewithout the Latin Modern OpenType fonts cannot load fontspec's default face;
the encoding stays at OT1 for the same reason. The PDF is committed so the
sheet can be read without a TeX installation, and
.gitignorekeeps theby-products out.
Independent of #279 — the sheet is deliberately written against master and
carries no platform-specific remarks.