================================================================================
			FCEU PS3
			Version 1.4
================================================================================

This is an application for the PlayStation3 that makes it possible to play 
Nintendo Entertainment System / Famicom games on your jailbroken PlayStation3. 
It is based on an up-to-date version of the popular PC emulator, FCEUx.

================================================================================
			Table of Contents
================================================================================
0. Requirements........................................................... [A00]
1. Currently Implemented FCEU functions................................... [A01]
2. Controls............................................................... [B01]
     2.1.1 - Controls in ROM menu......................................... [B02]
     2.1.2 - Controls in Settings menu.................................... [B03]
     2.1.3 - Controls in-game............................................. [B04]
     2.1.7 - Controls in-game (miscellaneous)............................. [B05]
3. Settings............................................................... [C01]
     3.1 - General Settings............................................... [C02]
     3.2 - FCEU Settings.................................................. [C03]
     3.3 - Path Settings.................................................. [C04]
     3.4 - Controls Settings.............................................. [C05]
4. Cheat code files....................................................... [D01]
6. Currently known issues (as of 1.4)..................................... [E01]
     6.1 - Resolution switching - error prone on FW 1.92 build............ [E02]
7. Notes.................................................................. [F01]
     7.1 - General notes.................................................. [F02]
     7.2 - Performance notes.............................................. [F03]
     7.3 - Performance w/ pixel shaders................................... [F04]
8. Planned improvements................................................... [G01]
9. For Developers......................................................... [H01]
     9.1 - Source Code Repository......................................... [H02]
          9.1.1 - Getting the latest FCEU PS3 revision.................... [H03]
     9.2  - Compilation Instructions...................................... [H04]
          9.2.1 - For SDK 1.92............................................ [H05]
          9.2.2 - For SDK 3.41............................................ [H06]
	  9.2.3 - To make a debugging-friendly compile.................... [H07]
     9.3 - CellFramework.................................................. [H08]
          9.3.1 - Getting the latest Cellframework revision............... [H09]
10. Credits............................................................... [I01]
     

================================================================================
[A00]			0. Requirements
================================================================================
To play this on your PlayStation3 system, you have one of two options:

a) Jailbreak your PS3 using a USB exploit - this works up to firmware 3.41. 

or, 

b) You must update your firmware with a custom firmware. (required if you 
have firmware 3.55)

You must install the version of FCEU PS3 that corresponds to the firmware
you're running. Go to 'Game' in the XMB, go to 'Install Packages', and select
the package you want to install.

================================================================================
			PS3 has firmware 1.92+ installed (w/ jailbreak dongle)
================================================================================ 
Install 'fceu-ps3-v1.4-fw1.92.pkg'.

================================================================================
			PS3 has firmware 3.41 installed (w/ jailbreak dongle)
================================================================================
Install 'fceu-ps3-v1.4-fw3.41.pkg'.

================================================================================
			PS3 has firmware Geohot 3.55 CFW installed 
================================================================================
Install 'fceu-ps3-v1.4-geohot-cfw3.55.pkg'.

================================================================================
[A01]			1. CURRENTLY IMPLEMENTED FCEU FUNCTIONS
================================================================================
* Based on an up-to-date version of FCEUx
* Savestate loading/saving support
  - Savestate slot selectable in-game
  - Up to 10 saveslots
* Saving/loading of SRAM
* Controls
  - Four player support
* ROM support
  - Supports ZIP archives
* Supports cheatcode files (cht)

================================================================================
[B01]			2. CONTROLS
================================================================================

================================================================================
[B02]			2.1.1 CONTROLS IN ROM MENU
================================================================================
Up				- Go up
Down				- Go down
Left				- Go back five file entries
Right				- Go forward five file entries
L1				- Go back one page
R1				- Go forward one page

Cross				- (If directory selected) enter directory/ 
				  (if ROM selected) start ROM)
Triangle			- (If ROM selected) start ROM with multitap
				  support (*)
Circle				- (If not in root directory) Go back to
				  previous directory
L2 + R2				- (If you previously exited a ROM) return to
				  game
