Mercurial > repos > blastem

comparison README @ 1442:59e1dbb795a7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update README in anticipation of 0.5.1 release
author Michael Pavone <pavone@retrodev.com>
date Fri, 25 Aug 2017 20:12:21 -0700
parents 34798ad9c570
children c3c3b65f17aa
comparison
equal deleted inserted replaced
1441:8a3d3bb2cd08 1442:59e1dbb795a7
1 BlastEm 0.5.0 1 BlastEm 0.5.1
2 ------------- 2 -------------
3 3
4 Installation 4 Installation
5 ------------ 5 ------------
6 6
36 36
37 Lock-On Support 37 Lock-On Support
38 --------------- 38 ---------------
39 39
40 This version of BlastEm has some preliminary support for Sonic & Knuckles lock 40 This version of BlastEm has some preliminary support for Sonic & Knuckles lock
41 on technology. This is only available from the command line at the moment. To 41 on technology. This is available via both the menu and the command line. To use
42 use it specify the Sonic & Knuckles ROM as the primary ROM and specify the ROM 42 it from the menu, first load Sonic & Knuckles normally. Enter the menu (mapped
43 to be locked on using the -o option. As an example: 43 to the Escape key by default) and select the "Lock On" option to select a ROM
44 to lock on. The system will then reload with the combined game. To use it from
45 the command line, specify the Sonic & Knuckles ROM as the primary ROM and
46 specify the ROM to be locked on using the -o option. As an example:
44 47
45 ./blastem ~/romz/sonic_and_knuckles.bin -o ~/romz/sonic3.bin 48 ./blastem ~/romz/sonic_and_knuckles.bin -o ~/romz/sonic3.bin
46 49
47 Please note that Sonic 2 lock-on does not work at this time. Additionally the 50 Please note that Sonic 2 lock-on does not work at this time.
48 save RAM added by Sonic 3 won't work either.
49 51
50 Configuration 52 Configuration
51 ------------- 53 -------------
52 54
53 Configuration is read from the file at $HOME/.config/blastem/blastem.cfg on 55 Configuration is read from the file at $HOME/.config/blastem/blastem.cfg on
163 ui.prev_speed Selects the previous machine speed 165 ui.prev_speed Selects the previous machine speed
164 ui.toggle_fullscreen Toggles between fullscreen and windowed mode 166 ui.toggle_fullscreen Toggles between fullscreen and windowed mode
165 ui.soft_reset Resets a portion of the emulated machine 167 ui.soft_reset Resets a portion of the emulated machine
166 Equivalent to pushing the reset button on the 168 Equivalent to pushing the reset button on the
167 emulated device 169 emulated device
170 ui.reload Reloads the current ROM from a file and performs
171 a hard reset of the emulated device
172 ui.sms_pause Triggers a press of the pause button when in SMS
173 mode
168 ui.toggle_keyboard_captured Toggles the capture state of the host keyboard 174 ui.toggle_keyboard_captured Toggles the capture state of the host keyboard
169 when an emulated keyboard is present 175 when an emulated keyboard is present
170 176
171 IO 177 IO
172 -- 178 --
184 The video section contains settings that affect the visual output of BlastEm. 190 The video section contains settings that affect the visual output of BlastEm.
185 191
186 "aspect" is used to control the aspect ratio of the emulated display. The 192 "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. 193 default of 4:3 matches that of a standard definition television.
188 194
189 "width" is used to control the window size when not in fullscreen mode. The 195 "width" is used to control the window width when not in fullscreen mode.
190 height of the window is calculated from this value and "aspect". Both width 196
191 and height can be overridden from the command line. 197 "height" is used to control the window height when not in fullscreen mode. If
198 left unspecified, it will be calculated from "width" and "aspect".
192 199
193 "vertex_shader" and "fragment_shader" define the GLSL shader program that 200 "vertex_shader" and "fragment_shader" define the GLSL shader program that
194 produces the final image for each frame. Shaders can be used to add various 201 produces the final image for each frame. Shaders can be used to add various
195 visual effects or enhancements. Currently BlastEm only ships with the default 202 visual effects or enhancements. Currently BlastEm only ships with the default
196 shader. If you write your own shaders, place them in 203 shader and a "subtle" crt shader. If you write your own shaders, place them in
197 $HOME/.config/blastem/shaders and then specify the basename of the new shader 204 $HOME/.config/blastem/shaders and then specify the basename of the new shader
198 files in the "vertex_shader" and "fragment_shader" config options. Note that 205 files in the "vertex_shader" and "fragment_shader" config options. Note that
199 shaders are not available in the SDL fallback renderer. 206 shaders are not available in the SDL fallback renderer.
200 207
201 "scanlines" controls whether there is any emulation of the gaps between display 208 "scanlines" controls whether there is any emulation of the gaps between display
221 If it is set to off instead, the fallback renderer which uses SDL2's render API 228 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 229 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 230 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. 231 is set to on there will be a warning. Disabling gl eliminates this warning.
225 232
233 "scaling" controls the type of scaling used for textures in both the GL and
234 SDL renderers. Valid values are "nearest" and "linear". Note that shaders also
235 impact how pixels are scaled.
236
226 The "ntsc" and "pal" sub-sections control overscan settings for the emulated 237 The "ntsc" and "pal" sub-sections control overscan settings for the emulated
227 video output for NTSC and PAL consoles respectively. More details are available 238 video output for NTSC and PAL consoles respectively. More details are available
228 in the Overscan section. 239 in the Overscan section.
229 240
230 Overscan 241 Overscan
302 313
303 "initial_path" specifies the starting path for the ROM browser. It can contain 314 "initial_path" specifies the starting path for the ROM browser. It can contain
304 the following special variables: $HOME, $EXEDIR. Additionally, variables 315 the following special variables: $HOME, $EXEDIR. Additionally, variables
305 defined in the OS environment can be used. 316 defined in the OS environment can be used.
306 317
318 "remember_path" specifies whether BlastEm should remember the last path used in
319 the file browser. When it is set to "on", the last path will be remembered and
320 used instead of "initial_path" in subsequent runs. If it is set to "off",
321 "initial_path" will always be used.
322
307 "screenshot_path" specifies the directory "internal" screenshots will be saved 323 "screenshot_path" specifies the directory "internal" screenshots will be saved
308 in. It accepts the same special variables as "initial_path". 324 in. It accepts the same special variables as "initial_path".
309 325
310 "screenshot_template" specifies a template for creating screenshot filenames. 326 "screenshot_template" specifies a template for creating screenshot filenames.
311 It is specified as a format string for the C library function strftime 327 It is specified as a format string for the C library function strftime
312 328
313 "save_path" specifies the directory that savestates, SRAM and EEPROM data will 329 "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: 330 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 331 $HOME, $EXEDIR, $USERDATA, $ROMNAME. Like "initial_path" it can also reference
316 variables from the environment. 332 variables from the environment.
333
334 "extensions" specifies the file extensions that should be displayed in the file
335 browser.
336
337 "state_format" specifies the preferred format for saving save states. Valid
338 values are "native" (the default) and "gst". "native" save states do a better
339 job of preserving the state of the emulated system, but "gst" save states are
340 compatible with other emulators like Kega and Gens. This setting has no effect
341 for systems other than the Genesis/Mega Drive
317 342
318 Path Variables 343 Path Variables
319 -------------- 344 --------------
320 345
321 This section explains the meaning of the special path variables referenced 346 This section explains the meaning of the special path variables referenced