Pocket-Go CFW V1.1
Bittboy CFW V4.0
2019-07-16
----------


*General Info:

-Shutting down the console:
	Not shutting down safely can cause microSD corruption
	+To safely shut down the console:
		*Exit from the emulator or game you are playing to return to the main menu (gmenu)
		*Hold the 'R' button ('Reset' on pocket-go) to open the Power Menu
		*Press A to Shut Down
		*When the screen turns black, flick the power switch


-Screen timeout/sleep mode (only applies while in the main menu):
	+The default screen timeout is 90 seconds. After this the screen will go black. Press 'R' to wake it up
	+The default power timeout is 10 minutes. After the bittboy has been idle for 10 minutes it will perform a soft shutdown
		*Once this has occurred, you must flick the power switch off and back on to wake the bittboy


-Bitt-Boy boot animation (Applies to BittBoy Only)
	+The bitt-boy boot animation can be disabled to speed up boot time:
		*Rename or delete the file 'boot-logo' from the root of the microSD


-----------------------------------------------------------------------------------------

*Emulator Info:

https://docs.google.com/spreadsheets/d/1DPXXBUxV_q-jgpbW9YxG9E53VvH-BZg9Ipc9_rcN46U

-----------------------------------------------------------------------------------------

*CANNONBALL (Outrun Arcade):

-Place Outrun datafiles in '\.cannonball\roms'
-See '.cannonball\roms\Place outrun ROM files here.txt' for information on required files

-'R' Button ('Reset' on pocket-go) changes gear

-----------------------------------------------------------------------------------------

*DOOM:
-Shareware WAD file is included
-To play other WADs, copy them to '\roms\PC\DOOM'

-----------------------------------------------------------------------------------------

*DOS:

-DOSBox boots to the menu system 'LaunchBox for MS-DOS SE 2.0'
-To play the included game (Shareware Commander Keen Episode 1 "Marooned on Mars") Press 'start'


Controls:
-The keys to launch, quit and play are mapped
-Buttons map as:

P-Go Button:	Bittboy Button:		Key:
Up				Up					Up
Down			Down				Down
Left			Left				Left
Right			Right				Right
A				TA					LALT
B				A					LCTRL
X				TB					LSHIFT
Y				B					Space
Start			Start				RETURN
Select			Select				ESCAPE
Reset			R					RCTRL

-When another key needs to be pressed (eg to quit the game) the On Screen Keyboard (OSK) must be used
-Opening (or closing) the OSK:
	-Bittboy: Press Start+B at the same time
	-PGo: L trigger


Exiting from DOSbox:
1)First Quit Commander Keen:
	-Press select. Use the OSK when prompted to press a key to quit

2)Then Exit the LaunchBox menu:
	-Press 'TA' ('A' on pocket-go) to select the 'File' menu, press start to accept. Use the dpad to choose 'Exit', press start to accept


Adding new DOS games:
-DOSBOX uses '\roms\PC\DOS' as 'C:\'
-DOSBOX configuration file location: '\emus\dosbox\dosbox.conf'

-Place the new game folder within '\roms\PC\DOS'
-Edit '\roms\PC\DOS\LAUNCHBX\LAUNCHBX.TXT' to add the new game to the LaunchBox menu
    -See example file 'LAUNCHBX - Example.TXT' in the same location

-----------------------------------------------------------------------------------------

*GAMBATTE:

-Auto Palette selection info:
	+The Gambatte emulator now (since version 20190621) supports automatic loading of palettes on a per-game basis
		*This feature can be enabled from the gambatte settings menu (settings | mono palette | auto)
	+The Palette file (.pal) in '.gambatte\palettes' with a filename matching the loaded ROM will be automatically used
		*EG for ROM 'gameA.gb', the palette file '.gambatte\palettes\gameA.pal' will be used

	+Palette files used by original GBC/GBA consoles (when playing monochrome GB games) can be found in '.gambatte\palettes\GBC & SGB Palettes\GBC Assigned Palettes\'.
		*See 'GB on GBC Assigned Palette Guide.txt' in this same location for information on which games use which palette
		*Copy the desired palette to '.gambatte\palettes' and rename to match the game ROM


-Manual Palette selection info:
	+The CFW includes a collection of palettes to select from the gambatte menu, with more available to be copied by the user
	+Palette files that are located directly within '.gambatte\palettes' will be displayed in gambatte's menu
	+To use the additional included palettes: Move palette files (.pal) located within subfolders of '.gambatte\palettes' to directly within '.gambatte\palettes'

-----------------------------------------------------------------------------------------

*HERETIC:

-Shareware datafile is included
-To play the full version, copy the retail HERTIC.WAD to 'games\hheretic\'

-----------------------------------------------------------------------------------------

*HEXEN:

-Shareware datafile is included
-To play the full version, copy the retail HEXEN.WAD to 'games\hhexen\'

-----------------------------------------------------------------------------------------

*SOD:

-Shareware datafiles are included
-To play the retail/full version of Spear of Destiny:

	-Copy the retail SOD datafiles (all .SOD files other than config.SOD) to 'games\sod\'
	-In the same folder:
		-Delete (or rename) the file 'sod'
		-Rename the file 'sod-Retail' to 'sod'

The SOD icon on the games tab of your bittboy will now load the full game instead of the shareware version.

-----------------------------------------------------------------------------------------

*STRIFE:

-Only the full version datafile (STRIFE1.WAD) is supported
-To play strife:
	-Copy the 'STRIFE1.WAD' datafile from a full copy of the game to 'games\ccdoom'

-----------------------------------------------------------------------------------------

*Wolf3D:

-Shareware datafiles are included
-To play the retail/full version of Wolfenstein 3D:

	-Copy the retail Wolf3D datafiles (all .WL6 files other than config.WL6) to 'games\wolf3d\'
	-In the same folder:
		-Delete (or rename) the file 'wolf3d'
		-Rename the file 'wolf3d-Retail' to 'wolf3d'

The Wolf3D icon on the games tab of your bittboy will now load the full game instead of the shareware version.