rockbox

History

Franklin Wei 33cb13dee5 Xworld - Another World interpreter for Rockbox Co-conspirators: Franklin Wei, Benjamin Brown -------------------------------------------------------------------- This work is based on: - Fabien Sanglard's "Fabother World" based on - Piotr Padkowski's newRaw interpreter which was based on - Gregory Montoir's reverse engineering of - Eric Chahi's assembly code -------------------------------------------------------------------- Progress: * The plugin runs pretty nicely (with sound!) on most color targets * Keymaps for color LCD targets are complete * The manual entry is finished * Grayscale/monochrome support is NOT PLANNED - the game looks horrible in grayscale! :p -------------------------------------------------------------------- Notes: * The original game strings were built-in to the executable, and were copyrighted and could not be used. * This port ships with an alternate set of strings by default, but can load the "official" strings from a file at runtime. -------------------------------------------------------------------- To be done (in descending order of importance): * vertical stride compatibility <30% done> * optimization <10% done> Change-Id: I3155b0d97c2ac470cb8a2040f40d4139ddcebfa5 Reviewed-on: http://gerrit.rockbox.org/1077 Reviewed-by: Michael Giacomelli <giac2000@hotmail.com>		2014-12-23 23:48:12 +01:00
..
logo	lcd_color/cabbiev2: New iconset in multiple sizes	2011-11-26 16:01:11 +00:00
API
BATTERY-FAQ	Convert the whole codebase to UTF-8, except docs/COMMITTERS and tools/creative.c, which need checking.	2008-05-05 10:32:46 +00:00
BATTERY-FAQ-LIION
CHARGING_ALGORITHM
COMMITTERS	Add myself to committers list	2014-11-18 02:31:24 +01:00
CONTRIBUTING	Update CONTRIBUTING to reflect our switch to git on gerrit.	2012-01-24 13:05:25 +01:00
COPYING
COPYING-MANUAL
CREDITS	Xworld - Another World interpreter for Rockbox	2014-12-23 23:48:12 +01:00
gpl-2.0.html	Remove duplicated license file.	2010-09-04 18:50:12 +00:00
HISTORY	Convert to UTF-8 and a few tweaks.	2008-02-07 00:56:07 +00:00
KNOWN_ISSUES	Use crc32 of filename to resume tracks	2013-01-02 08:29:38 +01:00
LICENSES
MAINTAINERS	Spanish translation update by Francisco Vila (FS#10003). Also add him as Spanish maintainer.	2009-03-11 11:05:42 +00:00
NODO	Remove outdated NODO list from the docs folder. Replace it with a link to the wiki.	2010-05-15 21:54:24 +00:00
PLUGIN_API	lcd-common/scroll_engine: Remove unused functions lcd_puts_scroll_style().	2014-01-07 14:13:48 +01:00
profontdoc.txt	Make sure files which aren't windows-specific use \n line endings only	2010-06-17 16:59:51 +00:00
README	Update instructions in docs/README to change 'Check out from SVN' to 'Clone from git'	2013-04-24 11:11:38 +01:00
sample.colours	Make sure files which aren't windows-specific use \n line endings only	2010-06-17 16:59:51 +00:00
sample.icons	Add a sample.icons file, and add a few more files to the docs folder in the zips	2007-06-18 09:32:28 +00:00
TECH	Fix example command line for profile_reader.pl	2009-12-22 09:41:12 +00:00
UISIMULATOR	Turn the simulator background into a clickable area. i.e. you click on the play button to press play. It also maps mouse scrollwheel events to rockbox scrollwheel events. This facilitates testing because you don't have to move your hand between the mouse and keyboard.	2010-02-16 17:34:48 +00:00

README

               __________               __   ___.
     Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
     Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
     Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
     Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
                       \/            \/     \/    \/            \/

Build Your Own Rockbox

1. Clone 'rockbox' from git (or extract a downloaded archive).

   $ git clone git://git.rockbox.org/rockbox

     or

   $ tar xjf rockbox.tar.bz2

2. Create a build directory, preferably in the same directory as the firmware/
   and apps/ directories. This is where all generated files will be written.

   $ cd rockbox
   $ mkdir build
   $ cd build

3. Make sure you have sh/arm/m68k-elf-gcc and siblings in the PATH. Make sure
   that you have 'perl' in your PATH too. Your gcc cross compiler needs to be
   a particular version depending on what player you are compiling for. These
   can be acquired with the rockboxdev.sh script in the /tools/ folder of the
   source, or will have been included if you've installed one of the
   toolchains or development environments provided at http://www.rockbox.org/

   $ which sh-elf-gcc
   $ which perl

4. In your build directory, run the 'tools/configure' script and enter what
   target you want to build for and if you want a debug version or not (and a
   few more questions). It'll prompt you. The debug version is for making a
   gdb version out of it. It is only useful if you run gdb towards your target
   Archos.

   $ ../tools/configure

5. *ploink*. Now you have got a Makefile generated for you.

6. Run 'make' and soon the necessary pieces from the firmware and the apps
   directories have been compiled, linked and scrambled for you.

   $ make
   $ make zip

7. unzip the rockbox.zip on your music player, reboot it and
   *smile*.

If you want to build for more than one target, just create several build
directories and create a setup for each target:

   $ mkdir build-fmrecorder
   $ cd build-fmrecorder
   $ ../tools/configure

   $ mkdir build-player
   $ cd build-player
   $ ../tools/configure

Questions anyone? Ask on the mailing list. We'll be happy to help you!