README

   1
   2 OpenITG - an open-source rhythm dancing game which is a fork of StepMania 3.95
   3 with the goal of adding arcade-like ITG-style behavior and serving as a drop-in
   4 replacement for the ITG binary on arcade cabinents.
   5
   6 Project homepage: https://github.com/openitg/openitg/wiki
   7 Project bug tracker: https://github.com/openitg/openitg/issues
   8 Project IRC channel: #openitg on irc.badnik.com
   9 Project source code: https://github.com/openitg/openitg
  10
  11 * TODOs
  12
  13 Short-term
  14 1. Getting Started Guide - build and development
  15 2. streamline build and release process - works out of box for arcade and home
  16 3. test / bugfix beta-3 (currently master branch)
  17 4. self-contained cache-rebuilding solution
  18 5. OpenGL Driver uses fix function pipeline rather than shader
  19
  20 Long-term
  21 1. Kernel source with ITG patches to rebuild kernels (talk to us, should live in a separate repo)
  22 2. StepMania 4.0 LUA Bindings
  23 3. StepMania 4.0 Theme metrics
  24
  25
  26 * How to check-out the source
  27
  28 git clone git://github.com/openitg/openitg.git
  29
  30 * How to contribute
  31
  32 1. Create an account at github.com
  33 2. Goto https://github.com/openitg/openitg
  34 3. Click "fork"
  35 4. git clone git@github.com:<username>/openitg.git
  36 5. Edit files...
  37 6. git add <filename> for every file you add or edit
  38 7. git commit # now your change is committed locally
  39 8. git push # now your change is pushed to your github
  40 9. From github.org/<username>/openitg, click "pull request".  Base branch is the
  41 branch you want to put your changes on, and head branch is the branch you made
  42 your changes to already.
  43 10. Write a short description of your change.  Be sure to include the goal, any
  44 bugs fixed, features added, etc, and any credit you wish to have.  Click "send
  45 pull request".
  46
  47 * How to build for arcade
  48
  49 1. Choose a location for your chroot:  MY_CHROOT=/home/cmyers/chroot
  50 2. Install debootstrap and chroot (on debian/ubuntu, apt-get install chroot debootstrap)
  51 3. Set up chroot, from root dir of source, as the root user, run: ./chroot-arcade.sh `pwd` $MY_CHROOT
  52 4. cd /root/openitg-dev/ && ./build-arcade.sh
  53
  54 NOTE: the chroot will be created in the location you choose for MY_CHROOT.  This
  55 will build an entire Debian Sarge Linux system (the same OS used by arcade
  56 machines).  This will take approximately 350MB.  A full clone of the repo is
  57 about 300MB after you build all artifacts, so expect to have at least 650MB of
  58 free space to work with.
  59
  60 * How to build for home on 32-bit linux:
  61
  62 TODO: No chroot necessary, need script to install dependencies on various
  63 distributions...
  64
  65 * How to build for home on 64-bit linux:
  66 TODO: Similar process to arcade, but create 32-bit chroot of modern debian
  67
  68 * How to build for home on windows:
  69 TODO: Need someone to describe how to build in Visual Studio and produce
  70 releases.
  71