aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCameron Cawley2018-12-27 15:20:22 +0000
committerMatan Bareket2018-12-27 10:34:27 -0500
commit97b498a7d781c78597ecca2089e6086197d016fb (patch)
treecdec402d33ffdf000b29a5c2b008cac1af981ebf /README.md
parent27699a2e71877ae4ccc4497b7a69c483672e0d95 (diff)
downloadscummvm-rg350-97b498a7d781c78597ecca2089e6086197d016fb.tar.gz
scummvm-rg350-97b498a7d781c78597ecca2089e6086197d016fb.tar.bz2
scummvm-rg350-97b498a7d781c78597ecca2089e6086197d016fb.zip
README: Clean up formatting, update URLs to use HTTPS, update supported platforms list
Diffstat (limited to 'README.md')
-rw-r--r--README.md170
1 files changed, 95 insertions, 75 deletions
diff --git a/README.md b/README.md
index 9997393ba7..584173a3e5 100644
--- a/README.md
+++ b/README.md
@@ -209,7 +209,7 @@ We've compiled a list of F.A.Q. at:
## 2.0) Contact
The easiest way to contact the ScummVM team is by submitting bug reports
-(see section 2.1) or by using our forums at <http://forums.scummvm.org>.
+(see section 2.1) or by using our forums at <https://forums.scummvm.org>.
You can also join and e-mail the scummvm-devel mailing list, or chat
with us on IRC (\#scummvm on irc.freenode.net) Please do not ask us to
support an unsupported game -- read the FAQ on our web site first.
@@ -226,7 +226,7 @@ our website for that game, to ensure the issue is not already known:
Please do not report bugs for games that are not listed as being
completeable in the 'Supported Games' section, or compatibility list. We
--know- those games have bugs.
+_know_ those games have bugs.
Please include the following information:
@@ -323,8 +323,7 @@ supported games can be found here:
| Mixed-Up Mother Goose | \[mixedup\] |
| Manhunter 1: New York | \[mh1\] |
| Manhunter 2: San Francisco | \[mh2\] |
-| Police Quest I: In Pursuit of the Death | |
-| Angel | \[pq1\] |
+| Police Quest I: In Pursuit of the Death Angel | \[pq1\] |
| Space Quest I: The Sarien Encounter | \[sq1\] |
| Space Quest II: Vohaul's Revenge | \[sq2\] |
| Fanmade Games | \[agi-fanmade\] |
@@ -760,7 +759,7 @@ may also use the re-encoded cutscenes mentioned below instead, but this
will not work for all videos in Broken Sword II. For more information,
see:
-<http://wiki.scummvm.org/index.php/HOWTO-PlayStation_Videos>
+<https://wiki.scummvm.org/index.php/HOWTO-PlayStation_Videos>
Some re-releases of the games, as well as the PlayStation version, do
not have Smacker videos. Revolution Software has kindly allowed us to
@@ -873,7 +872,7 @@ In order to run the Mac OS X Wyrmkeep re-release of the game you will
need to copy over data from the CD to your hard disk. If you're on a PC
then consult:
-<http://wiki.scummvm.org/index.php/HOWTO-Mac_Games>
+<https://wiki.scummvm.org/index.php/HOWTO-Mac_Games>
Although it primarily talks about SCUMM games, it mentions the
"HFSExplorer" utility which you need to extract the files. Note that you
@@ -1264,7 +1263,7 @@ nor recommended.
For further information on copying Macintosh game files to your hard
disk see:
-<http://wiki.scummvm.org/index.php/HOWTO-Mac_Games>
+<https://wiki.scummvm.org/index.php/HOWTO-Mac_Games>
## 4.0) Supported Platforms
@@ -1283,18 +1282,25 @@ Supported platforms include (but are not limited to):
- Mac OS X
- AmigaOS
- Android
+ - Atari/FreeMiNT
- BeOS
- Dreamcast
- GP2x
+ - Haiku
- iPhone (also includes iPod Touch and iPad)
- Maemo (Nokia Internet tablet N810)
- Nintendo 64
- Nintendo DS
- Nintendo GameCube
- Nintendo Wii
+ - OpenPandora
- OS/2
- PlayStation 2
+ - PlayStation 3
- PlayStation Portable
+ - PlayStation Vita
+ - Raspberry Pi
+ - RISC OS
- Symbian
- WebOS
@@ -1303,14 +1309,14 @@ Dig. The Nintendo DS port does not support Full Throttle, The Dig, or
The Curse of Monkey Island. For more platform specific limitations,
please refer to our Wiki:
-<http://wiki.scummvm.org/index.php/Platforms>
+<https://wiki.scummvm.org/index.php/Platforms>
In the Macintosh port, the right mouse button is emulated via Cmd-Click
(that is, you click the mouse button while holding the
Command/Apple/Propeller key).
There are unofficial ports to a variety of platforms, including the
-PlayStation 3, Xbox, and Xbox 360. Please note that these are not made
+Xbox, and Xbox 360. Please note that these are not made
by us, so we neither endorse nor can we support them. Use at your own
risk\!
@@ -1840,7 +1846,7 @@ The platforms that currently have a different default directory are:
**Mac OS X:**
-$HOME/Documents/ScummVM Savegames/
+`$HOME/Documents/ScummVM Savegames/`
**Other unices:**
@@ -1914,18 +1920,18 @@ original versions.
- Add 8 bytes (saved game name) to the start of the saved game
file
- - Rename the saved game to 'elvira2-pc.xxx' (DOS version) or
+ - Rename the saved game to `elvira2-pc.xxx` (DOS version) or
`elvira2.xxx` (Other versions)
- Myst
- - Rename the saved game to 'myst-xxx.mys'
+ - Rename the saved game to `myst-xxx.mys`
- Saves from the masterpiece edition and the regular edition are
interchangeable
- Riven
- - Rename the saved game to 'riven-xxx.rvn'
+ - Rename the saved game to `riven-xxx.rvn`
- Saves from the CD and DVD edition are not interchangeable
- Simon the Sorcerer 1
@@ -2539,8 +2545,7 @@ An example config file looks as follows:
### 8.1) Recognized configuration keywords
-The following keywords are
- recognized:
+The following keywords are recognized:
path string The path to where a game's data files are
autosave_period number The seconds between autosaving (default: 300)
@@ -2626,8 +2631,7 @@ The following keywords are
boot_param number Pass this number to the boot script
-Sierra games using the AGI engine add the following non-standard
-keywords:
+Sierra games using the AGI engine add the following non-standard keywords:
originalsaveload bool If true, the original save/load screens are
used instead of the enhanced ScummVM ones
@@ -2636,8 +2640,7 @@ keywords:
mousesupport bool Enables mouse support. Allows to use mouse
for movement and in game menus
-Sierra games using the SCI engine add the following non-standard
-keywords:
+Sierra games using the SCI engine add the following non-standard keywords:
disable_dithering bool Remove dithering artifacts from EGA games
prefer_digitalsfx bool If true, digital sound effects are preferred
@@ -2667,16 +2670,17 @@ Flight of the Amazon Queen adds the following non-standard keywords:
music_mute bool If true, music is muted
sfx_mute bool If true, sound effects are muted
-Hopkins FBI adds the following non-standard keyword: enable\_gore bool
-If true, enable some optional gore content in the game
+Hopkins FBI adds the following non-standard keyword:
+
+ enable_gore bool If true, enable some optional gore content in
+ the game
Jones in the Fast Lane adds the following non-standard keyword:
music_mute bool If true, CD audio is used, if available,
instead of in-game audio
-King's Quest VI Windows adds the following non-standard
- keyword:
+King's Quest VI Windows adds the following non-standard keyword:
windows_cursors bool If true, the original unscaled black and white
Windows cursors are used instead of the DOS
@@ -2684,8 +2688,7 @@ King's Quest VI Windows adds the following non-standard
Windows version, upscaled to match the rest of
the upscaled graphics
-Lands of Lore: The Throne of Chaos adds the following non-standard
-keywords:
+Lands of Lore: The Throne of Chaos adds the following non-standard keywords:
smooth_scrolling bool If true, scrolling is smoother when changing
from one screen to another
@@ -2696,19 +2699,19 @@ keywords:
Space Quest IV CD adds the following non-standard keyword:
-```
- silver_cursors bool If true, an alternate set of silver mouse
- cursors is used instead of the original golden
- ones
-```
+ silver_cursors bool If true, an alternate set of silver mouse
+ cursors is used instead of the original golden
+ ones
Simon the Sorcerer 1 and 2 add the following non-standard keywords:
music_mute bool If true, music is muted
sfx_mute bool If true, sound effects are muted
-Soltys adds the following non-standard keyword: enable\_color\_blind
-bool If true, original colors are replaced by a set of greys
+Soltys adds the following non-standard keyword:
+
+ enable_color_blind bool If true, original colors are replaced by a set
+ of greys
The Legend of Kyrandia adds the following non-standard keyword:
@@ -2720,8 +2723,8 @@ keyword:
walkspeed number The walk speed (3 or 5, resp. fast or
slow)
-The Legend of Kyrandia: Malcolm's Revenge adds the following
-non-standard keywords:
+The Legend of Kyrandia: Malcolm's Revenge adds the following non-standard
+keywords:
walkspeed number The walk speed (3 or 5, resp. fast or
slow)
@@ -2731,8 +2734,7 @@ non-standard keywords:
helium_mode bool If true, people sound like they've inhaled
Helium
-The Neverhood adds the following non-standard
- keywords:
+The Neverhood adds the following non-standard keywords:
originalsaveload bool If true, the original save/load screens are
used instead of the enhanced ScummVM ones
@@ -2742,8 +2744,7 @@ The Neverhood adds the following non-standard
scalemakingofvideos bool If true, the making of videos are scaled, so that
they use the whole screen
-The 7th Guest adds the following non-standard
- keyword:
+The 7th Guest adds the following non-standard keyword:
fast_movie_speed bool If true, movies are played at an increased
speed, matching the speed of the iOS version.
@@ -2751,8 +2752,7 @@ The 7th Guest adds the following non-standard
normal speed, to avoid music synchronization
issues
-Zork Nemesis: The Forbidden Lands adds the following non-standard
-keywords:
+Zork Nemesis: The Forbidden Lands adds the following non-standard keywords:
originalsaveload bool If true, the original save/load screens are
used instead of the enhanced ScummVM ones
@@ -2762,8 +2762,7 @@ keywords:
noanimwhileturning bool If true, animations are disabled while turning
in panoramic mode
-Zork: Grand Inquisitor adds the following non-standard
- keywords:
+Zork: Grand Inquisitor adds the following non-standard keywords:
originalsaveload bool If true, the original save/load screens are
used instead of the enhanced ScummVM ones
@@ -2802,7 +2801,7 @@ file, depends on the OS:
- Windows: In `Users\username\My Pictures\ScummVM Screenshots`.
- macOS X: On the Desktop.
- Other unices: In the XDG Pictures user directory,
- e.g. ~/Pictures/ScummVM Screenshots
+ e.g. `~/Pictures/ScummVM Screenshots`
- Any other OS: In the current directory.
## 10.0) Compiling
@@ -2810,7 +2809,7 @@ file, depends on the OS:
For an up-to-date overview on how to compile ScummVM for various
platforms, please consult our Wiki, in particular this page:
-<http://wiki.scummvm.org/index.php/Compiling_ScummVM>
+<https://wiki.scummvm.org/index.php/Compiling_ScummVM>
If you are compiling for Windows, Linux or Mac OS X, you need SDL-1.2.2
or newer (older versions may work, but are unsupported), and a supported
@@ -2832,93 +2831,114 @@ debug messages (see
- Windows:
- - MinGW Please refer to:
- <http://wiki.scummvm.org/index.php/Compiling_ScummVM/MinGW>
- - Visual Studio (MSVC) Please refer to:
- <http://wiki.scummvm.org/index.php/Compiling_ScummVM/Visual_Studio>
+ - MinGW:
+
+ - Please refer to:
+ <https://wiki.scummvm.org/index.php/Compiling_ScummVM/MinGW>
+
+ - Visual Studio (MSVC):
+
+ - Please refer to:
+ <https://wiki.scummvm.org/index.php/Compiling_ScummVM/Visual_Studio>
- Linux:
- - GCC Please refer to:
- <http://wiki.scummvm.org/index.php/Compiling_ScummVM/GCC>
+ - GCC:
+
+ - Please refer to:
+ <https://wiki.scummvm.org/index.php/Compiling_ScummVM/GCC>
- AmigaOS4:
- Please refer to:
- <http://wiki.scummvm.org/index.php/Compiling_ScummVM/AmigaOS4>
+ <https://wiki.scummvm.org/index.php/Compiling_ScummVM/AmigaOS4>
- Apple iPhone:
- Please refer to:
- <http://wiki.scummvm.org/index.php/Compiling_ScummVM/iPhone>
+ <https://wiki.scummvm.org/index.php/Compiling_ScummVM/iPhone>
- Atari/FreeMiNT:
- Please refer to:
- <http://wiki.scummvm.org/index.php/Compiling_ScummVM/Atari/FreeMiNT>
+ <https://wiki.scummvm.org/index.php/Compiling_ScummVM/Atari/FreeMiNT>
- Bada/Tizen:
- Please refer to:
- <http://wiki.scummvm.org/index.php/Compiling_ScummVM/Bada/Tizen>
+ <https://wiki.scummvm.org/index.php/Compiling_ScummVM/Bada/Tizen>
- BeOS/ZETA/Haiku:
- Please refer to:
- <http://wiki.scummvm.org/index.php/Compiling_ScummVM/BeOS/ZETA/Haiku>
+ <https://wiki.scummvm.org/index.php/Compiling_ScummVM/BeOS/ZETA/Haiku>
- Google Android:
- Please refer to:
- <http://wiki.scummvm.org/index.php/Compiling_ScummVM/Android>
+ <https://wiki.scummvm.org/index.php/Compiling_ScummVM/Android>
- HP webOS:
- Please refer to:
- <http://wiki.scummvm.org/index.php/Compiling_ScummVM/WebOS>
+ <https://wiki.scummvm.org/index.php/Compiling_ScummVM/WebOS>
- Mac OS:
- - Mac OS X Please refer to:
- <http://wiki.scummvm.org/index.php/Mac_OS_X>
- - Mac OS X 10.2.8 Please refer to:
- <http://wiki.scummvm.org/index.php/Compiling_ScummVM/Mac_OS_X_10.2.8>
- - Mac OS X Crosscompiling Please refer to:
- <http://wiki.scummvm.org/index.php/Compiling_ScummVM/Mac_OS_X_Crosscompiling>
+ - Mac OS X:
+
+ - Please refer to:
+ <https://wiki.scummvm.org/index.php/Compiling_ScummVM/macOS>
+
+ - Mac OS X 10.2.8:
+
+ - Please refer to:
+ <https://wiki.scummvm.org/index.php/Compiling_ScummVM/Mac_OS_X_10.2.8>
+
+ - Mac OS X Crosscompiling:
+
+ - Please refer to:
+ <httpe://wiki.scummvm.org/index.php/Compiling_ScummVM/Mac_OS_X_Crosscompiling>
- Maemo:
- Please refer to:
- <http://wiki.scummvm.org/index.php/Compiling_ScummVM/Maemo>
+ <https://wiki.scummvm.org/index.php/Compiling_ScummVM/Maemo>
- Nintendo Wii and Gamecube:
- Please refer to:
- <http://wiki.scummvm.org/index.php/Compiling_ScummVM/Wii>
+ <https://wiki.scummvm.org/index.php/Compiling_ScummVM/Wii>
- - RaspberryPi:
+ - Raspberry Pi:
- Please refer to:
- <http://wiki.scummvm.org/index.php/Compiling_ScummVM/RPI>
+ <https://wiki.scummvm.org/index.php/Compiling_ScummVM/RPI>
- Sega Dreamcast:
- Please refer to:
- <http://wiki.scummvm.org/index.php/Compiling_ScummVM/Dreamcast>
+ <https://wiki.scummvm.org/index.php/Compiling_ScummVM/Dreamcast>
- Sony Playstation:
- - Sony PlayStation 2 Please refer to:
- <http://wiki.scummvm.org/index.php/Compiling_ScummVM/PlayStation_2>
- - Sony PlayStation 3 Please refer to:
- <http://wiki.scummvm.org/index.php/PlayStation_3#Building_from_source>
- - Sony PlayStation Portable Please refer to:
- <http://wiki.scummvm.org/index.php/Compiling_ScummVM/PlayStation_Portable>
+ - Sony PlayStation 2:
+
+ - Please refer to:
+ <https://wiki.scummvm.org/index.php/Compiling_ScummVM/PlayStation_2>
+
+ - Sony PlayStation 3:
+ - Please refer to:
+ <https://wiki.scummvm.org/index.php/PlayStation_3#Building_from_source>
+
+ - Sony PlayStation Portable:
+ - Please refer to:
+ <https://wiki.scummvm.org/index.php/Compiling_ScummVM/PlayStation_Portable>
- Symbian:
- Please refer to:
- <http://wiki.scummvm.org/index.php/Compiling_ScummVM/Symbian>
+ <https://wiki.scummvm.org/index.php/Compiling_ScummVM/Symbian>
## 11.0) Credits