source/mupen64plus-core/doc/emuwiki-api-doc/Mupen64Plus_Core_Parameters.txt

   1 [[Mupen64Plus v2.0 Core API v1.0|Mupen64Plus v2.0 API]]
   2
   3 = Core Parameters =
   4
   5 These are standard parameters which are used by the Mupen64Plus Core library.  They are stored in a configuration section called "Core" and may be altered by the front-end in order to adjust the behaviour of the emulator.  These may be adjusted at any time and the effect of the change should occur immediately.
   6
   7 {| border="1"
   8 !Parameter Name!!Type!!Usage
   9 |-
  10 |Version
  11 |M64TYPE_FLOAT
  12 |Mupen64Plus Core config parameter set version number.  Please don't change.
  13 |-
  14 |OnScreenDisplay
  15 |M64TYPE_BOOL
  16 |Draw on-screen display if True, otherwise don't draw OSD
  17 |-
  18 |R4300Emulator
  19 |M64TYPE_INT
  20 |Use Pure Interpreter if 0, Cached Interpreter if 1, or Dynamic Recompiler if 2 or more
  21 |-
  22 |NoCompiledJump
  23 |M64TYPE_BOOL
  24 |Disable compiled jump commands in dynamic recompiler (should be set to False)
  25 |-
  26 |DisableExtraMem
  27 |M64TYPE_BOOL
  28 |Disable 4MB expansion RAM pack.  May be necessary for some games.
  29 |-
  30 |AutoStateSlotIncrement
  31 |M64TYPE_BOOL
  32 |Increment the save state slot after each save operation.
  33 |-
  34 |EnableDebugger
  35 |M64TYPE_BOOL
  36 |Activate the R4300 debugger when ROM execution begins, if core was built with Debugger support.
  37 |-
  38 |CurrentStateSlot
  39 |M64TYPE_INT
  40 |Save state slot (0-9) to use when saving/loading the emulator state
  41 |-
  42 |ScreenshotPath
  43 |M64TYPE_STRING
  44 |Path to directory where screenshots are saved.  If this is blank, the default value of "<tt>GetConfigUserDataPath()</tt>"/screenshot will be used.
  45 |-
  46 |SaveStatePath
  47 |M64TYPE_STRING
  48 |Path to directory where emulator save states (snapshots) are saved.  If this is blank, the default value of "<tt>GetConfigUserDataPath()</tt>"/save will be used.
  49 |-
  50 |SaveSRAMPath
  51 |M64TYPE_STRING
  52 |Path to directory where SRAM/EEPROM data (in-game saves) are stored.  If this is blank, the default value of "<tt>GetConfigUserDataPath()</tt>"/save will be used.
  53 |-
  54 |SharedDataPath
  55 |M64TYPE_STRING
  56 |Path to a directory to search when looking for shared data files in the <tt>ConfigGetSharedDataFilepath()</tt> function.
  57 |-
  58 |}
  59
  60 These configuration parameters are used in the Core's event loop to detect keyboard and joystick commands.  They are stored in a configuration section called "CoreEvents" and may be altered by the front-end in order to adjust the behaviour of the emulator.  These may be adjusted at any time and the effect of the change should occur immediately.  The Keysym value stored is actually <tt>(SDLMod << 16) || SDLKey</tt>, so that keypresses with modifiers like shift, control, or alt may be used.
  61
  62 {| border="1"
  63 !Parameter Name!!Type!!Usage
  64 |-
  65 |Kbd Mapping Stop
  66 |M64TYPE_INT
  67 |SDL keysym for stopping the emulator
  68 |-
  69 |Kbd Mapping Fullscreen
  70 |M64TYPE_INT
  71 |SDL keysym for switching between fullscreen/windowed modes
  72 |-
  73 |Kbd Mapping Save State
  74 |M64TYPE_INT
  75 |SDL keysym for saving the emulator state
  76 |-
  77 |Kbd Mapping Load State
  78 |M64TYPE_INT
  79 |SDL keysym for loading the emulator state
  80 |-
  81 |Kbd Mapping Increment Slot
  82 |M64TYPE_INT
  83 |SDL keysym for advancing the save state slot
  84 |-
  85 |Kbd Mapping Reset
  86 |M64TYPE_INT
  87 |SDL keysym for resetting the emulator
  88 |-
  89 |Kbd Mapping Speed Down
  90 |M64TYPE_INT
  91 |SDL keysym for slowing down the emulator
  92 |-
  93 |Kbd Mapping Speed Up
  94 |M64TYPE_INT
  95 |SDL keysym for speeding up the emulator
  96 |-
  97 |Kbd Mapping Screenshot
  98 |M64TYPE_INT
  99 |SDL keysym for taking a screenshot
 100 |-
 101 |Kbd Mapping Pause
 102 |M64TYPE_INT
 103 |SDL keysym for pausing the emulator
 104 |-
 105 |Kbd Mapping Mute
 106 |M64TYPE_INT
 107 |SDL keysym for muting/unmuting the sound
 108 |-
 109 |Kbd Mapping Increase Volume
 110 |M64TYPE_INT
 111 |SDL keysym for increasing the volume
 112 |-
 113 |Kbd Mapping Decrease Volume
 114 |M64TYPE_INT
 115 |SDL keysym for decreasing the volume
 116 |-
 117 |Kbd Mapping Fast Forward
 118 |M64TYPE_INT
 119 |SDL keysym for temporarily going really fast
 120 |-
 121 |Kbd Mapping Frame Advance
 122 |M64TYPE_INT
 123 |SDL keysym for advancing by one frame when paused
 124 |-
 125 |Kbd Mapping Gameshark
 126 |M64TYPE_INT
 127 |SDL keysym for pressing the game shark button
 128 |-
 129 |}
 130
 131 These configuration parameters are used in the Core's event loop to detect joystick commands.
 132
 133 The command strings use a simple format described here.  For commands activated by pressing a joystick axis, the format is "J'''x'''A'''y'''+" or "J'''x'''A'''y'''-", where '''x''' is the SDL joystick number (must be between 0 and 9) and '''y''' is the axis number.  For the last character, '''+''' represents movement in the positive direction, while '''-''' represents movement in the negative direction.  For commands activated by pressing a button, the format is "J'''x'''B'''y'''", where '''x''' is the SDL joystick number (must be between 0 and 9) and '''y''' is the button number.  For commands activated by pressing a ''hat'' (a directional switch) on the joystick, the format is "J'''x'''H'''y'''V'''z'''", where '''x''' is the SDL joystick number (must be between 0 and 9), '''y''' is the hat number, and '''z''' is the hat value.  The hat value corresponds with the SDL_HAT_ enumerated types: Up is 1, Right is 2, Down is 4, and Left is 8.  For diagonal directions, these values may be ''or''d together.
 134
 135 {| border="1"
 136 !Parameter Name!!Type!!Usage
 137 |-
 138 |Version
 139 |M64TYPE_FLOAT
 140 |Mupen64Plus CoreEvents config parameter set version number.  Please don't change.
 141 |-
 142 |Joy Mapping Stop
 143 |M64TYPE_STRING
 144 |Joystick event string for stopping the emulator
 145 |-
 146 |Joy Mapping Fullscreen
 147 |M64TYPE_STRING
 148 |Joystick event string for switching between fullscreen/windowed modes
 149 |-
 150 |Joy Mapping Save State
 151 |M64TYPE_STRING
 152 |Joystick event string for saving the emulator state
 153 |-
 154 |Joy Mapping Load State
 155 |M64TYPE_STRING
 156 |Joystick event string for loading the emulator state
 157 |-
 158 |Joy Mapping Increment Slot
 159 |M64TYPE_STRING
 160 |Joystick event string for advancing the save state slot
 161 |-
 162 |Joy Mapping Screenshot
 163 |M64TYPE_STRING
 164 |Joystick event string for taking a screenshot
 165 |-
 166 |Joy Mapping Pause
 167 |M64TYPE_STRING
 168 |Joystick event string for pausing or resuming the emulator
 169 |-
 170 |Joy Mapping Mute
 171 |M64TYPE_STRING
 172 |Joystick event string for muting/unmuting the sound
 173 |-
 174 |Joy Mapping Increase Volume
 175 |M64TYPE_STRING
 176 |Joystick event string for increasing the volume
 177 |-
 178 |Joy Mapping Decrease Volume
 179 |M64TYPE_STRING
 180 |Joystick event string for decreasing the volume
 181 |-
 182 |Joy Mapping Fast Forward
 183 |M64TYPE_STRING
 184 |Joystick event string for temporarily going really fast
 185 |-
 186 |Joy Mapping Gameshark
 187 |M64TYPE_STRING
 188 |Joystick event string for pressing the game shark button
 189 |-
 190 |}
 191