melonDS/README.md

<p align="center"><img src="https://raw.githubusercontent.com/StapleButter/melonDS/master/icon/melon_128x128.png"></p>
<h2 align="center"><b>melonDS</b></h2>
<p align="center">
<a href="http://melonds.kuribo64.net/" alt="melonDS website"><img src="https://img.shields.io/badge/website-melonds.kuribo64.net-%2331352e.svg"></a>
<a href="http://melonds.kuribo64.net/downloads.php" alt="Release: 0.7.2"><img src="https://img.shields.io/badge/release-0.7.2-%235c913b.svg"></a>
<a href="https://www.gnu.org/licenses/gpl-3.0" alt="License: GPLv3"><img src="https://img.shields.io/badge/License-GPL%20v3-%23ff554d.svg"></a>
<a href="https://kiwiirc.com/client/irc.badnik.net/?nick=IRC-Source_?#melonds" alt="IRC channel: #melonds"><img src="https://img.shields.io/badge/IRC%20chat-%23melonds-%23dd2e44.svg"></a>
</p>
DS emulator, sorta

The goal is to do things right and fast, akin to blargSNES (but hopefully better). But also to, you know, have a fun challenge :)
<hr>

## How to use

melonDS requires BIOS/firmware copies from a DS. Files required:
 * bios7.bin, 16KB: ARM7 BIOS
 * bios9.bin, 4KB: ARM9 BIOS
 * firmware.bin, 128/256/512KB: firmware

Firmware boot requires a firmware dump from an original DS or DS Lite.
DS firmwares dumped from a DSi or 3DS aren't bootable and only contain configuration data, thus they are only suitable when booting games directly.

### Possible firmware sizes

 * 128KB: DSi/3DS DS-mode firmware (reduced size due to lacking bootcode)
 * 256KB: regular DS firmware
 * 512KB: iQue DS firmware

DS BIOS dumps from a DSi or 3DS can be used with no compatibility issues. DSi BIOS dumps (in DSi mode) are not compatible. Or maybe they are. I don't know.

As for the rest, the interface should be pretty straightforward. If you have a question, don't hesitate to ask, though!

## How to build

### Linux:

```sh
mkdir -p build
cd build
cmake ..
make
```

### Windows:

 * use CodeBlocks
 * or receive golden cookies if you get Cmake to work

Build system is not set in stone.

## TODO LIST

 * improve libui and the emulator UI
 * hardware renderer for 3D (w/ upscaling and fancy shit)
 * support for rendering screens to separate windows
 * emulating some fancy addons
 * other non-core shit (debugger, graphics viewers, cheat crapo, etc)

### TODO LIST FOR LATER

 * better wifi
 * maybe emulate flashcarts or other fancy hardware
 * big-endian compatibility (Wii, etc)
 * LCD refresh time (used by some games for blending effects)
 * any feature you can eventually ask for that isn't outright stupid

## Credits

 * Martin for GBAtek, a good piece of documentation
 * Cydrak for the extra 3D GPU research
 * All of you comrades who have been testing melonDS, reporting issues, suggesting shit, etc