Select				- Go to settings menu
				  (see 'CONTROLS IN SETTINGS MENU' section)

* - This option might be removed in the future but is still available as a
fallback in case the automatic multitap capability detection fails to work
on a game.

================================================================================
[B03]			2.1.2 CONTROLS IN SETTINGS MENU
================================================================================
Up				- Go up one setting.
Down				- Go down one setting.
Left				- Change setting to the left.
Right				- Change setting to the right.

Circle				- Go back to ROM menu/Go back to previous
				  Settings screen
Start				- Reset the setting back to the default value.
R1				- Go to the next Settings screen
L1				- Go to the previous Settings screen

================================================================================
[B04]			2.1.3 CONTROLS IN-GAME
================================================================================

================================================================================
[B05]			2.1.4 CONTROLS IN-GAME - MISCELLANEOUS
================================================================================

R3 + L3				- Press these two buttons together while
				  in-game to go back to the ROM browser menu.

R3 + R2				- Save to currently selected save state slot.
R3 + L2				- Load from currently selected save state slot.

Right analog stick - Left	- Move current savestate slot one slot
				  backwards.
Right analog stick - Right	- Move current savestate slot one slot forward.
Right analog stick - Left + L2	- Move cheat position back by one (-1).
Right analog stick - Right + L2	- Move cheat position forwards by one (+1).
Right analog stick - Up		- Enable the currently selected cheat.
Right analog stick - Down	- Disable the currently selected cheat.

To play a game with a USB controller as Player 1, start up your PS3 and rather
than using the Sixaxis/DualShock3, plug in an USB port before connecting the
controller to the PS3 - your USB pad should then become Controller 1.

================================================================================
[C01]			3. SETTINGS
================================================================================

================================================================================
[C02]			3.1 GENERAL SETTINGS
================================================================================

================================================================================
			Current save state slot
================================================================================
Set the save state slot - this way, you can save multiple states and switch 
inbetween save states.

================================================================================
			Resolution
================================================================================
Switch between resolutions (depending on your TV/monitor's supported 
resolutions)

================================================================================
			Selected Shader
================================================================================
Select a shader - the default shader is '/stock.cg'. Choose between 2XSaI, 
Bloom shader, curved CRT shader, HQ2x, Super2xSaI, SuperEagle, and more.

================================================================================
			Aspect Ratio			
================================================================================
Switch between aspect ratios 'Scaled' (recommended for 4:3 TVs/monitors) and
'Stretched' (recommended for 16:9 TVs/monitors).

================================================================================
			Hardware Filtering
================================================================================
Switch between Linear interpolation (Bilinear filtering) (DEFAULT) and 
Point filtering.

Linear interpolation - A hardware bilinear filter is applied to the image.

Point filtering	     - No filters are applied. Most shaders look much better on
this setting.

================================================================================
			Overscan
================================================================================
Set this to a certain value so that no part of the screen is cutoff on your 
TV/monitor.

Which value to set varies depending on your monitor/TV.

================================================================================
			Sound
================================================================================
Switch between Normal mode and RSound mode.

Normal Mode - The normal audio output will be used by the PS3. (DEFAULT)

Rsound Mode - RSound basically lets you redirect the audio from the PS3 over the
network to a PC - so, using this, the audio from FCEU PS3 can be outputted on a 
PC/laptop/netbook/HTPC's speakers/audio installation instead of going through 
the television speakers or the audio receiver connected to the television.

================================================================================
			Rsound Server IP Address
================================================================================
Set the IP address for the RSound server. This Will pop up an onscreen keyboard 
where you must input a valid IP address that points to the server that will be 
running an RSound server application.

================================================================================
			DEFAULT
================================================================================
Set all of the general settings back to their default values

================================================================================
[C03]			FCEU SETTINGS
================================================================================

================================================================================
			SPRITE LIMIT
================================================================================
The Nintendo Entertainment System (NES) had certain hardware limitations that
caused sprites to flicker when more than eight were displayed on one line.

ON	-	The NES sprite limitation is retained.
OFF	-	The NES sprite limitation is turned off - less sprite flicker
		will be noticeable.

================================================================================
			GAME GENIE	
