From 98eb0eb047d9a3b6e1d13366f750492e0c612c05 Mon Sep 17 00:00:00 2001 From: bnnm Date: Wed, 29 Jul 2020 19:41:44 +0200 Subject: [PATCH] Update doc --- doc/GENH.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/GENH.md b/doc/GENH.md index 8b980f93..7d0a8cb0 100644 --- a/doc/GENH.md +++ b/doc/GENH.md @@ -1,9 +1,9 @@ -# GENH FORMAT - -GENH is a generic binary header with fixed values, to make unsupported files playable. This binary header is appended to the beginning of a file and file is renamed to .genh, so vgmstream will read the GENH header and play the file with the new info. - -GENH as been mostly superseded by TXTH, as it can do anything that GENH does and more, plus it's cleaner and much simpler to create, so TXTH is the recommended way to make vgmstream play unsupported files. - -If you still want to create files with GENH headers, the easiest way is to use VGMToolBox's GENH creator, that provides a simple Windows interface. - -For programmers looking for a formal definition the place to check would be vgmstream's parser, located in `genh.c` (particularly `parse_genh`), as new features or fixes may be added anytime. +# GENH FORMAT + +GENH is a generic binary header with fixed values, to make unsupported files playable. This binary header is appended to the beginning of a file and file is renamed to .genh, so vgmstream will read the GENH header and play the file with the new info. + +GENH as been mostly superseded by TXTH, as it can do anything that GENH does and more, plus it's cleaner (no need to modify the original data) and much simpler to create, so TXTH is the recommended way to make vgmstream play unsupported files. There is no program to help creating TXTH headers at the moment, but they are just text files with a few lines that should be easy to make by hand (this is explained in *TXTH.md*). + +If you still want to create files with GENH headers, the easiest way is to use VGMToolBox's GENH creator, that provides a simple Windows interface. + +For programmers looking for a formal definition the place to check would be vgmstream's parser, located in `genh.c` (particularly `parse_genh`), as new features or fixes may be added anytime.