mirror of
https://github.com/gbdk-2020/gbdk-2020.git
synced 2026-03-03 14:05:53 +01:00
157 lines
8.5 KiB
HTML
157 lines
8.5 KiB
HTML
<!-- HTML header for doxygen 1.8.14-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="cache-control" content="max-age=86400"/>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.20"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>GBDK 2020 Docs: Getting Started</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="doxygen_extra.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">GBDK 2020 Docs
|
|
</div>
|
|
<div id="projectbrief">API Documentation for GBDK 2020</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.20 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('docs_getting_started.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="PageDoc"><div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Getting Started </div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><p>Follow the steps in this section to start using GBDK-2020.</p>
|
|
<h1><a class="anchor" id="autotoc_md4"></a>
|
|
1. Compile Example projects</h1>
|
|
<p>Make sure your GBDK-2020 installation is working correctly by compiling some of the included <a class="el" href="docs_example_programs.html">example projects</a>.</p>
|
|
<p>Navigate to the example projects folder (<code>"examples/gb/"</code> under your GBDK-2020 install folder) and open a command line. Then type: </p><pre class="fragment">make
|
|
</pre><p>This should build all of the examples sequentially. You can also navigate into an individual example project's folder and build it by typing <code>make</code>.</p>
|
|
<p>If everything works and there are no errors reported each example sub-folder should have it's on .gb ROM file.</p>
|
|
<h1><a class="anchor" id="autotoc_md5"></a>
|
|
2. Use a Template</h1>
|
|
<p><b>To create a new project use a template!</b></p>
|
|
<p>There are template projects included in the <a class="el" href="docs_example_programs.html">GBDK example projects</a> to help you get up and running. Their folder names start with <code>template_</code>.</p>
|
|
<ol type="1">
|
|
<li>Copy one of the template folders to a new folder name</li>
|
|
<li>If you moved the folder out of the GBDK examples then you <b>must</b> update the <code>GBDK</code> path variable and/or the path to <code>LCC</code> in the <code>Makefile</code> or <code>make.bat</code> so that it will still build correctly.</li>
|
|
<li>Type <code>make</code> on the command line in that folder to verify it still builds.</li>
|
|
<li>Open main.c to start making changes.</li>
|
|
</ol>
|
|
<h1><a class="anchor" id="autotoc_md6"></a>
|
|
3. If you use GBTD / GBMB, get the fixed version</h1>
|
|
<p>If you plan to use GBTD / GBMB for making graphics, make sure to get the version with the <code>const</code> fix and other improvements. See <a class="el" href="docs_coding_guidelines.html#const_gbtd_gbmb">const_gbtd_gbmb</a>.</p>
|
|
<h1><a class="anchor" id="autotoc_md7"></a>
|
|
4. Review Coding Guidelines</h1>
|
|
<p>Take a look at the <a class="el" href="docs_coding_guidelines.html">coding guidelines</a>, even if you have experience writing software for other platforms. There is important information to help you get good results and performance on the Game Boy.</p>
|
|
<p>If you haven't written programs in C before, check the <a class="el" href="docs_coding_guidelines.html#docs_c_tutorials">C tutorials section</a>.</p>
|
|
<h1><a class="anchor" id="autotoc_md8"></a>
|
|
5. Hardware and Resources</h1>
|
|
<p>If you have a specific project in mind, consider what hardware want to target. It isn't something that has to be decided up front, but it can influence design and implementation.</p>
|
|
<p>What size will your game or program be?</p><ul>
|
|
<li>32K Cart (no-MBC required)</li>
|
|
<li>Larger than 32K (MBC required)</li>
|
|
<li>See more details about <a class="el" href="docs_rombanking_mbcs.html">ROM Banking and MBCs</a>.</li>
|
|
</ul>
|
|
<p>What hardware will it run on?</p><ul>
|
|
<li>Game Boy (& Game Boy Color)</li>
|
|
<li>Game Boy Color only</li>
|
|
<li>Game Boy & Super Game Boy</li>
|
|
<li>See how to <a class="el" href="docs_faq.html#faq_gb_type_header_setting">set the compatibility type in the cartridge header</a>. Read more about hardware differences in the <a class="el" href="docs_links_and_tools.html#Pandocs">Pandocs</a></li>
|
|
</ul>
|
|
<h1><a class="anchor" id="autotoc_md9"></a>
|
|
6. Set up C Source debugging</h1>
|
|
<p>Tracking down problems in code is easier with a debugger. Emulicious has a <a class="el" href="docs_links_and_tools.html#Emulicious_debug">debug adapter</a> that provides C source debugging with GBDK-2020.</p>
|
|
<h1><a class="anchor" id="autotoc_md10"></a>
|
|
7. Try a GBDK Tutorial</h1>
|
|
<p>You might want to start off with a guided GBDK tutorial from the <a class="el" href="docs_links_and_tools.html#links_gbdk_tutorials">GBDK Tutorials section</a>.</p>
|
|
<ul>
|
|
<li><b>Note:</b> Tutorials (or parts of them) may be based on the older GBDK from the 2000's before it was updated to be GBDK-2020. The general principals are all the same, but the setup and parts of the <a class="el" href="docs_toolchain.html">toolchain</a> (compiler/etc) may be somewhat different and some links may be outdated (pointing to the old GBDK or old tools).</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="autotoc_md11"></a>
|
|
8. Read up!</h1>
|
|
<ul>
|
|
<li>It is strongly encouraged to read more <a class="el" href="index.html#docs_index">GBDK-2020 General Documentation</a>.</li>
|
|
<li>Learn about the Game Boy hardware by reading through the <a class="el" href="docs_links_and_tools.html#Pandocs">Pandocs</a> technical reference.</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="autotoc_md12"></a>
|
|
9. Need help?</h1>
|
|
<p>Check out the links for <a class="el" href="docs_links_and_tools.html#links_help_and_community">online community and support</a> and read the <a class="el" href="docs_faq.html">FAQ</a>. </p>
|
|
</div></div><!-- contents -->
|
|
</div><!-- PageDoc -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.8.14-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
</div>
|
|
</body>
|
|
</html>
|