CONSTRUCTION AREA
Go to file
Franklin Wei 3f59fc8b77 Wolfenstein 3-D!
This is a port of Wolf4SDL, which is derived from the original id
software source release. The port runs on top of the SDL plugin
runtime and is loaded as an overlay.

Licensing of the game code is not an issue, as discussed below
(essentially, the Debian project treats Wolf4SDL as GPLv2, with an
email from John Carmack backing it up):

  http://forums.rockbox.org/index.php?topic=52872

Included is a copy of MAME's Yamaha OPL sound chip emulator
(fmopl_gpl.c).  This file was not part of the original Wolf4SDL source
(which includes a non-GPL'd version), but was rather rebased from from
a later MAME source which had been relicensed to GPLv2.

Change-Id: I64c2ba035e0be7e2f49252f40640641416613439
2019-07-09 11:20:55 -04:00
android Make android build work with both old and new locations of zipalign 2017-09-06 18:26:31 +02:00
apps Wolfenstein 3-D! 2019-07-09 11:20:55 -04:00
backdrops Add Cabbiev2 port for 128x96x16 targets (Samsung YH-820), made by me. 2014-03-27 19:50:48 +00:00
bootloader Add Xuelin iHIFI 770/770C/800 support 2019-01-02 08:10:01 -05:00
debian Prepare new maemo release 2013-03-10 12:12:38 +01:00
docs Wolfenstein 3-D! 2019-07-09 11:20:55 -04:00
firmware rbendian.h: fall back to generic swap macros 2019-07-09 11:20:55 -04:00
flash Limit more variables to file scope 2015-01-11 21:40:51 +01:00
fonts Remove superfluous executable bits on a bunch of files. 2011-06-08 14:22:03 +00:00
gdb Limit more variables to file scope 2015-01-11 21:40:51 +01:00
icons wpsbuild: Rewrite to fix various issues and support .fms 2012-06-10 21:20:36 +02:00
lib opus fix playback opustag skipping 2019-01-25 17:50:39 +01:00
manual Wolfenstein 3-D! 2019-07-09 11:20:55 -04:00
packaging Prepare unofficial pandora release 2013-03-10 14:09:30 +01:00
rbutil Fix host build of mkimxboot, mknwzboot, nwztools, and rbutil with crypto++ 2019-01-25 12:58:18 +01:00
tools configure: add --32-bit option to build a 32-bit simulator/application 2019-06-17 23:11:25 -04:00
uisimulator Fix simulator/transflective: Display wasn't enabled on first keypress when backlight always off 2019-02-08 15:06:16 +01:00
utils nwztools: fix Makefile 2019-04-22 23:45:33 +02:00
wps Agptek Rocker: Initial commit 2018-06-12 10:31:14 +02:00
.gitattributes Add a gitattributes file for the migration. 2011-12-01 14:14:59 +00:00
.gitignore Add buflib tests to .gitignore 2015-01-03 18:21:59 +01:00

docs/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!