README.ds
changeset 6285 f12649068adb
parent 6251 3e8c673cad58
equal deleted inserted replaced
6284:1893d507ba42 6285:f12649068adb
     4 
     4 
     5 -Requirements-
     5 -Requirements-
     6 * The devkitpro SDK available at http://devkitpro.org.
     6 * The devkitpro SDK available at http://devkitpro.org.
     7   Read the information at http://devkitpro.org/wiki/Getting_Started/devkitARM
     7   Read the information at http://devkitpro.org/wiki/Getting_Started/devkitARM
     8   The necessary packages are devkitARM, libnds, libfat and default arm7.
     8   The necessary packages are devkitARM, libnds, libfat and default arm7.
     9 * The hardware renderer is using the libgl2d abstraction library that can be found at:
     9 * Optionally, use a DS emulator, such as desmume (http://desmume.org/)
    10     http://rel.phatcode.net/junk.php?id=117
    10   to program and debug.
    11   Build it, and install the library and the header where SDL can find them (ie. in
       
    12   the libnds/lib and libnds/include directories).
       
    13 
       
    14 
    11 
    15 -Building SDL-
    12 -Building SDL-
    16 
    13 
    17 After setting the devkitpro environment, cd into your SDL directory and type:
    14 After setting the devkitpro environment, cd into your SDL directory and type:
    18   make -f Makefile.ds
    15   make -f Makefile.ds
    19 
    16 
    20 This will compile and install the library and headers into the
    17 This will compile and install the library and headers into the
    21 devkitpro's portlibs directory. Additionnaly it will compile several
    18 devkitpro's portlibs directory (../portlibs/arm/lib/ and
    22 tests that you can run either on the DS or with desmume. For instance:
    19 ../portlibs/arm/include/). Additionally it will compile several tests
       
    20 that you can run either on the DS or with desmume. For instance:
       
    21   desmume --cflash-path=test/ test/nds-test-progs/testsprite2/testsprite2.nds
       
    22   desmume --cflash-path=test/ test/nds-test-progs/testspriteminimal/testspriteminimal.nds
       
    23   desmume --cflash-path=test/ test/nds-test-progs/testscale/testscale.nds 
    23   desmume test/nds-test-progs/general/general.nds
    24   desmume test/nds-test-progs/general/general.nds
    24 
    25 
    25 -Notes-
    26 -Notes-
    26 * The renderer code is based on the gl like engine. It's not using the sprite engine.
    27 * The renderer code is based on the gl like engine. It's not using the sprite engine.
       
    28 * The hardware renderer is using the parts of the libgl2d abstraction library that can be found at:
       
    29     http://rel.phatcode.net/junk.php?id=117
       
    30   Used with the author's permission.
    27 * The port is very basic and incomplete:
    31 * The port is very basic and incomplete:
    28   - SDL currently has to be compiled for either framebuffer mode or render mode.
    32   - SDL currently has to be compiled for either framebuffer mode or renderer mode.
    29      See USE_HW_RENDERER in Makefile.ds.
    33      See USE_HW_RENDERER in Makefile.ds.
    30   - some optional renderer functions are not implemented.
    34   - some optional renderer functions are not implemented.
       
    35   - no sound
    31 
    36 
    32 -Limitations-
    37 -Limitations-
    33 * in hardware renderer mode, don't load too many textures. The internal format is
    38 * in hardware renderer mode, don't load too many textures. The internal format is
    34   2 bytes per pixel. And there is only 256KB reserved for the textures. For instance,
    39   2 bytes per pixel. And there is only 256KB reserved for the textures. For instance,
    35   testscale won't display sample.bmp, unless it's resized to a smaller picture.
    40   testscale won't display sample.bmp, unless it's resized to a smaller picture.