-----------------------
=======================
WELCOME TO OPENTYRIAN2X
=======================
-----------------------

Opentyrian2x is the open source GP2X port of the vertical scrolling shooter Tyrian originally for the PC.


=====================
GP2X - CHANGE HISTORY
=====================

v0.3 (28th Dec 2007)
----
* Non-fullscreen mode is now centered. See Title -> Opentyrian menu.
* ARM assembler sound mixer. Nice speed up, Pentium detail level is fully playable! Code is thanks to sweetlilmre and his efforts porting Tyrian to the Gizmondo.
* Improved controls within menus. No longer uncontrollably fast!
* Improved controls for accessing PAUSE and IN-GAME SETUP.
* GP2X specific readme-gp2x.txt providing instructions and setup.
* Redefinable fire keys. See Options -> Joystick menu.

  New default keys in game:

  A/B are main fire
  X is switch rear weapon
  L is left side weapons fire
  R is right side weapons fire
  SELECT brings up in-game menu
  START is pause


  New default keys in menu:

  A/B is main select
  Y is back a menu or escape


v0.2 "Christmas Edition" (22nd Dec 2007)
----
 * Fullscreen scaling. That is 320x200 is hardware scaled to 320x240. It looks fine and because it's vertical scrolling you hardly notice. Aspect ratio is perfect now as it matches the original PC.
 * In-game menu works with SELECT key.
 * Pause works with START key.
 * Christmas mode using the alternative script.
 * New icons. Traditional adapted Tyrian icon for the regular game and a special christmas icon.

v0.1 (20th Dec 2007)
----
 * Reduce sound from 44100hz to 22050hz. Big increase in speed!
 * Use assembler versions of memcpy() and memset(). Further increase in speed!

v0.0
----
 * Initial release


============
INTRODUCTION
============

What is Opentyrian2x?
Opentyrian2x is a GP2X port of the original PC MS-DOS game Tyrian.

What is Tyrian?
Tyrian is an arcade-style vertical scrolling shooter. The player controls a space ship fitted with different weapons and enhanced energy shields. Money is earned by destroying enemies and grabbing bonuses, which is then used to purchase upgrades such as weapons, shields, energy generators, and different ships from interlevel menus. The game is fast paced and presents a variety of enemies and bosses.

Who developed Tyrian?
Tyrian was originally developed by Eclipse Productions (later named World Tree Games) and published in 1995 by Epic MegaGames.

Open Source
In February 2007 the Pascal source code for Tyrian was licensed for a small group of developers to re-write it in C, in a project named OpenTyrian, licensed under the GNU Public License. There are no plans of releasing the original source code. Following that announcement, in April 2007 Daniel Cook announced the free availability of his Tyrian artwork (not including the later work for the Game Boy Color edition and for Tyrian 2000) under generic liberal terms.

GP2X port
v0.0 by Kalimerou. v0.1 -> 0.3 by Slaanesh. Suggestions and other additions by Daid and others on www.gp32x.com forums. 

Tyrian Graphics
The graphical style is reminiscent of the European scene during the 16-bit era of computers when the Amiga and Atari ST reigned supreme. Think Bitmap Brothers and you will feel right at home. Everything has a 3D look and feel to it with an emphasis on metallic shiny. Tyrian's graphics are a stark contrast to the Japanese style of shooter which are usually colorfully vibrant and and wildly imaginative. You will either love it or hate it.

Tyrian Sound
An awesome soundtrack comprising of many dozens songs, great sound effects and some great voice overs. It's a highlight of the game.


============
REQUIREMENTS
============

The original PC requirements was a 386 running at 33Mhz with 4MB of RAM and 16MB of space on the hard drive.
The GP2X requirements are less modest however the game should run well at the default 200Mhz speed with RAM timings on. 

Why is there such a large increase in requirements?
You can not compare Intel cpu to the ARM - they are vastly different in architectiure and capability. The PC version assumes a sound card for music and sound effects which removes a large amount of processing requirement. The GP2X must generate the music itself by emulating the low-level sound hardware.


=====
SETUP
=====

What do I need to play?
You will need the following:
 * opentyrian2x executable (included in binary-only and complete package)
 * opentyrian2x_gmenu.gpe script (included in binary-only and complete package)
   OR
   opentyrian2x.gpe script (included in binary-only and complete package)
 * opentyrian2x.png icon (included in binary-only and complete package)
 * The original PC Tyrian data files. (included in the complete package).

There are other files included in each release such as christmas mode and alternative icons however the instructions to set these up are similar. It's up to the user to change icons around and use them as desired. 

Install using the Complete Package
1). Create an "opentyrian2x" directory on your SD card. This can be anyway and can be called whatever you like.
2). Copy the contents of the archive into this directory.
3). If you are using Gmenu2X the following settings are recommended:
	* Set Gamma to 15
	* Set RAM Timings on
	* Set GP2X speed to 200Mhz
	* Set volume to 75 
	* Rename the launch script from opentyrian2x_gmenu.gpe to
	  opentyrian2x.gpe


Install using the Binary-only Package
1). Create an "opentyrian2x" directory on your SD card. This can be anyway and can be called whatever you like.
2). Copy the contents of the archive into this directory.
3). If you are using Gmenu2X follow the instructions in step 3). for the Complete package.
4). You will need to copy the required files from the PC version of Tyrian into the "opentyrian2x" directory. These can be obtained from the following archive:
	
	http://it.travisbsd.org/foo/tyrian/tyrian21.zip

5). You can safely delete the following files from this archive:

	*.exe, *.doc, *.diz


Upgrade using the Binary-only Package.
1). Copy the  opentyrian2x executable and opentyrian2x.gpe script over the existing versions.
2). It is important that the script is replaced or edited with updated commands. The previous version may be doing things differently on start up!


========
CONTROLS
========

By default, the following controls perform the following actions:

In game:
* Controller moves the ship
* A & B Buttons fire the main weapons
* X switch rear weapon
* L fire left side weapons
* R fire right side weapons
* SELECT brings up the in game menu
* START pauses the game

The in game keys can be redefined from the Options->Joystick menu.

In menu:
* Controller moves the menu up and down.
* Controller changes some selectable items with left and right.
* A & B Buttons select an option
* Y go back to previous menu, exit or escape.


==============
OTHER SETTINGS
==============

By default the game will run in fullscreen mode. This is slightly stretched as the original PC game was a 320x200 game with a 4:3 aspect ration. Yes, the pixels on the PC were NOT square.
Therefore in fullscreen mode on the GP2X the image is scaled from 320x200 to 320x240.
The change the scaling, from the titlescreen enter the Opentyrian menu and select fullscreen on or off as desired.
When not fullscreen, the original 320x200 pixel mode is used centered on the screen, however the aspect ratio will be incorrect. This is particularly evident when a planet is displayed on the screen ie. at the end of the episode.