================================================================================
The Game Genie was an add-on device made by Codemasters that made it possible
to enter cheat codes for a game.

ON	-	Game Genie support is turned on. A Game Genie ROM with the
		filename 'gg.rom' must be in the USRDIR directory for this
		to work.
OFF	-	Game Genie support is turned off.

================================================================================
			CONTROL STYLE
================================================================================

Original	-	The NES face buttons are mapped as follows:
			B button - mapped to CROSS button
			A button - mapped to CIRCLE button

Better		-	The NES face buttons are mapped as follows:
			B button - mapped to SQUARE button
			A button - mapped to CROSS button

================================================================================
			Default
================================================================================
Set all of the FCEU settings back to their default values

================================================================================
[C04]			3.3 PATH SETTINGS
================================================================================

================================================================================
			Startup ROM Directory
================================================================================
Set the default ROM startup directory. You will have to restart the emulator
after changing the path for this change to have any effect.

DEFAULT - is set to the root of the PS3's filesystem. (/)

================================================================================
			Savestate Directory
================================================================================
Set the default savestate directory where your savestates will be saved and
loaded from.

DEFAULT - is set to the USRDIR directory of FCEU PS3. 
(/dev_hdd0/game/FCEU90000/USRDIR)

================================================================================
			SRAM Directory
================================================================================
Set the default SRAM (SaveRAM) directory where all your SRAM files will be 
saved and loaded from.

DEFAULT - is set to the USRDIR directory of FCEU PS3. 
(/dev_hdd0/game/FCEU90000/USRDIR)

================================================================================
			Cheatfile Directory
================================================================================
Set the default cheatfile directory - all your cheatfiles will be saved and 
loaded from here.

DEFAULT - is set to the USRDIR directory of FCEU PS3. 
(/dev_hdd0/game/FCEU90000/USRDIR)

================================================================================
			Default
================================================================================
Set all of the path settings back to their default values

================================================================================
[C05]			3.4 CONTROLS SETTINGS
================================================================================
TODO

================================================================================
[D01]			4. CHEAT CODE FILES
================================================================================
Cheat code files need to be have the same filename as the ROM you want to apply 
it to.

For instance:

Super Mario Bros (World).sfc

The cheatfile would have the following name:

Super Mario Bros (World).cht

Cheatcode files are saved either in the default directory (USRDIR), or at the 
directory that you have set as the 'Cheatfile directory' (see 'PATH SETTINGS')

NOTE: See '2.1.2 - CONTROLS IN-GAME' for an explanation of settings 
activation/deactivation and selecting ingame.

================================================================================
[E01]			6. CURRENTLY KNOWN ISSUES (AS OF BUILD 1.4)
================================================================================

================================================================================
[E02]			6.1 Resolution switching - error prone on FW 1.92 build
================================================================================
There are known problems with resolution switching on firmware 1.92. Be warned
that while it might work up until a certain couple of times, it is known to 
crash the emulator after changing resolutions too many times. When this 
happens, you will have to restart the emulator and load the jailbreak payload
again.

================================================================================
[F01]			7. NOTES
================================================================================

================================================================================
[F02]			7.1 GENERAL NOTES
================================================================================
For people running this on HDTVs complaining about input lag:

