Hexen II for PSP v 1.0

Juraj Styk 		
4th June 2007 


Introduction
------------

This is a port of Raven Software's Hexen II to the PSP. 
Based on PSP Quake port by Peter Mackay and original Hexen II 
source code released under GNU GPL License. 
Compiled and linked with PSPDev Environment for Win32.

Links
-----
	PSP Hexen II install files:
		http://jurajstyk.host.sk/download.htm	
	
	PSP Hexen II source code:
		http://jurajstyk.host.sk/download.htm	
		
	Hexen II source code:
		http://hexen2.ravengames.com/raven-downloads.php
		
	PSP Quake source code:
		http://sourceforge.net/projects/psp-quake/
	
	PSPDev Environment for Win32		
		http://xorloser.com/	
Features
--------

Working:
- Software rendering.
- Single player game and Portal of Praevus single player game
- Sound
- Save/Load
- Console commands
- Command line commands (through 'hexen2.cmdline' file)
- Multiple screen resolutions (trough command line params)
- User made maps loading (from console or command line params)
- Demo recording and playback (from console)
- On Screen Keyboard 

Missing:
- Music playback 
  (disabled)

Untested:
- Multi player 
  (creating multi player game works)

Known issues:
- No progress bar displayed when starting/loading/saving game 
  (disabled because of stability problems)
- Restart or reload of a current map necessary if value of console variable 
  'r_transwater' is changed (otherwise water surfaces will not be rendered correctly)
- User made mods with modified progs.dat files will not work 
- Sprite models with width or height that is not multiple of 4 can cause game to crash 
- Some weird graphical artifacts can be observed sometimes  


Installation
------------

This game is for PSPs with firmware versions 1.5 or for custom firmwares. 
If you want to try to make it running on other versions, you will need to 
download source code and recompile it yourself. Developed and tested on PSP 
with firmware version '3.03 OE-C' in 1.5 kernel mode.

Installation instructions:
1. Unzip the package 

   1.5 firmware users:
     Copy the Hexen2 and Hexen2% folders to the PSP/GAME folder on your PSP.
   
   Custom firmware users:
     Copy the Hexen2 and Hexen2% folders to the PSP/GAME150 folder on your PSP.
   
2. Install retail version of Hexen II on your PC 

4. Download and install 'ph2v111.exe' to patch Hexen II to version 1.11
   ( you can get it from Raven Software official Hexen II home page at 
     http://hexen2.ravengames.com/raven-downloads.php )	
 
5. Go to directory where you installed PC version of Hexen II  

6. Copy DATA1 folder from this directory to Hexen2 folder on your PSP.

( Now you can go to PSP and start Hexen II or continue installing Hexen II mission pack)

7. Install retail version of Hexen II: Portal of Praevus on your PC 

8. Download and install 'H2MP_Patch_v112a.exe' to patch Hexen II to version 1.12
   ( you can get it from Raven Software official Hexen II home page at 
     http://hexen2.ravengames.com/pop_patches.php )	
     
9. Go to directory where you installed PC version of Hexen II  

10. Copy portals folder from this directory to Hexen2 folder on your PSP. 
    ( some files ( pak3.pak ) already in portals directory on PSP will be overwritten - 
      those files are necessary to make Hexen II work if mission pack is not installed )   
 
( Now you can go to PSP and start Hexen II)


Controls
--------

Regarding the buttons:

The PSP buttons are connected to the following keys during the game and when the menu 
is shown. You will need to go into options menu and configure the keys you want to use.

PSP      | Game key   | Menu key   | Default game function
---------+------------+------------+----------------------
SELECT   | ~          | ~          | Toggle console
START    | ESCAPE     | ESCAPE     | Show menu
LTRIGGER | LTRIGGER   |            |
RTRIGGER | RTRIGGER   |            |
UP       | UPARROW    | UPARROW    | Move forward
RIGHT    | RIGHTARROW | RIGHTARROW | Turn right
DOWN     | DOWNARROW  | DOWNARROW  | Move backwards
LEFT     | LEFTARROW  | LEFTARROW  | Turn left
TRIANGLE | TRIANGLE   |            |
CIRCLE   | CIRCLE     | ESCAPE     |
CROSS    | CROSS      | ENTER      |
SQUARE   | SQUARE     |            |

For example, when you press CROSS, game gets a CROSS key press, which you will 
need to set to your desired action in the game options screen.

Regarding the analog nub:

If mouselook is turned on, then the analog nub is used to look around. 
You'll need to allocate other buttons for movement. If mouselook is turned off, 
which is the default, then the analog nub is used for movement.


On screen keyboard (OSK)
-----------------------
Available from console and from text input boxes in Multiplayer menus.

Press SQUARE to activate the OSK. 

Is OSK use arrows to select character and press CROSS to type it. To input 'space' 
move cursor to empty space (cursor will change to 'X') and press CROSS.  
Press TRIANGLE to erase last typed character. Press SQUARE to finish typing and 
return to console. Press CIRCLE to cancel input and return to console.

When back in console execute command by pressing CROSS.
Press RIGHT ARROW to use auto complete feature. L/R Buttons scroll console output up and down.
UP/DOWND ARROW browse trough previously entered console commands.

Command line options
--------------------
If you want to start Hexen II with some specific command line options create file named 
'hexen2.cmdline' in Hexen directory (the same directory that contains eboot.pbp) and put 
command line option here 

example: 
	-condebug -rwidth 368 -rheight 272 -swidth 368 -sheight 272 +map demo3
	
(will start Hexen II  in map demo3 with console logging and with render and screen resolution 
 set both to 368 x 272)

PSP specific command line options
---------------------------------
-rwidth 
-rheight 
-swidth 
-sheight

'-rwidth' and '-rheight' set resolution at which is game rendered internally 		
	( default: 320x200 )
'-swidth' and '-sheight' set resolution at which is internally rendered image displayed  
	( default: 480x272 )

Any resolution between 320x200 and 480x272 will work as long both width and height is multiple of 8 

Thanks
------

Big thanks go out to:
- Raven Software, for releasing Hexen II source code .
- Peter Mackay, for creating PSP Quake port which made porting Hexen II to PSP very easy.
- Makers of PSPDev Environment for Win32