Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Baekalfen
Baekalfen committed Feb 11, 2024
1 parent 2acfb7e commit e68099f
Show file tree
Hide file tree
Showing 17 changed files with 4,775 additions and 3,044 deletions.
192 changes: 192 additions & 0 deletions docs/api/constants.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,192 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>pyboy.api.constants API documentation</title>
<meta name="description" content="Memory constants used internally to calculate tile and tile map addresses." />
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:0.8em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script async src='https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS_CHTML'></script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>pyboy.api.constants</code></h1>
</header>
<section id="section-intro">
<p>Memory constants used internally to calculate tile and tile map addresses.</p>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">#
# License: See LICENSE.md file
# GitHub: https://github.com/Baekalfen/PyBoy
#
&#34;&#34;&#34;
Memory constants used internally to calculate tile and tile map addresses.
&#34;&#34;&#34;

VRAM_OFFSET = 0x8000
&#34;&#34;&#34;
Start address of VRAM
&#34;&#34;&#34;
LCDC_OFFSET = 0xFF40
&#34;&#34;&#34;
LCDC Register
&#34;&#34;&#34;
OAM_OFFSET = 0xFE00
&#34;&#34;&#34;
Start address of Object-Attribute-Memory (OAM)
&#34;&#34;&#34;
LOW_TILEMAP = 0x1800 + VRAM_OFFSET
&#34;&#34;&#34;
Start address of lower tilemap
&#34;&#34;&#34;
HIGH_TILEMAP = 0x1C00 + VRAM_OFFSET
&#34;&#34;&#34;
Start address of high tilemap
&#34;&#34;&#34;
LOW_TILEDATA = VRAM_OFFSET
&#34;&#34;&#34;
Start address of lower tile data
&#34;&#34;&#34;
LOW_TILEDATA_NTILES = 0x100
&#34;&#34;&#34;
Number of tiles in lower tile data
&#34;&#34;&#34;
HIGH_TILEDATA = 0x800 + VRAM_OFFSET
&#34;&#34;&#34;
Start address of high tile data
&#34;&#34;&#34;
TILES = 384
&#34;&#34;&#34;
Number of tiles supported on Game Boy DMG (non-color)
&#34;&#34;&#34;
TILES_CGB = 768
&#34;&#34;&#34;
Number of tiles supported on Game Boy Color
&#34;&#34;&#34;
SPRITES = 40
&#34;&#34;&#34;
Number of sprites supported
&#34;&#34;&#34;
ROWS = 144
&#34;&#34;&#34;
Rows (horizontal lines) on the screen
&#34;&#34;&#34;
COLS = 160
&#34;&#34;&#34;
Columns (vertical lines) on the screen
&#34;&#34;&#34;</code></pre>
</details>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-variables">Global variables</h2>
<dl>
<dt id="pyboy.api.constants.VRAM_OFFSET"><code class="name">var <span class="ident">VRAM_OFFSET</span></code></dt>
<dd>
<section class="desc"><p>Start address of VRAM</p></section>
</dd>
<dt id="pyboy.api.constants.LCDC_OFFSET"><code class="name">var <span class="ident">LCDC_OFFSET</span></code></dt>
<dd>
<section class="desc"><p>LCDC Register</p></section>
</dd>
<dt id="pyboy.api.constants.OAM_OFFSET"><code class="name">var <span class="ident">OAM_OFFSET</span></code></dt>
<dd>
<section class="desc"><p>Start address of Object-Attribute-Memory (OAM)</p></section>
</dd>
<dt id="pyboy.api.constants.LOW_TILEMAP"><code class="name">var <span class="ident">LOW_TILEMAP</span></code></dt>
<dd>
<section class="desc"><p>Start address of lower tilemap</p></section>
</dd>
<dt id="pyboy.api.constants.HIGH_TILEMAP"><code class="name">var <span class="ident">HIGH_TILEMAP</span></code></dt>
<dd>
<section class="desc"><p>Start address of high tilemap</p></section>
</dd>
<dt id="pyboy.api.constants.LOW_TILEDATA"><code class="name">var <span class="ident">LOW_TILEDATA</span></code></dt>
<dd>
<section class="desc"><p>Start address of lower tile data</p></section>
</dd>
<dt id="pyboy.api.constants.LOW_TILEDATA_NTILES"><code class="name">var <span class="ident">LOW_TILEDATA_NTILES</span></code></dt>
<dd>
<section class="desc"><p>Number of tiles in lower tile data</p></section>
</dd>
<dt id="pyboy.api.constants.HIGH_TILEDATA"><code class="name">var <span class="ident">HIGH_TILEDATA</span></code></dt>
<dd>
<section class="desc"><p>Start address of high tile data</p></section>
</dd>
<dt id="pyboy.api.constants.TILES"><code class="name">var <span class="ident">TILES</span></code></dt>
<dd>
<section class="desc"><p>Number of tiles supported on Game Boy DMG (non-color)</p></section>
</dd>
<dt id="pyboy.api.constants.TILES_CGB"><code class="name">var <span class="ident">TILES_CGB</span></code></dt>
<dd>
<section class="desc"><p>Number of tiles supported on Game Boy Color</p></section>
</dd>
<dt id="pyboy.api.constants.SPRITES"><code class="name">var <span class="ident">SPRITES</span></code></dt>
<dd>
<section class="desc"><p>Number of sprites supported</p></section>
</dd>
<dt id="pyboy.api.constants.ROWS"><code class="name">var <span class="ident">ROWS</span></code></dt>
<dd>
<section class="desc"><p>Rows (horizontal lines) on the screen</p></section>
</dd>
<dt id="pyboy.api.constants.COLS"><code class="name">var <span class="ident">COLS</span></code></dt>
<dd>
<section class="desc"><p>Columns (vertical lines) on the screen</p></section>
</dd>
</dl>
</section>
<section>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="pyboy.api" href="index.html">pyboy.api</a></code></li>
</ul>
</li>
<li><h3><a href="#header-variables">Global variables</a></h3>
<ul class="two-column">
<li><code><a title="pyboy.api.constants.VRAM_OFFSET" href="#pyboy.api.constants.VRAM_OFFSET">VRAM_OFFSET</a></code></li>
<li><code><a title="pyboy.api.constants.LCDC_OFFSET" href="#pyboy.api.constants.LCDC_OFFSET">LCDC_OFFSET</a></code></li>
<li><code><a title="pyboy.api.constants.OAM_OFFSET" href="#pyboy.api.constants.OAM_OFFSET">OAM_OFFSET</a></code></li>
<li><code><a title="pyboy.api.constants.LOW_TILEMAP" href="#pyboy.api.constants.LOW_TILEMAP">LOW_TILEMAP</a></code></li>
<li><code><a title="pyboy.api.constants.HIGH_TILEMAP" href="#pyboy.api.constants.HIGH_TILEMAP">HIGH_TILEMAP</a></code></li>
<li><code><a title="pyboy.api.constants.LOW_TILEDATA" href="#pyboy.api.constants.LOW_TILEDATA">LOW_TILEDATA</a></code></li>
<li><code><a title="pyboy.api.constants.LOW_TILEDATA_NTILES" href="#pyboy.api.constants.LOW_TILEDATA_NTILES">LOW_TILEDATA_NTILES</a></code></li>
<li><code><a title="pyboy.api.constants.HIGH_TILEDATA" href="#pyboy.api.constants.HIGH_TILEDATA">HIGH_TILEDATA</a></code></li>
<li><code><a title="pyboy.api.constants.TILES" href="#pyboy.api.constants.TILES">TILES</a></code></li>
<li><code><a title="pyboy.api.constants.TILES_CGB" href="#pyboy.api.constants.TILES_CGB">TILES_CGB</a></code></li>
<li><code><a title="pyboy.api.constants.SPRITES" href="#pyboy.api.constants.SPRITES">SPRITES</a></code></li>
<li><code><a title="pyboy.api.constants.ROWS" href="#pyboy.api.constants.ROWS">ROWS</a></code></li>
<li><code><a title="pyboy.api.constants.COLS" href="#pyboy.api.constants.COLS">COLS</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad()</script>
</body>
</html>
117 changes: 117 additions & 0 deletions docs/api/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>pyboy.api API documentation</title>
<meta name="description" content="Tools to help interfacing with the Game Boy hardware" />
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:0.8em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script async src='https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS_CHTML'></script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>pyboy.api</code></h1>
</header>
<section id="section-intro">
<p>Tools to help interfacing with the Game Boy hardware</p>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">#
# License: See LICENSE.md file
# GitHub: https://github.com/Baekalfen/PyBoy
#
&#34;&#34;&#34;
Tools to help interfacing with the Game Boy hardware
&#34;&#34;&#34;

