From 2fcc3d69e4a5ae22e32be98f069b33a8731c2388 Mon Sep 17 00:00:00 2001 From: bnnm Date: Fri, 23 Jul 2021 19:21:58 +0200 Subject: [PATCH] Doc --- doc/TXTP.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/doc/TXTP.md b/doc/TXTP.md index 66827939..bf09bd9c 100644 --- a/doc/TXTP.md +++ b/doc/TXTP.md @@ -2,7 +2,30 @@ TXTP is a text file with commands, to improve support for games using audio in certain uncommon or undesirable ways. It's in the form of a mini-playlist or a wrapper with play settings, meant to do post-processing over playable files. -Simply create a file named `(filename).txtp`, and inside write the commands described below. +Simply create a file named `(filename).txtp`, and inside write the song name and commands described below. Then open the new file directly and vgmstream should play it. + +Common case examples: + +**stage01-intro+loop.txtp** +``` +stage01_intro.vag +stage01_loop.vag +``` + +**bgm01-subsong2.txtp** +``` +bgm01.fsb #2 +``` + +**sfx01-22khz.txtp** +``` +sfx01.wav #h22050 +``` + +**field-remove-first-channels.txtp** +``` +field.bfstm #C3,4 +``` ## TXTP MODES