Mercurial > repos > blastem

comparison README @ 1353:52d9e3c36b4f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update README to account for new config file options
author Michael Pavone <pavone@retrodev.com>
date Wed, 10 May 2017 19:23:59 -0700
parents 90c9922b5430
children 34798ad9c570
comparison
equal deleted inserted replaced
1352:90c9922b5430 1353:52d9e3c36b4f
138 behavior. Mouse events are ignored until you click in the window. The mouse 138 behavior. Mouse events are ignored until you click in the window. The mouse
139 will then be "captured" and the cursor will be both made invisible and locked 139 will then be "captured" and the cursor will be both made invisible and locked
140 to the window. The ui.release_mouse binding releases the mouse so it can be 140 to the window. The ui.release_mouse binding releases the mouse so it can be
141 used normally. 141 used normally.
142 142
143 UI Actions
144 ----------
145
146 This section lists the various "UI" actions that can be triggered by a key or
147 gamepad binding.
148
149 ui.release_mouse Releases the mouse if it is currently captured
150 ui.vdp_debug_mode Cycles through the various VDP debug views
151 ui.vdp_debug_pal Cycles through the selected palette when viewing
152 the VDP memory viewer
153 ui.enter_debugger Enters the debugger for the main CPU of the
154 currently emulated system
155 ui.screenshot Takes an internal screenshot
156 ui.exit Returns to the menu ROM if currently in a game
157 that was launched from the menu. Exits otherwise
158 ui.save_state Saves a savestate to the quicksave slot
159 ui.set_speed.N Selects a specific machine speed specified by N
160 which should be a number between 0-9. Speeds are
161 specified in the "clocks" section of the config
162 ui.next_speed Selects the next machine speed
163 ui.prev_speed Selects the previous machine speed
164 ui.toggle_fullscreen Toggles between fullscreen and windowed mode
165 ui.soft_reset Resets a portion of the emulated machine
166 Equivalent to pushing the reset button on the
167 emulated device
168 ui.toggle_keyboard_captured Toggles the capture state of the host keyboard
169 when an emulated keyboard is present
170
143 IO 171 IO
144 -- 172 --
145 173
146 This section controls which peripherals are attached to the emulated console. 174 This section controls which peripherals are attached to the emulated console.
147 IO assignments can be overridden by the ROM database when appropriate. For 175 IO assignments can be overridden by the ROM database when appropriate. For
153 Video 181 Video
154 ----- 182 -----
155 183
156 The video section contains settings that affect the visual output of BlastEm. 184 The video section contains settings that affect the visual output of BlastEm.
157 185
186 "aspect" is used to control the aspect ratio of the emulated display. The
187 default of 4:3 matches that of a standard definition television.
188
158 "width" is used to control the window size when not in fullscreen mode. The 189 "width" is used to control the window size when not in fullscreen mode. The
159 height of the window is calculated from this value. Both width and height can 190 height of the window is calculated from this value and "aspect". Both width
160 be overridden from the command line. 191 and height can be overridden from the command line.
161 192
162 "vertex_shader" and "fragment_shader" define the GLSL shader program that 193 "vertex_shader" and "fragment_shader" define the GLSL shader program that
163 produces the final image for each frame. Shaders can be used to add various 194 produces the final image for each frame. Shaders can be used to add various
164 visual effects or enhancements. Currently BlastEm only ships with the default 195 visual effects or enhancements. Currently BlastEm only ships with the default
165 shader. If you write your own shaders, place them in 196 shader. If you write your own shaders, place them in
184 "fullscreen" controls whether BlastEm starts in fullscreen or windowed mode. 215 "fullscreen" controls whether BlastEm starts in fullscreen or windowed mode.
185 This can be overridden on the command line with the -f flag. If fullscreen 216 This can be overridden on the command line with the -f flag. If fullscreen
186 is set to "off", -f will turn it on. Conversely, if fullscreen is set to "on" 217 is set to "off", -f will turn it on. Conversely, if fullscreen is set to "on"
187 in the config, -f will turn it off. 218 in the config, -f will turn it off.
188 219
220 "gl" controls whether OpenGL is used for rendering. The default value is on.
221 If it is set to off instead, the fallback renderer which uses SDL2's render API
222 will be used instead. This option is mostly useful for users on hardware that
223 lacks OpenGL 2 support. While BlastEm will fall back automatically even if gl
224 is set to on there will be a warning. Disabling gl eliminates this warning.
225
189 The "ntsc" and "pal" sub-sections control overscan settings for the emulated 226 The "ntsc" and "pal" sub-sections control overscan settings for the emulated
190 video output for NTSC and PAL consoles respectively. More details are available 227 video output for NTSC and PAL consoles respectively. More details are available
191 in the Overscan section. 228 in the Overscan section.
192 229
193 Overscan 230 Overscan
256 other presets enable the slow/turbo mode functionality. 293 other presets enable the slow/turbo mode functionality.
257 294
258 UI 295 UI
259 -- 296 --
260 297
261 The UI section contains settings that affect the graphical user interface. 298 The UI section contains settings that affect the user interface.
262 299
263 "rom" determines the path of the Genesis/Megadrive ROM that implements the UI. 300 "rom" determines the path of the Genesis/Megadrive ROM that implements the UI.
264 Relative paths will be loaded relative to the BlastEm executable. 301 Relative paths will be loaded relative to the BlastEm executable.
265 302
266 Other Settings 303 "initial_path" specifies the starting path for the ROM browser. It can contain
304 the following special variables: $HOME, $EXEDIR. Additionally, variables
305 defined in the OS environment can be used.
306
307 "screenshot_path" specifies the directory "internal" screenshots will be saved
308 in. It accepts the same special variables as "initial_path".
309
310 "screenshot_template" specifies a template for creating screenshot filenames.
311 It is specified as a format string for the C library function strftime
312
313 "save_path" specifies the directory that savestates, SRAM and EEPROM data will
314 be saved in for a given game. It can contain the following special variables:
315 $HOME, $EXEDIR, $USERDATA, $ROMNAME. Like "initial_path" it can also reference
316 variables from the environment.
317
318 Path Variables
267 -------------- 319 --------------
320
321 This section explains the meaning of the special path variables referenced
322 in the previous section.
323
324 $HOME The home directory of the current user. On most Unix variants, it
325 will be a subdirectory of /home. On Windows it will typically be a
326 subdirectory of C:\Users
327 $EXEDIR The directory the BlastEm executable is located in
328 $USERDATA This is an OS-specific path used for storing application specific
329 user data. On Unix variants, it will be $HOME/.local/share/blastem
330 On Windows it will be %LOCALDATA%/blastem
331 $ROMNAME The name of the currently loaded ROM file without the extension
332
333 System
334 ------
335
336 "ram_init" determines how the RAM in the emulated system is initialized. The
337 default value of "zero" will cause all RAM to be zeroed out before the system
338 is started. Alternatively, "random" can be used to initialize RAM with values
339 from a pseudo-random number generator. This option is mostly useful for
340 developers that want to debug initialization issues in their code.
268 341
269 "default_region" determines the console region that will be used when region 342 "default_region" determines the console region that will be used when region
270 detection fails and when there are multiple valid regions. The default of 'U' 343 detection fails and when there are multiple valid regions. The default of 'U'
271 specifies a 60Hz "foreign" console. 344 specifies a 60Hz "foreign" console.
272 345