summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMichael Pavone <pavone@retrodev.com>2016-05-02 21:35:19 -0700
committerMichael Pavone <pavone@retrodev.com>2016-05-02 21:35:19 -0700
commita4448282d609d6f766113272e64620ad45aaeedb (patch)
tree6a19df361c9c6bc2bfa674a43cec4dec50be1679 /README
parent8ae355e07f2b452cb5bef4afbf451f02df02349e (diff)
Added documentation for lock-on support and a fullscreen config option.
Diffstat (limited to 'README')
-rw-r--r--README18
1 files changed, 18 insertions, 0 deletions
diff --git a/README b/README
index 77f5938..97f5dfa 100644
--- a/README
+++ b/README
@@ -26,6 +26,19 @@ list of supported command line options on Linux or OSX type:
From within your BlastEm directory. On Windows type:
blastem.exe -h
+
+Lock-On Support
+---------------
+
+This version of BlastEm has some preliminary support for Sonic & Knuckles lock
+on technology. This is only available from the command line at the moment. To
+use it specify the Sonic & Knuckles ROM as the primary ROM and specify the ROM
+to be locked on using the -o option. As an example:
+
+ ./blastem ~/romz/sonic_and_knuckles.bin -o ~/romz/sonic3.bin
+
+Please note that Sonic 2 lock-on does not work at this time. Additionally the
+save RAM added by Sonic 3 won't work either.
Configuration
-------------
@@ -106,6 +119,11 @@ Additionally, the "turbo" feature does not function properly with vsync
enabled. These issues will be addressed in a future release. If you wish to use
vsync, please see the VSync section at the bottom of the README.
+"fullscreen" controls whether BlastEm starts in fullscreen or windowed mode.
+This can be overridden on the command line with the -f flag. If fullscreen
+is set to "off", -f will turn it on. Conversely, if fullscreen is set to "on"
+in the config, -f will turn it off.
+
Audio
-----