From 1fdbf418dd9c6e997a46e0b771e9a6a606b9b028 Mon Sep 17 00:00:00 2001
From: Bastien Bouclet
Date: Tue, 7 Jun 2011 20:10:03 +0200
Subject: PS3: Added a readme

---
 dists/ps3/readme-ps3.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 dists/ps3/readme-ps3.md

(limited to 'dists/ps3')

diff --git a/dists/ps3/readme-ps3.md b/dists/ps3/readme-ps3.md
new file mode 100644
index 0000000000..2fb393b4fb
--- /dev/null
+++ b/dists/ps3/readme-ps3.md
@@ -0,0 +1,49 @@
+Prerequisites
+=============
+- A homebrew enabled PlayStation 3 console. As of now that mostly means having a custom firmware installed. Obtaining and installing such a software is out of the scope of this document. Sorry, but you're on your own for that one.
+- At least one ScummVM supported game. The list of compatible games can be seen here: http://www.scummvm.org/compatibility/
+The page http://wiki.scummvm.org/index.php/Where_to_get_the_games references some places where those games can be bought. Demonstration versions for most of the supported games are downloadable on http://scummvm.org/demos/
+- An USB drive.
+
+Installing
+==========
+From a computer, download the installable package of the PS3 port from ScummVM's main site. It should be a .pkg file. Copy it to an USB drive.
+After having plugged the USB drive to you PS3, the installation package should appear in the XMB under the "Games > Install Package" menu. Installing it copies ScummVM and its dependencies to your PS3's hard drive. It also adds the "Games > PlayStation 3 > ScummVM" XMB entry which is to be used to launch ScummVM.
+
+Configuring and playing games
+=============================
+The user manual describes how to add games to ScummVM and launch them : http://wiki.scummvm.org/index.php/User_Manual
+
+PlayStation 3 Specifics
+=======================
+Games can be launched either from an USB drive or from the internal hard drive. The internal hard drive has better performance though.
+Savegames are wrote in the /hdd0/game/SCUM12000/saves folder.
+
+Joypad button mapping
+=====================
+- Left stick => Mouse
+- Cross      => Left mouse button
+- Circle     => Right mouse button
+- Triangle   => Game menu (F5)
+- Square     => Escape
+- Start      => ScummVM's in global game menu
+- Select     => Toggle virtual keyboard
+- L1         => AGI predictive input dialog
+
+Disclaimer
+==========
+Unauthorized distribution of an installable package with non freeware games included is a violation of the copyright law and is as such forbidden.
+
+Building from source
+====================
+This port of ScummVM to the PS3 is based on SDL. It uses the open source SDK PSL1GHT.
+
+The dependencies needed to build it are :
+
+- The toolchain from https://github.com/ps3dev/ps3toolchain
+- SDL from https://github.com/zeldin/SDL_PSL1GHT
+- ScummVM from https://github.com/scummvm/scummvm
+
+Once all the dependencies are correctly setup, an installable package can be obtained from source by issuing the following command :
+
+./configure --host=ps3 && make ps3pkg
-- 
cgit v1.2.3