changeset 1353:52d9e3c36b4f

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
files README
diffstat 1 files changed, 77 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/README	Tue May 09 22:57:12 2017 -0700
+++ b/README	Wed May 10 19:23:59 2017 -0700
@@ -140,6 +140,34 @@
 to the window. The ui.release_mouse binding releases the mouse so it can be
 used normally.
 
+UI Actions
+----------
+
+This section lists the various "UI" actions that can be triggered by a key or
+gamepad binding.
+
+ui.release_mouse             Releases the mouse if it is currently captured
+ui.vdp_debug_mode            Cycles through the various VDP debug views
+ui.vdp_debug_pal             Cycles through the selected palette when viewing
+                             the VDP memory viewer
+ui.enter_debugger            Enters the debugger for the main CPU of the
+							 currently emulated system
+ui.screenshot                Takes an internal screenshot
+ui.exit                      Returns to the menu ROM if currently in a game
+                             that was launched from the menu. Exits otherwise
+ui.save_state                Saves a savestate to the quicksave slot
+ui.set_speed.N               Selects a specific machine speed specified by N
+                             which should be a number between 0-9. Speeds are
+                             specified in the "clocks" section of the config				
+ui.next_speed                Selects the next machine speed
+ui.prev_speed                Selects the previous machine speed
+ui.toggle_fullscreen         Toggles between fullscreen and windowed mode
+ui.soft_reset                Resets a portion of the emulated machine
+                             Equivalent to pushing the reset button on the
+                             emulated device
+ui.toggle_keyboard_captured  Toggles the capture state of the host keyboard
+                             when an emulated keyboard is present
+		
 IO
 --
 
@@ -155,9 +183,12 @@
 
 The video section contains settings that affect the visual output of BlastEm.
 
+"aspect" is used to control the aspect ratio of the emulated display. The
+default of 4:3 matches that of a standard definition television.
+
 "width" is used to control the window size when not in fullscreen mode. The
-height of the window is calculated from this value. Both width and height can
-be overridden from the command line.
+height of the window is calculated from this value and "aspect". Both width
+and height can be overridden from the command line.
 
 "vertex_shader" and "fragment_shader" define the GLSL shader program that
 produces the final image for each frame. Shaders can be used to add various
@@ -186,6 +217,12 @@
 is set to "off", -f will turn it on. Conversely, if fullscreen is set to "on"
 in the config, -f will turn it off.
 
+"gl" controls whether OpenGL is used for rendering. The default value is on.
+If it is set to off instead, the fallback renderer which uses SDL2's render API
+will be used instead. This option is mostly useful for users on hardware that
+lacks OpenGL 2 support. While BlastEm will fall back automatically even if gl
+is set to on there will be a warning. Disabling gl eliminates this warning.
+
 The "ntsc" and "pal" sub-sections control overscan settings for the emulated
 video output for NTSC and PAL consoles respectively. More details are available
 in the Overscan section.
@@ -258,14 +295,50 @@
 UI
 --
 
-The UI section contains settings that affect the graphical user interface.
+The UI section contains settings that affect the user interface.
 
 "rom" determines the path of the Genesis/Megadrive ROM that implements the UI.
 Relative paths will be loaded relative to the BlastEm executable.
 
-Other Settings
+"initial_path" specifies the starting path for the ROM browser. It can contain
+the following special variables: $HOME, $EXEDIR. Additionally, variables
+defined in the OS environment can be used.
+
+"screenshot_path" specifies the directory "internal" screenshots will be saved
+in. It accepts the same special variables as "initial_path".
+
+"screenshot_template" specifies a template for creating screenshot filenames.
+It is specified as a format string for the C library function strftime
+
+"save_path" specifies the directory that savestates, SRAM and EEPROM data will
+be saved in for a given game. It can contain the following special variables:
+$HOME, $EXEDIR, $USERDATA, $ROMNAME. Like "initial_path" it can also reference
+variables from the environment.
+
+Path Variables
 --------------
 
+This section explains the meaning of the special path variables referenced
+in the previous section.
+
+$HOME      The home directory of the current user. On most Unix variants, it
+           will be a subdirectory of /home. On Windows it will typically be a 
+           subdirectory of C:\Users
+$EXEDIR    The directory the BlastEm executable is located in
+$USERDATA  This is an OS-specific path used for storing application specific
+           user data. On Unix variants, it will be  $HOME/.local/share/blastem
+           On Windows it will be %LOCALDATA%/blastem
+$ROMNAME   The name of the currently loaded ROM file without the extension
+
+System
+------
+
+"ram_init" determines how the RAM in the emulated system is initialized. The
+default value of "zero" will cause all RAM to be zeroed out before the system
+is started. Alternatively, "random" can be used to initialize RAM with values
+from a pseudo-random number generator. This option is mostly useful for
+developers that want to debug initialization issues in their code.
+
 "default_region" determines the console region that will be used when region
 detection fails and when there are multiple valid regions. The default of 'U'
 specifies a 60Hz "foreign" console.