Menu

Tree [0a696b] default tip /
 History

Read Only access


File Date Author Commit
 editor 2011-03-30 Ian Finlayson Ian Finlayson [690b47] Updated some header messages.
 game 2012-07-01 Ian Finlayson Ian Finlayson [828b80] Small changes.
 launcher 2011-03-30 Ian Finlayson Ian Finlayson [63d8ec] Initial Commit of Andromeda!
 manual 2011-03-30 Ian Finlayson Ian Finlayson [690b47] Updated some header messages.
 resources 2012-07-01 Ian Finlayson Ian Finlayson [0a696b] Added resources.
 .cproject 2011-07-09 Ian Finlayson Ian Finlayson [03f0f2] Added project files and cleaned some stuff up.
 .project 2011-07-09 Ian Finlayson Ian Finlayson [03f0f2] Added project files and cleaned some stuff up.
 COPYING 2011-03-30 Ian Finlayson Ian Finlayson [63d8ec] Initial Commit of Andromeda!
 Makefile 2011-07-09 Ian Finlayson Ian Finlayson [03f0f2] Added project files and cleaned some stuff up.
 README 2011-03-30 Ian Finlayson Ian Finlayson [b55ed2] Updated the README with new links.
 Sconstruct 2011-03-30 Ian Finlayson Ian Finlayson [63d8ec] Initial Commit of Andromeda!

Read Me

# README
# Copyright Ian Finlayson
# This file is part of the Andromeda project
# This code is released under the MIT license
# see the file COPYING for details

* Building
  To compile the game, you will need to have the following installed:
    - scons
    - SDL-devel
    - SDL_image-devel
    - SDL_mixer-devel
    - ftgl-devel
    - lua-devel
    - gcc-c++

  To compile the documentations, you will need
    - texlive-latex

  These are all package names for Fedora Linux, but these are all available
  on other systems as well.  Consult your package manager.

  When you have the prerequisites installed, simply run "make" in the top
  level directory.  This should produce an executable.
  
  This project uses scons to build the actual software, because it is much
  better suited for building software than make is, but uses make to run
  general shell commands, since it is better at that task than scons.

  Eclipse is used as an IDE, Google Code for hosting and Mercurial for
  source control.


* Installation
  For now the game can't be easily installed into the file system.  The
  executable must be run from the same directory as the "res" folder.
  In the future, the installation will be supported and automated.


* Directories
  - src: holds all source code for the game
  - docs: holds LaTeX source for the users manual and also
      generated pdfs once they are compiled
  - bin: holds compiled object files
  - res: holds resource files for the game:
    - fonts: true type fonts used
    - images: png images used
    - music: tuxguitar tab files used to generate accompanying ogg files
    - sounds: wav sound files used


* Bugs & Questions
  Any bugs or other issues can be sent to https://sourceforge.net/p/andromedagalaxy/tickets/
  If you have something else to say, please swing by the forums at https://sourceforge.net/p/andromedagalaxy/discussion/

  Thanks for your interest in Andromeda!