Mercurial > repos > blastem

comparison README @ 1017:216fa63749b3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added documentation for lock-on support and a fullscreen config option.
author Michael Pavone <pavone@retrodev.com>
date Mon, 02 May 2016 21:35:19 -0700
parents ef923c4b8977
children 58e3d50f6a4e
comparison
equal deleted inserted replaced
1016:5fb64487b6e1 1017:216fa63749b3
24 ./blastem -h 24 ./blastem -h
25 25
26 From within your BlastEm directory. On Windows type: 26 From within your BlastEm directory. On Windows type:
27 27
28 blastem.exe -h 28 blastem.exe -h
29
30 Lock-On Support
31 ---------------
32
33 This version of BlastEm has some preliminary support for Sonic & Knuckles lock
34 on technology. This is only available from the command line at the moment. To
35 use it specify the Sonic & Knuckles ROM as the primary ROM and specify the ROM
36 to be locked on using the -o option. As an example:
37
38 ./blastem ~/romz/sonic_and_knuckles.bin -o ~/romz/sonic3.bin
39
40 Please note that Sonic 2 lock-on does not work at this time. Additionally the
41 save RAM added by Sonic 3 won't work either.
29 42
30 Configuration 43 Configuration
31 ------------- 44 -------------
32 45
33 Configuration is read from the file at $HOME/.config/blastem/blastem.cfg if it 46 Configuration is read from the file at $HOME/.config/blastem/blastem.cfg if it
103 "off" as BlastEm synchronizes to audio and does not yet have the necessary code 116 "off" as BlastEm synchronizes to audio and does not yet have the necessary code
104 to fully handle conflicts between the audio rate and monitor refresh rate. 117 to fully handle conflicts between the audio rate and monitor refresh rate.
105 Additionally, the "turbo" feature does not function properly with vsync 118 Additionally, the "turbo" feature does not function properly with vsync
106 enabled. These issues will be addressed in a future release. If you wish to use 119 enabled. These issues will be addressed in a future release. If you wish to use
107 vsync, please see the VSync section at the bottom of the README. 120 vsync, please see the VSync section at the bottom of the README.
121
122 "fullscreen" controls whether BlastEm starts in fullscreen or windowed mode.
123 This can be overridden on the command line with the -f flag. If fullscreen
124 is set to "off", -f will turn it on. Conversely, if fullscreen is set to "on"
125 in the config, -f will turn it off.
108 126
109 Audio 127 Audio
110 ----- 128 -----
111 129
112 The audio section contains settings that affect the audio output of BlastEm. 130 The audio section contains settings that affect the audio output of BlastEm.