mirror of
https://github.com/gbdev/rgbds.git
synced 2025-11-20 18:22:07 +00:00
1a5c423984
With permission from the main authors [1], most of the code has been relicensed under the MIT license. SPDX license identifiers are used so that the license headers in source code files aren't too large. Add CONTRIBUTORS.rst file. [1] https://github.com/rednex/rgbds/issues/128 Signed-off-by: Antonio Niño Díaz <antonio_nd@outlook.com>
154 lines
7.5 KiB
HTML
154 lines
7.5 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8"/>
|
|
<style>
|
|
table.head, table.foot { width: 100%; }
|
|
td.head-rtitle, td.foot-os { text-align: right; }
|
|
td.head-vol { text-align: center; }
|
|
div.Pp { margin: 1ex 0ex; }
|
|
</style>
|
|
<link rel="stylesheet" href="manual.css" type="text/css" media="all"/>
|
|
<title>RGBGFX(1)</title>
|
|
</head>
|
|
<body>
|
|
<table class="head">
|
|
<tr>
|
|
<td class="head-ltitle">RGBGFX(1)</td>
|
|
<td class="head-vol">General Commands Manual</td>
|
|
<td class="head-rtitle">RGBGFX(1)</td>
|
|
</tr>
|
|
</table>
|
|
<div class="manual-text">
|
|
<h1 class="Sh" title="Sh" id="NAME"><a class="selflink" href="#NAME">NAME</a></h1>
|
|
<b class="Nm" title="Nm">rgbgfx</b> — <span class="Nd" title="Nd">Game
|
|
Boy graphics converter</span>
|
|
<h1 class="Sh" title="Sh" id="SYNOPSIS"><a class="selflink" href="#SYNOPSIS">SYNOPSIS</a></h1>
|
|
<table class="Nm">
|
|
<tr>
|
|
<td><b class="Nm" title="Nm">rgbgfx</b></td>
|
|
<td>[<span class="Op"><b class="Fl" title="Fl">-DfFhPTVv</b></span>]
|
|
[<span class="Op"><b class="Fl" title="Fl">-o</b>
|
|
<var class="Ar" title="Ar">outfile</var></span>]
|
|
[<span class="Op"><b class="Fl" title="Fl">-d</b>
|
|
<var class="Ar" title="Ar">depth</var></span>]
|
|
[<span class="Op"><b class="Fl" title="Fl">-p</b>
|
|
<var class="Ar" title="Ar">palfile</var></span>]
|
|
[<span class="Op"><b class="Fl" title="Fl">-t</b>
|
|
<var class="Ar" title="Ar">mapfile</var></span>]
|
|
[<span class="Op"><b class="Fl" title="Fl">-x</b>
|
|
<var class="Ar" title="Ar">tiles</var></span>]
|
|
<var class="Ar" title="Ar">file</var></td>
|
|
</tr>
|
|
</table>
|
|
<h1 class="Sh" title="Sh" id="DESCRIPTION"><a class="selflink" href="#DESCRIPTION">DESCRIPTION</a></h1>
|
|
The <b class="Nm" title="Nm">rgbgfx</b> program converts PNG images into the
|
|
Nintendo Game Boy's planar tile format. The arguments are as follows:
|
|
<dl class="Bl-tag">
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#D"><b class="Fl" title="Fl" id="D">-D</b></a></dt>
|
|
<dd class="It-tag">Debug features are enabled.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#f"><b class="Fl" title="Fl" id="f">-f</b></a></dt>
|
|
<dd class="It-tag">Fix the input PNG file to be a correctly indexed
|
|
image.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#F"><b class="Fl" title="Fl" id="F">-F</b></a></dt>
|
|
<dd class="It-tag">Same as <b class="Fl" title="Fl">-f</b>, but additionally,
|
|
the input PNG file is fixed to have its parameters match the command
|
|
line's parameters.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#d"><b class="Fl" title="Fl" id="d">-d</b></a>
|
|
<var class="Ar" title="Ar">depth</var></dt>
|
|
<dd class="It-tag">The bitdepth of the output image (either 1 or 2). By
|
|
default, the bitdepth is 2 (two bits per pixel).</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#h"><b class="Fl" title="Fl" id="h">-h</b></a></dt>
|
|
<dd class="It-tag">Lay out tiles horizontally rather than vertically.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#o"><b class="Fl" title="Fl" id="o">-o</b></a>
|
|
<var class="Ar" title="Ar">outfile</var></dt>
|
|
<dd class="It-tag">The name of the output file.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#p"><b class="Fl" title="Fl" id="p">-p</b></a>
|
|
<var class="Ar" title="Ar">palfile</var></dt>
|
|
<dd class="It-tag">Raw bytes (8 bytes for two bits per pixel, 4 bytes for one
|
|
bit per pixel) containing the RGB15 values in the little-endian byte order
|
|
and then ordered from lightest to darkest.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#P"><b class="Fl" title="Fl" id="P">-P</b></a></dt>
|
|
<dd class="It-tag">Same as <b class="Fl" title="Fl">-p</b>, but the pallete
|
|
file output name is made by taking the input filename, removing the file
|
|
extension, and appending <i class="Pa" title="Pa">.pal</i>.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#t"><b class="Fl" title="Fl" id="t">-t</b></a>
|
|
<var class="Ar" title="Ar">mapfile</var></dt>
|
|
<dd class="It-tag">If any tiles are the same, don't place the repeat tiles in
|
|
the output file, and make a tilemap file.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#T"><b class="Fl" title="Fl" id="T">-T</b></a></dt>
|
|
<dd class="It-tag">Same as <b class="Fl" title="Fl">-t</b>, but the tilemap
|
|
file output name is made by taking the input filename, removing the file
|
|
extension, and appending <i class="Pa" title="Pa">.tilemap</i>.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#u"><b class="Fl" title="Fl" id="u">-u</b></a></dt>
|
|
<dd class="It-tag">Truncate repeated tiles. Useful with tilemaps.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#V"><b class="Fl" title="Fl" id="V">-V</b></a></dt>
|
|
<dd class="It-tag">Print the version of the program and exit.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#v"><b class="Fl" title="Fl" id="v">-v</b></a></dt>
|
|
<dd class="It-tag">Verbose. Print errors when the command line parameters and
|
|
the parameters in the PNG file don't match.</dd>
|
|
<dt class="It-tag"> </dt>
|
|
<dd class="It-tag"> </dd>
|
|
<dt class="It-tag"><a class="selflink" href="#x"><b class="Fl" title="Fl" id="x">-x</b></a>
|
|
<var class="Ar" title="Ar">tiles</var></dt>
|
|
<dd class="It-tag">Trim the end of the output file by this many tiles.</dd>
|
|
</dl>
|
|
<h1 class="Sh" title="Sh" id="EXAMPLES"><a class="selflink" href="#EXAMPLES">EXAMPLES</a></h1>
|
|
The following will take a PNG file with a bitdepth of 1, 2, or 8, and output
|
|
planar 2bpp data:
|
|
<div class="Pp"></div>
|
|
<div class="D1">$ rgbgfx -o out.2bpp in.png</div>
|
|
<div class="Pp"></div>
|
|
The following creates a planar 2bpp file with only unique tiles, and its tilemap
|
|
<i class="Pa" title="Pa">out.tilemap</i>:
|
|
<div class="Pp"></div>
|
|
<div class="D1">$ rgbgfx -T -u -o out.2bpp in.png</div>
|
|
<div class="Pp"></div>
|
|
The following will do nothing:
|
|
<div class="Pp"></div>
|
|
<div class="D1">$ rgbgfx in.png</div>
|
|
<h1 class="Sh" title="Sh" id="SEE_ALSO"><a class="selflink" href="#SEE_ALSO">SEE
|
|
ALSO</a></h1>
|
|
<a class="Xr" title="Xr">rgbds(7)</a>, <a class="Xr" title="Xr">rgbasm(1)</a>,
|
|
<a class="Xr" title="Xr">rgblink(1)</a>,
|
|
<a class="Xr" title="Xr">rgbfix(1)</a>, <a class="Xr" title="Xr">gbz80(7)</a>
|
|
<h1 class="Sh" title="Sh" id="HISTORY"><a class="selflink" href="#HISTORY">HISTORY</a></h1>
|
|
<b class="Nm" title="Nm">rgbgfx</b> was created by
|
|
<span class="An" title="An">stag019</span> to be included in RGBDS. It is now
|
|
maintained by a number of contributors at
|
|
<a class="Lk" title="Lk" href="https://github.com/rednex/rgbds">https://github.com/rednex/rgbds</a>.</div>
|
|
<table class="foot">
|
|
<tr>
|
|
<td class="foot-date">January 26, 2018</td>
|
|
<td class="foot-os">RGBDS Manual</td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|