README.PSP
1ScummVM-PSP 2.1.1 README
2
3Installation
4============
5 - Copy the relevant game datafiles to your memory stick (location doesn't matter).
6 - Install ScummVM like any other homebrew.
7 - Run ScummVM and use the launcher to add games and run them.
8 - Press Start to return to the launcher and play another game.
9
10Controls
11========
12Right trigger - Modifier key (see below for uses)
13Left trigger - ESC (Usually skips cutscenes. Depends on game)
14Analog - Mouse movement
15Right trigger + Analog - Fine mouse movement
16D-Pad - Arrow keys (useful mostly in SCI and AGI games)
17D-Pad + Right Trigger - Diagonal arrow keys (it's hard to input diagonals on some PSPs)
18Triangle - Enter (useful for some dialogs)
19Cross - Left Mouse Button (usually the main button)
20Circle - Right Mouse Button (secondary button in some games)
21Square - '.' (skip dialogue in some games e.g. Scumm)
22Right trigger + Square - Spacebar (useful in Gobli*ns and SCI games)
23Right trigger + Start - F5 (Main Menu in some games)
24Select - Show/Hide Virtual Keyboard. Hold down to move keyboard onscreen (with D-Pad).
25Right trigger + Select - Show Image Viewer (see below)
26Start - Global Menu. Allows you to 'Return To Launcher' to play another game
27
28Virtual Keyboard Mode
29=====================
30Start - Enter key. Also exits virtual keyboard mode
31Select - Exit the virtual keyboard mode
32Right trigger - Input letters: lowercase/uppercase (press to toggle)
33Left trigger - Input numbers/symbols (press to toggle)
34D-Pad - Select square of characters (up, down, left or right)
35Buttons/Triggers - Choose a specific character in the square. The four center characters are chosen
36 by the button in the corresponding position. The 2 top characters are chosen by the
37 triggers.
38Analog - Moves in a direction (left/right/up/down) (Useful to keep moving
39 while typing in AGI games among other things)
40
41
42Image Viewer
43============
44For your convenience, I've included a simple image viewer in the PSP port.
45You can view anything you want while playing a game.
46There are a few simple rules to follow:
47
48- Images must be of PNG format. If you have images in another format, many
49 graphics utilities will convert them for you.
50- Images must be named psp_image1.png, psp_image2.png etc. This is to make
51 sure there's no possible conflict between image files and game files.
52- Images must be placed in the game directories. When using the image viewer,
53 only the images of the particular game being played will be available for viewing.
54- Don't place any images in the ScummVM directory, or you won't be able to see
55 the images in the game directories.
56- There's no guarantee that you'll be able to view your image. This is because
57 big images take a lot of memory (more than the size of the image on disk). If there
58 isn't enough memory left to show the image, ScummVM will tell you so. Try to make the
59 image smaller by either shrinking it or reducing the colors to 256 color palette mode.
60
61Image Viewer Controls:
62=====================
63Left/Right - previous/next image (e.g. go from psp_image1.png to psp_image2.png)
64Up/down - zoom in/out
65Analog - move around the image
66Triggers, Start: - exit image viewer
67
68
691st Person Game Mode (Can be ignored by most users)
70====================
71This is a special mode built for 1st person games like Lands of Lore. If you don't have these games you can
72safely ignore this mode. To enter or leave this mode, use the combo:
73
74Right Trigger + Left Trigger + Square
75
76Some buttons have been switched around to make these games more playable:
77Square - Is the modifier key instead of Right Trigger.
78Left/Right Trigger - Strafe left/right
79D-Pad Left/Right - Turn left/right
80Square + D-Pad - F1/F2/F3/F4
81Square + Select - Image Viewer
82Square + Start - Esc (shows game menu)
83
84
85Notes
86=====
87- Notice that you can switch between games! This is much faster than quitting
88 and having to start ScummVM all over again. Go to the global menu and choose 'Return To Launcher'.
89 (Some games may not have the Return To Launcher option available yet.)
90
91- The PSP version of ScummVM uses the Media Engine to accelerate decoding of MP3 files. This means
92 that if you have the choice of compressing using Ogg files or MP3 files, choose MP3 -- the game
93 will generally run faster.
94
95- Plugin files are NOT interchangeable between ScummVM versions! You must copy ALL the
96 plugin files that come with every version of ScummVM. They sit in the /plugin
97 subdirectory. If you get a crash upon startup, try deleting all the existing
98 plugin files in the plugin directory and copying the new ones over again.
99
100- This README may be outdated, for more up-to-date instructions and notes see
101 the PSP Port Wiki: https://wiki.scummvm.org/index.php/PlayStation_Portable
102
103Frequently Asked Questions
104==========================
105
106Q: Scummvm crashes upon starting up!
107A: See the first note above.
108
109Q: Pressing select doesn't make the virtual keyboard show up on screen!
110A: You need to make sure that the kbd.zip file is in the same directory as the ScummVM executable.
111
112Q: What do I need to run the games?
113A: A PSP that can run homebrew and the necessary datafiles for the game you want to play.
114
115Q: Can I run game X with this?
116A: You can find the list of supported games on the compatibility page
117 at https://www.scummvm.org
118 Note that ScummVM is NOT an emulator. The supported games engines have been painstakingly rewritten.
119 It's not easy to add support for a game you want that currently isn't supported.
120
121Q: My Monkey Island 1 doesn't have any music, what gives?
122A: If your version of Monkey Island came on a CD then it has the music
123 as CD Audio tracks. You need to rip those to MP3/Ogg (MP3 is preferred), naming them track1.mp3 track2.mp3
124 etc. and copy them to the same directory as the game datafiles for music to work.
125
126Q: Game X crashes, or feature Y doesn't work. Can you fix this?
127A: Possibly.
128 Because of the large amount of games ScummVM supports we obviously haven't
129 played them all start-to-finish on the PSP, so it's possible there
130 are bugs or issues that we're not aware of.
131 When you encounter such a bug, please use the "Bug Tracker" you find linked
132 on the ScummVM website, and mention all relevant info i.e. that you're
133 using the PSP version, which ScummVM version it is, if the problem exists
134 in a recent PC version, a detailed description of the problem,
135 and if at all possible a nearby savegame. This will make it much easier
136 for us to reproduce (and hopefully fix) the problem.
137
138Building the source code
139========================
140To build ScummVM for PSP you need:
141
142- ScummVM source code (git clone https://github.com/scummvm/scummvm.git)
143
144- PSP toolchain (svn co svn://svn.pspdev.org/psp/trunk/psptoolchain)
145
146- PSPSDK (svn co svn://svn.pspdev.org/psp/trunk/pspsdk)
147 Note: This usually gets installed by the PSP toolchain,
148 so you don't have to do it manually.
149
150- zlib (svn co svn://svn.pspdev.org/psp/trunk/zlib)
151
152- libPNG (svn co svn://svn.pspdev.org/psp/trunk/libpng)
153
154- libmad(*) (svn co svn://svn.pspdev.org/psp/trunk/libmad)
155
156- libTremor(*) (svn co svn://svn.pspdev.org/psp/trunk/libTremor)
157
158(*) = optional
159
160Once you've installed these libraries (read their README.PSP for instructions),
161create a subdirectory in your ScummVM folder called 'builds/psp'. Then, in this folder, type
162'../../configure --host=psp --enable-plugins --default-dynamic'. If everything is installed
163correctly, ScummVM will inform you as it finds the right components. Finally type 'make' to build.
164
165Port Authors
166============
167Joost Peters (joostp@scummvm.org)
168Paolo Costabel (paoloc@pacbell.net)
169Thomas Mayer (tommybear@internode.on.net)
170Yotam Barnoy (yotambarnoy@gmail.com)
171
README.PSP.in
1ScummVM-PSP @VERSION@ README
2==============================================================================
3
4Installation
5============
6 - Copy the relevant game datafiles to your memory stick (location doesn't matter).
7 - Install ScummVM like any other homebrew.
8 - Run ScummVM and use the launcher to add games and run them.
9 - Press Start to return to the launcher and play another game.
10
11Controls
12========
13Right trigger - Modifier key (see below for uses)
14Left trigger - ESC (Usually skips cutscenes. Depends on game)
15Analog - Mouse movement
16Right trigger + Analog - Fine mouse movement
17D-Pad - Arrow keys (useful mostly in SCI and AGI games)
18D-Pad + Right Trigger - Diagonal arrow keys (it's hard to input diagonals on some PSPs)
19Triangle - Enter (useful for some dialogs)
20Cross - Left Mouse Button (usually the main button)
21Circle - Right Mouse Button (secondary button in some games)
22Square - '.' (skip dialogue in some games e.g. Scumm)
23Right trigger + Square - Spacebar (useful in Gobli*ns and SCI games)
24Right trigger + Start - F5 (Main Menu in some games)
25Select - Show/Hide Virtual Keyboard. Hold down to move keyboard onscreen (with D-Pad).
26Right trigger + Select - Show Image Viewer (see below)
27Start - Global Menu. Allows you to 'Return To Launcher' to play another game
28
29Virtual Keyboard Mode
30=====================
31Start - Enter key. Also exits virtual keyboard mode
32Select - Exit the virtual keyboard mode
33Right trigger - Input letters: lowercase/uppercase (press to toggle)
34Left trigger - Input numbers/symbols (press to toggle)
35D-Pad - Select square of characters (up, down, left or right)
36Buttons/Triggers - Choose a specific character in the square. The four center characters are chosen
37 by the button in the corresponding position. The 2 top characters are chosen by the
38 triggers.
39Analog - Moves in a direction (left/right/up/down) (Useful to keep moving
40 while typing in AGI games among other things)
41
42
43Image Viewer
44============
45For your convenience, I've included a simple image viewer in the PSP port.
46You can view anything you want while playing a game.
47There are a few simple rules to follow:
48
49- Images must be of PNG format. If you have images in another format, many
50 graphics utilities will convert them for you.
51- Images must be named psp_image1.png, psp_image2.png etc. This is to make
52 sure there's no possible conflict between image files and game files.
53- Images must be placed in the game directories. When using the image viewer,
54 only the images of the particular game being played will be available for viewing.
55- Don't place any images in the ScummVM directory, or you won't be able to see
56 the images in the game directories.
57- There's no guarantee that you'll be able to view your image. This is because
58 big images take a lot of memory (more than the size of the image on disk). If there
59 isn't enough memory left to show the image, ScummVM will tell you so. Try to make the
60 image smaller by either shrinking it or reducing the colors to 256 color palette mode.
61
62Image Viewer Controls:
63=====================
64Left/Right - previous/next image (e.g. go from psp_image1.png to psp_image2.png)
65Up/down - zoom in/out
66Analog - move around the image
67Triggers, Start: - exit image viewer
68
69
701st Person Game Mode (Can be ignored by most users)
71====================
72This is a special mode built for 1st person games like Lands of Lore. If you don't have these games you can
73safely ignore this mode. To enter or leave this mode, use the combo:
74
75Right Trigger + Left Trigger + Square
76
77Some buttons have been switched around to make these games more playable:
78Square - Is the modifier key instead of Right Trigger.
79Left/Right Trigger - Strafe left/right
80D-Pad Left/Right - Turn left/right
81Square + D-Pad - F1/F2/F3/F4
82Square + Select - Image Viewer
83Square + Start - Esc (shows game menu)
84
85
86Notes
87=====
88- Notice that you can switch between games! This is much faster than quitting
89 and having to start ScummVM all over again. Go to the global menu and choose 'Return To Launcher'.
90 (Some games may not have the Return To Launcher option available yet.)
91
92- The PSP version of ScummVM uses the Media Engine to accelerate decoding of MP3 files. This means
93 that if you have the choice of compressing using Ogg files or MP3 files, choose MP3 -- the game
94 will generally run faster.
95
96- Plugin files are NOT interchangeable between ScummVM versions! You must copy ALL the
97 plugin files that come with every version of ScummVM. They sit in the /plugin
98 subdirectory. If you get a crash upon startup, try deleting all the existing
99 plugin files in the plugin directory and copying the new ones over again.
100
101- This README may be outdated, for more up-to-date instructions and notes see
102 the PSP Port Wiki: https://wiki.scummvm.org/index.php/PlayStation_Portable
103
104Frequently Asked Questions
105==========================
106
107Q: Scummvm crashes upon starting up!
108A: See the first note above.
109
110Q: Pressing select doesn't make the virtual keyboard show up on screen!
111A: You need to make sure that the kbd.zip file is in the same directory as the ScummVM executable.
112
113Q: What do I need to run the games?
114A: A PSP that can run homebrew and the necessary datafiles for the game you want to play.
115
116Q: Can I run game X with this?
117A: You can find the list of supported games on the compatibility page
118 at https://www.scummvm.org
119 Note that ScummVM is NOT an emulator. The supported games engines have been painstakingly rewritten.
120 It's not easy to add support for a game you want that currently isn't supported.
121
122Q: My Monkey Island 1 doesn't have any music, what gives?
123A: If your version of Monkey Island came on a CD then it has the music
124 as CD Audio tracks. You need to rip those to MP3/Ogg (MP3 is preferred), naming them track1.mp3 track2.mp3
125 etc. and copy them to the same directory as the game datafiles for music to work.
126
127Q: Game X crashes, or feature Y doesn't work. Can you fix this?
128A: Possibly.
129 Because of the large amount of games ScummVM supports we obviously haven't
130 played them all start-to-finish on the PSP, so it's possible there
131 are bugs or issues that we're not aware of.
132 When you encounter such a bug, please use the "Bug Tracker" you find linked
133 on the ScummVM website, and mention all relevant info i.e. that you're
134 using the PSP version, which ScummVM version it is, if the problem exists
135 in a recent PC version, a detailed description of the problem,
136 and if at all possible a nearby savegame. This will make it much easier
137 for us to reproduce (and hopefully fix) the problem.
138
139Building the source code
140========================
141To build ScummVM for PSP you need:
142
143- ScummVM source code (git clone https://github.com/scummvm/scummvm.git)
144
145- PSP toolchain (svn co svn://svn.pspdev.org/psp/trunk/psptoolchain)
146
147- PSPSDK (svn co svn://svn.pspdev.org/psp/trunk/pspsdk)
148 Note: This usually gets installed by the PSP toolchain,
149 so you don't have to do it manually.
150
151- zlib (svn co svn://svn.pspdev.org/psp/trunk/zlib)
152
153- libPNG (svn co svn://svn.pspdev.org/psp/trunk/libpng)
154
155- libmad(*) (svn co svn://svn.pspdev.org/psp/trunk/libmad)
156
157- libTremor(*) (svn co svn://svn.pspdev.org/psp/trunk/libTremor)
158
159(*) = optional
160
161Once you've installed these libraries (read their README.PSP for instructions),
162create a subdirectory in your ScummVM folder called 'builds/psp'. Then, in this folder, type
163'../../configure --host=psp --enable-plugins --default-dynamic'. If everything is installed
164correctly, ScummVM will inform you as it finds the right components. Finally type 'make' to build.
165
166Port Authors
167============
168Joost Peters (joostp@scummvm.org)
169Paolo Costabel (paoloc@pacbell.net)
170Thomas Mayer (tommybear@internode.on.net)
171Yotam Barnoy (yotambarnoy@gmail.com)
172
