README.md 1.86 KB
Newer Older
StapleButter's avatar
StapleButter committed
1
2
# melonDS
DS emulator, sorta
3
4


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


8
The source code is provided under the GPLv3 license.
9
10


11
How to use:
StapleButter's avatar
StapleButter committed
12
13
14
15

melonDS requires BIOS/firmware copies from a DS. Files required:
 * bios7.bin, 16KB: ARM7 BIOS
 * bios9.bin, 4KB: ARM9 BIOS
16
 * firmware.bin, 128/256/512KB: firmware
StapleButter's avatar
StapleButter committed
17
 
18
19
20
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.

21
22
23
24
25
Possible firmware sizes:
 * 128KB: DSi/3DS DS-mode firmware (reduced size due to lacking bootcode)
 * 256KB: regular DS firmware
 * 512KB: iQue DS firmware

26
DS BIOS dumps from a 3DS can be used with no compatibility issues. DSi BIOS dumps should be usable too, provided they were dumped properly.
StapleButter's avatar
StapleButter committed
27

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

StapleButter's avatar
StapleButter committed
30

s1nka's avatar
s1nka committed
31
How to build:
32

s1nka's avatar
s1nka committed
33
34
35
36
37
38
39
40
Linux:
 * mkdir -p build
 * cd build
 * cmake ..
 * make

Windows:
 * use CodeBlocks
StapleButter's avatar
StapleButter committed
41
 * or receive golden cookies if you get Cmake to work
StapleButter's avatar
StapleButter committed
42
43
44

Build system is not set in stone.

45
46
47

TODO LIST

StapleButter's avatar
StapleButter committed
48
49
50
 * UI that doesn't suck
 * better sound emulation
 * emulating some fancy addons
StapleButter's avatar
StapleButter committed
51
52
53
54
55
 * other non-core shit (debugger, graphics viewers, cheat crapo, etc)

 
TODO LIST FOR LATER

StapleButter's avatar
StapleButter committed
56
57
 * hardware renderer for 3D (w/ upscaling and fancy shit)
 * better wifi
StapleButter's avatar
StapleButter committed
58
 * maybe emulate flashcarts or other fancy hardware
59
60
 * big-endian compatibility (Wii, etc)
 * LCD refresh time (used by some games for blending effects)
61
 * any feature you can eventually ask for that isn't outright stupid
StapleButter's avatar
StapleButter committed
62
63
64
65
66
67
68
 
 
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