script to prepare a new game
[ouya-romlauncher.git] / README.rst
1 *******************************
2 Generic OUYA SNES game launcher
3 *******************************
4 Based on this code you can pack up a SNES game and make it
5 directly available in the OUYA launcher, just as a normal game.
6
7 When running it, the game file is extracted and
8 `Snes9x EX+`__ is started with it.
9
10 __ http://www.explusalpha.com/home/snes9x-ex
11
12
13 Packing a game
14 ==============
15 Run ``prepare-game.sh``::
16
17   $ ./prepare-game.sh "Super Pac-Man" superpacman ~/public-domain/superpacman.smc
18   Game title: Super Pac-Man
19   Full package path: romlauncher.superpacman
20   Game file: superpacman.smc
21   All prepared.
22   Put a 732x412 image into res/drawable-xhdpi/ouya_icon.png
23
24 Now adjust the launcher image ``ouya_icon.png`` and build/run it
25 with the Android Developer Tools Eclipse IDE.
26
27 The generated ``.apkg`` file will be located in the ``bin/`` folder.