README.ds
author Markus Kauppila <markus.kauppila@gmail.com>
Thu, 26 May 2011 19:19:46 +0300
changeset 5668 3a9b790c00e9
parent 5515 0fcf231a6e74
child 6251 3e8c673cad58
permissions -rw-r--r--
Added TestCaseReference structure.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5289
1916a9e9714d Frank Zago to SDL
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     1
================================================================================
1916a9e9714d Frank Zago to SDL
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     2
Simple DirectMedia Layer for Nintendo DS
1916a9e9714d Frank Zago to SDL
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     3
================================================================================
1916a9e9714d Frank Zago to SDL
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     4
1916a9e9714d Frank Zago to SDL
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
     5
-Requirements-
5423
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
     6
* The devkitpro SDK available at http://devkitpro.org.
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
     7
  Read the information at http://devkitpro.org/wiki/Getting_Started/devkitARM
5430
1b318d81c85f You need libfat for the filesystem code.
Sam Lantinga <slouken@libsdl.org>
parents: 5423
diff changeset
     8
  The necessary packages are devkitARM, libnds, libfat and default arm7.
5423
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
     9
* The hardware renderer is using the libgl2d abstraction library that can be found at:
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
    10
    http://rel.phatcode.net/junk.php?id=117
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
    11
  Build it, and install the library and the header where SDL can find them (ie. in
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
    12
  the libnds/lib and libnds/include directories).
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
    13
5289
1916a9e9714d Frank Zago to SDL
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    14
1916a9e9714d Frank Zago to SDL
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    15
-Building SDL-
5423
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
    16
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
    17
After setting the devkitpro environment, cd into your SDL directory and type:
5289
1916a9e9714d Frank Zago to SDL
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    18
  make -f Makefile.ds
1916a9e9714d Frank Zago to SDL
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    19
5515
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    20
This will compile and install the library and headers into the
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    21
devkitpro's portlibs directory. Additionnaly it will compile several
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    22
tests that you can run either on the DS or with desmume. For instance:
5289
1916a9e9714d Frank Zago to SDL
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    23
  desmume test/nds-test-progs/general/general.nds
1916a9e9714d Frank Zago to SDL
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    24
5423
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
    25
-Notes-
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
    26
* The renderer code is based on the gl like engine. It's not using the sprite engine.
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
    27
* The port is very basic and incomplete:
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
    28
  - SDL currently has to be compiled for either framebuffer mode or render mode.
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
    29
     See USE_HW_RENDERER in Makefile.ds.
5515
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    30
  - some optional renderer functions are not implemented.
5289
1916a9e9714d Frank Zago to SDL
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
    31
5423
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
    32
-Limitations-
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
    33
* in hardware renderer mode, don't load too many textures. The internal format is
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
    34
  2 bytes per pixel. And there is only 256KB reserved for the textures. For instance,
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
    35
  testscale won't display sample.bmp, unless it's resized to a smaller picture.
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
    36
* the screen size is 256 x 384. Anything else won't work.
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
    37
* there is no 8 bits/pixel mode because SDL 1.3 doesn't support palettes.
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
    38
5515
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    39
-Joystick mapping-
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    40
The Joystick presented to SDL has 2 axes and 8 buttons
5423
b69fa50e80d7 a Nintendo ds update
Sam Lantinga <slouken@libsdl.org>
parents: 5289
diff changeset
    41
5515
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    42
 KEY      | Code
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    43
  A       |   0
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    44
  B       |   1
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    45
  X       |   2
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    46
  Y       |   3
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    47
  L       |   4
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    48
  R       |   5
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    49
  select  |   6
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    50
  start   |   7
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    51
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    52
 Left-right is axe 0.
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    53
 Up-down is axe 1.
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    54
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    55
-Mouse mapping-
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    56
todo
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    57
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    58
-Examples-
0fcf231a6e74 NDS update
Sam Lantinga <slouken@libsdl.org>
parents: 5430
diff changeset
    59
Due to memory limitations, to be able to successfully run the testscale example, sample.bmp must be resized to 256x105.