script to prepare a new game

[ouya-romlauncher.git] / README.rst

diff --git a/README.rst b/README.rst
index 5d53ba754efbe39cdb41c496d3d33b9d5c0c3fb3..c097af46394f317f60021e1c0c41ff4f42a57d60 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -2,7 +2,7 @@
 Generic OUYA SNES game launcher
 *******************************
 Based on this code you can pack up a SNES game and make it
-available in the OUYA launcher, just as a normal game.
+directly available in the OUYA launcher, just as a normal game.
 
 When running it, the game file is extracted and
 `Snes9x EX+`__ is started with it.
@@ -10,15 +10,18 @@ When running it, the game file is extracted and
 __ http://www.explusalpha.com/home/snes9x-ex
 
 
-Configuring
-===========
-Things to adjust:
+Packing a game
+==============
+Run ``prepare-game.sh``::
 
-- Put the game file into ``assets/game/``
-- Replace ``FIXME_ASSETFILENAME`` in
-  ``src/de/cweiske/ouya/gamelauncher/LaunchGameActivity.java``
-  with the game file name (name, not path).
-- Replace ``FIXME_GAMETITLE`` in ``AndroidManifest.xml`` with
-  the game's name.
-- You should also adjust the package path, otherwise one game
-  overwrites the other
+  $ ./prepare-game.sh "Super Pac-Man" superpacman ~/public-domain/superpacman.smc
+  Game title: Super Pac-Man
+  Full package path: romlauncher.superpacman
+  Game file: superpacman.smc
+  All prepared.
+  Put a 732x412 image into res/drawable-xhdpi/ouya_icon.png
+
+Now adjust the launcher image ``ouya_icon.png`` and build/run it
+with the Android Developer Tools Eclipse IDE.
+
+The generated ``.apkg`` file will be located in the ``bin/`` folder.