File	Date	Author	Commit
debian	2010-03-25	Christian Beier	[b9356f] Some packaging changes, update changelog.
m4	2010-10-18	Christian Beier	[a5fd45] Properly check for OpenGL in build system.
src	2010-10-18	Christian Beier	[5869df] Update help text for android.
AUTHORS	2009-07-17	Christian Beier	[204394] move some files around.
AndroidAppSettings.cfg	2010-10-30	Christian Beier	[da4a96] update AndroidAppSettings.cfg.
COPYING	2009-07-17	Christian Beier	[204394] move some files around.
ChangeLog	2010-03-25	Christian Beier	[b9356f] Some packaging changes, update changelog.
INSTALL	2009-07-20	Christian Beier	[fbd46b] autotoolize, yeah!
Makefile.am	2010-10-15	Christian Beier	[fd19e5] Move resource icons to root dir.
NEWS	2009-07-17	Christian Beier	[204394] move some files around.
README	2009-07-20	Christian Beier	[fbd46b] autotoolize, yeah!
README-SDL	2009-07-17	Christian Beier	[204394] move some files around.
TODO	2010-10-18	Christian Beier	[7cd514] Update TODO.
autogen.sh	2010-10-18	Christian Beier	[a5fd45] Properly check for OpenGL in build system.
configure.ac	2010-10-18	Christian Beier	[a5fd45] Properly check for OpenGL in build system.
icon.png	2010-10-15	Christian Beier	[fd19e5] Move resource icons to root dir.
omron++.icns	2010-10-15	Christian Beier	[fd19e5] Move resource icons to root dir.
omron++.nsi	2010-02-09	Christian Beier	[0cfb24] Add windows installer.

Read Me

this is OMRON++ - the simplistic peace-endowing warfare simulation.
        ^^^^^^^


1) what is it
2) how to use it   (if you got a precompiled one)
3) how to compile   (if you got the source ...)





1) what is it
^^^^^^^^^^^^^

in omron++, you have up to four armies of pixels fighting each other.
you can choose the number of soldiers on each side and some other parameters.
if you give them a certain "mobsize", they will form groups of pixels (called 
mobs) and go hunting together.





2) how to use it
^^^^^^^^^^^^^^^^
simply follow the menu promptings and enter your choices, then watch the whole 
thing going.

you can press 's' to take a screenshot, and 'f' to toggle between window and
fullscreen. press 'p' or 'pause' to pause the game when in battle. finally, you 
can toggle playing of sounds via 'm'.

hit 1,2,3 or key 4 to make your army retreat to the dropzone.


for 'advanced' usage type 'omron++ -h' to see the possible commandline 
arguments. (a special one is '-auto', which runs omron++ in some kind of 
standalone mode, without the need for user input. instead it randomly chooses
the parameters itself. just give it the percentage of the possible maximum 
values to adjust performance to your machine. makes a nice but resourcehungry 
screensaver ;-) )





3) how to compile
^^^^^^^^^^^^^^^^^

the prerequisites:

    - the usual c-compiler with headers and stuff 
    - libSDL devel package version >= 1.2.0
    - libSDL-gfx devel package version >= 2.0.9
    
to compile:
    - ./autogen.sh
    - if crosscompiling with MinGW: 
      ./autogen.sh --build=<your build system type> --host=i586-mingw32msvc --with-sdl-config=<your win32 sdl-config>
    - type 'make' and cross fingers
    

to install:
    - 'make install' as root 
    - or copy omron++ binary wherever you like to 
    
       
    



that's pretty much it, have fun !


---

comments, wishes and bug reports most welcome.                                   
christian beier <dontmind@freeshell.org>