docs_links_and_tools.html (12754B)
1<!-- HTML header for doxygen 1.8.14--> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml"> 4<head> 5<meta http-equiv="cache-control" content="max-age=86400"/> 6<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 7<meta http-equiv="X-UA-Compatible" content="IE=9"/> 8<meta name="generator" content="Doxygen 1.8.20"/> 9<meta name="viewport" content="width=device-width, initial-scale=1"/> 10<title>GBDK 2020 Docs: Links and Third-Party Tools</title> 11<link href="tabs.css" rel="stylesheet" type="text/css"/> 12<script type="text/javascript" src="jquery.js"></script> 13<script type="text/javascript" src="dynsections.js"></script> 14<link href="navtree.css" rel="stylesheet" type="text/css"/> 15<script type="text/javascript" src="resize.js"></script> 16<script type="text/javascript" src="navtreedata.js"></script> 17<script type="text/javascript" src="navtree.js"></script> 18<link href="search/search.css" rel="stylesheet" type="text/css"/> 19<script type="text/javascript" src="search/searchdata.js"></script> 20<script type="text/javascript" src="search/search.js"></script> 21<link href="doxygen.css" rel="stylesheet" type="text/css" /> 22<link href="doxygen_extra.css" rel="stylesheet" type="text/css"/> 23</head> 24<body> 25<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 26<div id="titlearea"> 27<table cellspacing="0" cellpadding="0"> 28 <tbody> 29 <tr style="height: 56px;"> 30 <td id="projectalign" style="padding-left: 0.5em;"> 31 <div id="projectname">GBDK 2020 Docs 32  <span id="projectnumber">4.0.6</span> 33 </div> 34 <div id="projectbrief">API Documentation for GBDK 2020</div> 35 </td> 36 </tr> 37 </tbody> 38</table> 39</div> 40<!-- end header part --> 41<!-- Generated by Doxygen 1.8.20 --> 42<script type="text/javascript"> 43/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 44var searchBox = new SearchBox("searchBox", "search",false,'Search'); 45/* @license-end */ 46</script> 47<script type="text/javascript" src="menudata.js"></script> 48<script type="text/javascript" src="menu.js"></script> 49<script type="text/javascript"> 50/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 51$(function() { 52 initMenu('',true,false,'search.php','Search'); 53 $(document).ready(function() { init_search(); }); 54}); 55/* @license-end */</script> 56<div id="main-nav"></div> 57</div><!-- top --> 58<div id="side-nav" class="ui-resizable side-nav-resizable"> 59 <div id="nav-tree"> 60 <div id="nav-tree-contents"> 61 <div id="nav-sync" class="sync"></div> 62 </div> 63 </div> 64 <div id="splitbar" style="-moz-user-select:none;" 65 class="ui-resizable-handle"> 66 </div> 67</div> 68<script type="text/javascript"> 69/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 70$(document).ready(function(){initNavTree('docs_links_and_tools.html',''); initResizable(); }); 71/* @license-end */ 72</script> 73<div id="doc-content"> 74<!-- window showing the filter options --> 75<div id="MSearchSelectWindow" 76 onmouseover="return searchBox.OnSearchSelectShow()" 77 onmouseout="return searchBox.OnSearchSelectHide()" 78 onkeydown="return searchBox.OnSearchSelectKey(event)"> 79</div> 80 81<!-- iframe showing the search results (closed by default) --> 82<div id="MSearchResultsWindow"> 83<iframe src="javascript:void(0)" frameborder="0" 84 name="MSearchResults" id="MSearchResults"> 85</iframe> 86</div> 87 88<div class="PageDoc"><div class="header"> 89 <div class="headertitle"> 90<div class="title">Links and Third-Party Tools </div> </div> 91</div><!--header--> 92<div class="contents"> 93<div class="textblock"><p>This is a brief list of useful tools and information. It is not meant to be complete or exhaustive, for a larger list see the <a class="el" href="docs_links_and_tools.html#awesome_gb">Awesome Game Boy Development</a> list.</p> 94<p><a class="anchor" id="links_sdcc_docs"></a></p> 95<h1><a class="anchor" id="autotoc_md29"></a> 96SDCC Compiler Suite User Manual</h1> 97<ul> 98<li>GBDK-2020 uses the SDCC compiler and related tools. The SDCC manual goes into much more detail about available features and how to use them. <br /> 99 <a href="http://sdcc.sourceforge.net/doc/sdccman.pdf">http://sdcc.sourceforge.net/doc/sdccman.pdf</a> <br /> 100 <a href="http://sdcc.sourceforge.net">http://sdcc.sourceforge.net</a></li> 101</ul> 102<p><a class="anchor" id="links_help_and_community"></a></p> 103<h1><a class="anchor" id="autotoc_md30"></a> 104Getting Help</h1> 105<ul> 106<li>GBDK Discord community: <br /> 107 <a href="https://github.com/gbdk-2020/gbdk-2020/#discord-servers">https://github.com/gbdk-2020/gbdk-2020/#discord-servers</a></li> 108<li>Game Boy discussion forum: <br /> 109 <a href="https://gbdev.gg8.se/forums/">https://gbdev.gg8.se/forums/</a></li> 110</ul> 111<p><a class="anchor" id="links_gameboy_docs"></a></p> 112<h1><a class="anchor" id="autotoc_md31"></a> 113Game Boy Documentation</h1> 114<ul> 115<li><a class="anchor" id="Pandocs"></a> <b>Pandocs</b> <br /> 116 Extensive and up-to-date technical documentation about the Game Boy and related hardware. <br /> 117 <a href="https://gbdev.io/pandocs/">https://gbdev.io/pandocs/</a></li> 118<li><a class="anchor" id="awesome_gb"></a> <b>Awesome Game Boy Development list</b> <br /> 119 A list of Game Boy/Color development resources, tools, docs, related projects and homebrew. <br /> 120 <a href="https://gbdev.io/list.html">https://gbdev.io/list.html</a></li> 121</ul> 122<p><a class="anchor" id="links_sms_gg_docs"></a></p> 123<h1><a class="anchor" id="autotoc_md32"></a> 124Sega Master System / Game Gear Documentation</h1> 125<ul> 126<li><a class="anchor" id="smspower"></a> <b>SMS Power!</b> <br /> 127 Community site with technical documentation, reviews and other content related to the Sega 8-bit systems. <a href="https://www.smspower.org/">https://www.smspower.org/</a></li> 128</ul> 129<p><a class="anchor" id="links_gbdk_tutorials"></a></p> 130<h1><a class="anchor" id="autotoc_md33"></a> 131Tutorials</h1> 132<ul> 133<li><a class="anchor" id="tutorials_larolds"></a> <b>Larold's Jubilant Junkyard Tutorials</b> <br /> 134 Several walk throughs about the fundamentals of developing for the Game Boy with GBDK-2020. There are simple examples with source code. <a href="https://laroldsjubilantjunkyard.com/tutorials/">https://laroldsjubilantjunkyard.com/tutorials/</a></li> 135<li><a class="anchor" id="tutorials_gamingmonsters"></a> <b>Gaming Monsters Tutorials</b> <br /> 136 Several video tutorials and code for making games with GBDK/GBDK-2020. <br /> 137 <a href="https://www.youtube.com/playlist?list=PLeEj4c2zF7PaFv5MPYhNAkBGrkx4iPGJo">https://www.youtube.com/playlist?list=PLeEj4c2zF7PaFv5MPYhNAkBGrkx4iPGJo</a> <br /> 138 <a href="https://github.com/gingemonster/GamingMonstersGameBoySampleCode">https://github.com/gingemonster/GamingMonstersGameBoySampleCode</a></li> 139<li><a class="anchor" id="tutorials_typorter"></a> <b>Pocket Leage Tutortial</b> <br /> 140 <a href="https://blog.ty-porter.dev/development/2021/04/04/writing-a-gameboy-game-in-2021-pt-0.html">https://blog.ty-porter.dev/development/2021/04/04/writing-a-gameboy-game-in-2021-pt-0.html</a></li> 141</ul> 142<p><a class="anchor" id="link_examples"></a></p> 143<h1><a class="anchor" id="autotoc_md34"></a> 144Example code</h1> 145<ul> 146<li><a class="anchor" id="examples_gbdk_playground"></a> <b>Simplified GBDK examples</b> <br /> 147 <a href="https://github.com/mrombout/gbdk_playground/commits/master">https://github.com/mrombout/gbdk_playground/commits/master</a></li> 148</ul> 149<p><a class="anchor" id="links_graphic"></a></p> 150<h1><a class="anchor" id="autotoc_md35"></a> 151Graphics Tools</h1> 152<ul> 153<li><a class="anchor" id="gbtd_gbmb"></a><a class="anchor" id="gbmb"></a><a class="anchor" id="gbtd"></a> <br /> 154 <a class="anchor" id="toxa_gbtd_gbmb"></a> <b>Game Boy Tile Designer and Map Builder (GBTD / GBMB)</b> <br /> 155 Sprite / Tile editor and Map Builder that can export to C that works with GBDK. <br /> 156 This is an updated version with const export fixed and other improvments. <br /> 157 <a href="https://github.com/gbdk-2020/GBTD_GBMB">https://github.com/gbdk-2020/GBTD_GBMB</a><ul> 158<li>A GIMP plugin to read/write GBR/GBM files and do map conversion: <br /> 159 <a href="https://github.com/bbbbbr/gimp-tilemap-gb">https://github.com/bbbbbr/gimp-tilemap-gb</a></li> 160<li>Command line version of the above tool that doesn't require GIMP (png2gbtiles): <br /> 161 <a href="https://github.com/bbbbbr/gimp-tilemap-gb/tree/master/console">https://github.com/bbbbbr/gimp-tilemap-gb/tree/master/console</a></li> 162</ul> 163</li> 164<li><a class="anchor" id="Tilemap_Studio"></a> <b>Tilemap Studio</b> <br /> 165 A tilemap editor for Game Boy, GBC, GBA, or SNES projects. <br /> 166 <a href="https://github.com/Rangi42/tilemap-studio/">https://github.com/Rangi42/tilemap-studio/</a></li> 167</ul> 168<p><a class="anchor" id="tools_music"></a></p> 169<h1><a class="anchor" id="autotoc_md36"></a> 170Music drivers and tools</h1> 171<ul> 172<li><a class="anchor" id="gbt-player"></a> <b>GBT Player</b> <br /> 173 A .mod converter and music driver that works with GBDK and RGBDS. <br /> 174 <a href="https://github.com/AntonioND/gbt-player">https://github.com/AntonioND/gbt-player</a> <br /> 175 Docs from GBStudio that should mostly apply: <a href="https://www.gbstudio.dev/docs/music/">https://www.gbstudio.dev/docs/music/</a></li> 176<li><a class="anchor" id="hUGEdriver"></a> <b>hUGEtracker</b> and <b>hUGEdriver</b> <br /> 177 A tracker and music driver that work with GBDK and RGBDS. It is smaller, more efficient and more versatile than gbt_player. <br /> 178 <a href="https://github.com/untoxa/hUGEBuild">https://github.com/untoxa/hUGEBuild</a> <br /> 179 <a href="https://github.com/SuperDisk/hUGEDriver">https://github.com/SuperDisk/hUGEDriver</a> <br /> 180 <a href="https://github.com/SuperDisk/hUGETracker">https://github.com/SuperDisk/hUGETracker</a></li> 181</ul> 182<p><a class="anchor" id="tools_emulators"></a></p> 183<h1><a class="anchor" id="autotoc_md37"></a> 184Emulators</h1> 185<ul> 186<li><a class="anchor" id="bgb"></a> <b>BGB</b> <br /> 187 Accurate emulator, has useful debugging tools. <br /> 188 <a href="http://bgb.bircd.org/">http://bgb.bircd.org/</a></li> 189<li><a class="anchor" id="emulicious"></a> <b>Emulicious</b> <br /> 190 An accurate emulator with extensive tools including source level debugging. <br /> 191 <a href="https://emulicious.net/">https://emulicious.net/</a></li> 192</ul> 193<p><a class="anchor" id="tools_debug"></a></p> 194<h1><a class="anchor" id="autotoc_md38"></a> 195Debugging tools</h1> 196<ul> 197<li><a class="anchor" id="Emulicious_debug"></a> <b>Emulicious debug adapter</b> <br /> 198 Provides source-level debugging in VS Code that works with GBDK2020. <br /> 199 <a href="https://marketplace.visualstudio.com/items?itemName=emulicious.emulicious-debugger">https://marketplace.visualstudio.com/items?itemName=emulicious.emulicious-debugger</a></li> 200<li><a class="anchor" id="romusage"></a> <b>romusage</b> <br /> 201 Calculate used and free space in banks (ROM/RAM) and warn about errors such as bank overflows. <br /> 202 <a href="https://github.com/bbbbbr/romusage">https://github.com/bbbbbr/romusage</a></li> 203<li><a class="anchor" id="bgb_symbol_conversion"></a> <b>noi file to sym conversion for bgb</b> <br /> 204 Debug information in .noi files can be converted to a symbol format that <a class="el" href="docs_links_and_tools.html#bgb">BGB</a> recognizes using:<ul> 205<li><a class="el" href="docs_toolchain.html#lcc">lcc</a> : <code>-Wm-yS</code> (with <code>--debug</code>, or <code>-Wl-j</code> to create the .noi)</li> 206<li>directly with <a class="el" href="docs_toolchain.html#makebin">makebin</a> : <code>-yS</code> (with <code>-j</code> passed to the linker)</li> 207</ul> 208</li> 209<li><a class="anchor" id="src2sym"></a> <b>src2sym.pl</b> <br /> 210 Add line-by-line C source code to the main symbol file in a BGB compatible format. This allows for C source-like debugging in BGB in a limited way. <a href="https://gbdev.gg8.se/forums/viewtopic.php?id=710">https://gbdev.gg8.se/forums/viewtopic.php?id=710</a></li> 211</ul> 212<p><a class="anchor" id="tools_build_ci_cd"></a></p> 213<h1><a class="anchor" id="autotoc_md39"></a> 214Continuous Integration and Deployment</h1> 215<ul> 216<li><a class="anchor" id="GBDK_GitHub_Action_Builder"></a> <b>GBDK GitHub Action Builder</b> A Github Action which provides basic CI/CD for building projects based on GBDK (not for building GBDK itself). <br /> 217 <a href="https://github.com/wujood/gbdk-2020-github-builder">https://github.com/wujood/gbdk-2020-github-builder</a> </li> 218</ul> 219</div></div><!-- contents --> 220</div><!-- PageDoc --> 221</div><!-- doc-content --> 222<!-- HTML footer for doxygen 1.8.14--> 223<!-- start footer part --> 224<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> 225</div> 226</body> 227</html>