Turn off all post-processing filters you may have running - on Sony Bravia 
HDTVs, display Motion Flow (this also causes input lags with most games in 
general, not just this application. If your HDTV has a 'Game' mode or something 
of the sort, select that as well.

================================================================================
[F03]			7.2 PERFORMANCE NOTES
================================================================================
All games will run at 60fps constant (NTSC) / 50fps constant (PAL) at any 
resolution.

================================================================================
[F04]			7.3 PERFORMANCE NOTES - SHADERS
================================================================================
Here is the performance of the various fragment/pixel shaders:

All shaders will run at fullspeed up until 1280x1080.

================================================================================
SHADER		1440x1080		1600x1080		1920x1080 1080p
================================================================================
Stock		60fps			60fps			60fps 
2xSaI		60fps			60fps			60fps
Bloom		60fps (*)		not fullspeed (**)	not fullspeed
Blur		60fps			60fps			60fps
CRT		not fullspeed (**)	not fullspeed (**)	not fullspeed
HQ2x		60fps			60fps			60fps
Lanzcos12	60fps			60fps			60fps
Lanzcos16	60fps			60fps			60fps
McGreen		60fps			60fps			60fps
Quad_Interp	60fps			60fps			60fps
Scale2xPlus	60fps			60fps			60fps
Scanlines	60fps			60fps			60fps
Sharpen		60fps			60fps			60fps
Super2xSaI	60fps			not fullspeed		not fullspeed
SuperEagle	60fps			60fps			not fullspeed

*  - Might fluctuate with certain chip games (such as SuperFX)
** - Is fullspeed at 4:3 but not at 16:9

================================================================================
[G01]			8. PLANNED IMPROVEMENTS
================================================================================
* A better frontend
* Be able to input cheat codes with the OSK utility (on-screen keyboard)

================================================================================
[H01]			9. FOR DEVELOPERS
================================================================================

================================================================================
[H02]			9.1 SOURCE CODE REPOSITORY
================================================================================
Link : https://code.google.com/p/fceu-ps3/

================================================================================
[H03]			9.1.1 GETTING LATEST FCEU PS3 REVISION
================================================================================
To be able to check out the latest revision, you must have Mercurial installed 
on your system.

To check out the latest revision in the trunk, type in the following from the
command-line:

hg clone https://fceu-ps3.googlecode.com/hg/ fceu-ps3

================================================================================
[H04]			9.2 COMPILATION INSTRUCTIONS
================================================================================
FCEU PS3 can be compiled with GCC.

================================================================================
[H05]			9.2.1 FOR SDK 1.92
================================================================================
1 - Edit the Makefile and comment out the following lines below the comment 'for 3.41':

#for 3.41
PPU_CLAGS		+= -DPS3_SDK_3_41
PPU_CXXFLAGS		+= -DPS3_SDK_3_41

3 - Do 'make clean && make && make pkg'

================================================================================
[H06]			9.2.2 FOR SDK 3.41
================================================================================

1 - Do 'make clean && make && make pkg'

================================================================================
[H07]			9.2.3 TO MAKE A DEBUGGING-FRIENDLY COMPILE
================================================================================
We provide a netlogger in case you want to have some way of debugging 
FCEU PS3 remotely.

1 - Edit the Makefile and comment out the following lines below the comment 
'debugging':

#PPU_CFLAGS += -DCELL_DEBUG -DPS3_DEBUG_IP=\"192.168.1.7\" \ 
#-DPS3_DEBUG_PORT=9002
#PPU_CXXFLAGS += -DCELL_DEBUG -DPS3_DEBUG_IP=\"192.168.1.7\" \
#-DPS3_DEBUG_PORT=9002

The IP address needs to be changed to the IP address of the host machine that 
will be running netcat.

2 - Do 'make clean && make compile'.

3 - Install FCEU PS3 on your PS3, start up netcat on your PC with the 
following command:

netcat -l -p 9002

4 - Start up FCEU PS3. If all went well, you will see debugging messages on 
your PC with the netcat application.

================================================================================
[H08]			9.3 CELLFRAMEWORK
================================================================================
Link : https://code.google.com/p/cellframework/)

FCEU PS3 is an implementation of 'Cellframework', which is written by the same 
developers as a rudimentary framework for PS3 app development. It provides 
more-or-less complete classes for graphics, input, audio, and network.

Cellframework is a subrepository of FCEU PS3. To update the subrepository, 
from  the commandline, go to the folder and type 'hg up'.

================================================================================
[H09]			9.3.1 GETTING LATEST CELLFRAMEWORK REVISION
================================================================================
To be able to check out the latest revision, you must have Mercurial 
installed on your system. Type in the following:

hg clone https://cellframework.googlecode.com/hg/ cellframework

================================================================================
[I01]			10. CREDITS
================================================================================
Orioto	-	PIC1.PNG based on 'Crystal Catacombs' 
		(http://orioto.deviantart.com/art/Crystal-Catacomb-133446942)