from . import constants
from .screen import Screen
from .sprite import Sprite
from .tile import Tile
from .tilemap import TileMap

# __pdoc__ = {
# &#34;constants&#34;: False,
# &#34;manager&#34;: False,
# }
# __all__ = [&#34;API&#34;]</code></pre>
</details>
</section>
<section>
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
<dl>
<dt><code class="name"><a title="pyboy.api.constants" href="constants.html">pyboy.api.constants</a></code></dt>
<dd>
<section class="desc"><p>Memory constants used internally to calculate tile and tile map addresses.</p></section>
</dd>
<dt><code class="name"><a title="pyboy.api.memory_scanner" href="memory_scanner.html">pyboy.api.memory_scanner</a></code></dt>
<dd>
<section class="desc"></section>
</dd>
<dt><code class="name"><a title="pyboy.api.screen" href="screen.html">pyboy.api.screen</a></code></dt>
<dd>
<section class="desc"><p>This class gives access to the frame buffer and other screen parameters of PyBoy.</p></section>
</dd>
<dt><code class="name"><a title="pyboy.api.sprite" href="sprite.html">pyboy.api.sprite</a></code></dt>
<dd>
<section class="desc"><p>This class presents an interface to the sprites held in the OAM data on the Game Boy.</p></section>
</dd>
<dt><code class="name"><a title="pyboy.api.tile" href="tile.html">pyboy.api.tile</a></code></dt>
<dd>
<section class="desc"><p>The Game Boy uses tiles as the building block for all graphics on the screen. This base-class is used both for
<code><a title="pyboy.api.sprite.Sprite" href="sprite.html#pyboy.api.sprite.Sprite">Sprite</a></code> and …</p></section>
</dd>
<dt><code class="name"><a title="pyboy.api.tilemap" href="tilemap.html">pyboy.api.tilemap</a></code></dt>
<dd>
<section class="desc"><p>The Game Boy has two tile maps, which defines what is rendered on the screen.</p></section>
</dd>
</dl>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="pyboy" href="../index.html">pyboy</a></code></li>
</ul>
</li>
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
<ul>
<li><code><a title="pyboy.api.constants" href="constants.html">pyboy.api.constants</a></code></li>
<li><code><a title="pyboy.api.memory_scanner" href="memory_scanner.html">pyboy.api.memory_scanner</a></code></li>
<li><code><a title="pyboy.api.screen" href="screen.html">pyboy.api.screen</a></code></li>
<li><code><a title="pyboy.api.sprite" href="sprite.html">pyboy.api.sprite</a></code></li>
<li><code><a title="pyboy.api.tile" href="tile.html">pyboy.api.tile</a></code></li>
<li><code><a title="pyboy.api.tilemap" href="tilemap.html">pyboy.api.tilemap</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad()</script>
</body>
</html>
Loading

0 comments on commit e68099f

Please sign in to comment.