## License
[![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](http://www.gnu.org/licenses/gpl-3.0.en.html)

melonDS is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Changed the readme to make it look a little fancier 2018-11-01 06:11:11 +00:00			`<p align="center"><img src="https://raw.githubusercontent.com/StapleButter/melonDS/master/icon/melon_128x128.png"></p>`
			`<h2 align="center"><b>melonDS</b></h2>`
			`<p align="center">`
			`<a href="http://melonds.kuribo64.net/" alt="melonDS website"><img src="https://img.shields.io/badge/website-melonds.kuribo64.net-%2331352e.svg"></a>`
update readme 2018-12-18 20:08:24 +00:00			`<a href="http://melonds.kuribo64.net/downloads.php" alt="Release: 0.7.2"><img src="https://img.shields.io/badge/release-0.7.2-%235c913b.svg"></a>`
Changed the readme to make it look a little fancier 2018-11-01 06:11:11 +00:00			`<a href="https://www.gnu.org/licenses/gpl-3.0" alt="License: GPLv3"><img src="https://img.shields.io/badge/License-GPL%20v3-%23ff554d.svg"></a>`
			`<a href="https://kiwiirc.com/client/irc.badnik.net/?nick=IRC-Source_?#melonds" alt="IRC channel: #melonds"><img src="https://img.shields.io/badge/IRC%20chat-%23melonds-%23dd2e44.svg"></a>`
			`</p>`
Fix README formatting 2017-10-22 03:58:02 +00:00			`DS emulator, sorta`
first real commit, some shit is in 2016-05-16 01:40:11 +00:00
maybe this shit will finally work. also update the README. 2017-03-29 20:56:30 +00:00			`The goal is to do things right and fast, akin to blargSNES (but hopefully better). But also to, you know, have a fun challenge :)`
Changed the readme to make it look a little fancier 2018-11-01 06:11:11 +00:00			`<hr>`
Fixed a formatting issue with a title Had to add an extra space between <hr> and ## How to use, the previous commit messed up the formatting 2018-11-01 20:10:34 +00:00
Fix README formatting 2017-10-22 03:58:02 +00:00			`## How to use`
* lay base for 3D engine * add failure reporting to Init functions, and DeInit functions * GPU-related notes * readme update 2017-02-07 21:23:46 +00:00
			`melonDS requires BIOS/firmware copies from a DS. Files required:`
			`* bios7.bin, 16KB: ARM7 BIOS`
			`* bios9.bin, 4KB: ARM9 BIOS`
* allow 128KB firmwares (DSi/3DS dumps) * document firmware sizes better 2017-08-05 17:13:55 +00:00			`* firmware.bin, 128/256/512KB: firmware`
Changed the readme to make it look a little fancier 2018-11-01 06:11:11 +00:00
wifi: proper TX/RX status switch and RX check readme: little update 2017-06-15 19:41:18 +00:00			`Firmware boot requires a firmware dump from an original DS or DS Lite.`
			`DS firmwares dumped from a DSi or 3DS aren't bootable and only contain configuration data, thus they are only suitable when booting games directly.`

Fix README formatting 2017-10-22 03:58:02 +00:00			`### Possible firmware sizes`

* allow 128KB firmwares (DSi/3DS dumps) * document firmware sizes better 2017-08-05 17:13:55 +00:00			`* 128KB: DSi/3DS DS-mode firmware (reduced size due to lacking bootcode)`
			`* 256KB: regular DS firmware`
			`* 512KB: iQue DS firmware`

guess this is good for 0.7. readme update as a pretext 2018-10-26 19:06:46 +00:00			`DS BIOS dumps from a DSi or 3DS can be used with no compatibility issues. DSi BIOS dumps (in DSi mode) are not compatible. Or maybe they are. I don't know.`
* lay base for 3D engine * add failure reporting to Init functions, and DeInit functions * GPU-related notes * readme update 2017-02-07 21:23:46 +00:00
maybe this shit will finally work. also update the README. 2017-03-29 20:56:30 +00:00			`As for the rest, the interface should be pretty straightforward. If you have a question, don't hesitate to ask, though!`
* somewhat proper event scheduler * support for timers * fixes, additions, shit 2016-12-05 16:08:24 +00:00
Fix README formatting 2017-10-22 03:58:02 +00:00			`## How to build`
finalize CMake shit. Windows will stick to CodeBlocks until making a cross-platform build system isn't a total trainwreck under Windows. 2017-04-30 01:46:27 +00:00
Fix README formatting 2017-10-22 03:58:02 +00:00			`### Linux:`
* somewhat proper event scheduler * support for timers * fixes, additions, shit 2016-12-05 16:08:24 +00:00
Fix README formatting 2017-10-22 03:58:02 +00:00			```sh
			`mkdir -p build`
			`cd build`
			`cmake ..`
			`make`
			```

			`### Windows:`
add CMake build system 2017-04-02 07:33:01 +00:00
			`* use CodeBlocks`
readme update 2017-08-29 16:17:44 +00:00			`* or receive golden cookies if you get Cmake to work`
finalize CMake shit. Windows will stick to CodeBlocks until making a cross-platform build system isn't a total trainwreck under Windows. 2017-04-30 01:46:27 +00:00
			`Build system is not set in stone.`

Fix README formatting 2017-10-22 03:58:02 +00:00			`## TODO LIST`
* somewhat proper event scheduler * support for timers * fixes, additions, shit 2016-12-05 16:08:24 +00:00
guess this is good for 0.7. readme update as a pretext 2018-10-26 19:06:46 +00:00			`* improve libui and the emulator UI`
also update the readme a bit while we're at it 2018-12-14 23:36:16 +00:00			`* hardware renderer for 3D (w/ upscaling and fancy shit)`
guess this is good for 0.7. readme update as a pretext 2018-10-26 19:06:46 +00:00			`* support for rendering screens to separate windows`
readme update 2017-08-29 16:17:44 +00:00			`* emulating some fancy addons`
* fix GXFIFO decoding * proper SwapBuffers implementation * fix polygon clipping * misc fixes 2017-02-13 01:07:54 +00:00			`* other non-core shit (debugger, graphics viewers, cheat crapo, etc)`
Changed the readme to make it look a little fancier 2018-11-01 06:11:11 +00:00
Fix README formatting 2017-10-22 03:58:02 +00:00			`### TODO LIST FOR LATER`
* fix GXFIFO decoding * proper SwapBuffers implementation * fix polygon clipping * misc fixes 2017-02-13 01:07:54 +00:00
readme update 2017-08-29 16:17:44 +00:00			`* better wifi`
* fix GXFIFO decoding * proper SwapBuffers implementation * fix polygon clipping * misc fixes 2017-02-13 01:07:54 +00:00			`* maybe emulate flashcarts or other fancy hardware`
start work on polygon edges and shit 2017-03-12 23:45:26 +00:00			`* big-endian compatibility (Wii, etc)`
			`* LCD refresh time (used by some games for blending effects)`
maybe this shit will finally work. also update the README. 2017-03-29 20:56:30 +00:00			`* any feature you can eventually ask for that isn't outright stupid`
Changed the readme to make it look a little fancier 2018-11-01 06:11:11 +00:00
Fix README formatting 2017-10-22 03:58:02 +00:00			`## Credits`
readme update 2017-08-29 16:17:44 +00:00
			`* Martin for GBAtek, a good piece of documentation`
			`* Cydrak for the extra 3D GPU research`
			`* All of you comrades who have been testing melonDS, reporting issues, suggesting shit, etc`
Changed the readme to make it look a little fancier 2018-11-01 06:11:11 +00:00
			`## License`
			`[![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](http://www.gnu.org/licenses/gpl-3.0.en.html)`

			`melonDS is free software: you can redistribute it and/or modify`
			`it under the terms of the GNU General Public License as published by`
			`the Free Software Foundation, either version 3 of the License, or`
			`(at your option) any later version.`