| 1 | .Dd September 20, 2013 |
| 2 | .Dt MUPEN64PLUS 6 |
| 3 | .Os |
| 4 | .Sh NAME |
| 5 | .Nm mupen64plus |
| 6 | .Nd console front\(hyend for the Mupen64Plus N64 emulator |
| 7 | .Sh SYNOPSIS |
| 8 | .Nm |
| 9 | .Op parameters |
| 10 | .Ar romfile |
| 11 | .Sh DESCRIPTION |
| 12 | .Nm |
| 13 | is a plugin\(hybased N64 emulator for Linux/Unix, OSX, and Windows which is capable of accurately playing many games. |
| 14 | Included are four MIPS R4300 CPU emulators, with dynamic recompilers for 32\(hybit x86 and 64\(hybit amd64 systems, and necessary plugins for audio, graphical rendering (RDP), signal co\(hyprocessor (RSP), and input. |
| 15 | There are several OpenGL video plugins available: |
| 16 | .Bl -bullet |
| 17 | .It |
| 18 | Rice, included with the distribution |
| 19 | .It |
| 20 | Glide64Mk2, included with the distribution |
| 21 | .It |
| 22 | .Lk https://bitbucket.org/wahrhaft/mupen64plus-video-arachnoid Arachnoid |
| 23 | .It |
| 24 | .Lk https://bitbucket.org/wahrhaft/mupen64plus-video-glide64 Glide64 |
| 25 | (old) |
| 26 | .It |
| 27 | .Lk https://bitbucket.org/wahrhaft/mupen64plus-video-z64 Z64 |
| 28 | (must be used with the rsp-z64 plugin) |
| 29 | .El |
| 30 | .Pp |
| 31 | The most current documentation can be found at the project's |
| 32 | .Lk https://code.google.com/p/mupen64plus/ homepage . |
| 33 | .Pp |
| 34 | The options are as follows: |
| 35 | .Bl -tag -width x |
| 36 | .It Fl h , Fl -help |
| 37 | Print help message. |
| 38 | .It Fl -noosd |
| 39 | Disable onscreen display. |
| 40 | .It Fl -osd |
| 41 | Enable onscreen display. |
| 42 | .It Fl -fullscreen |
| 43 | Run emulator in fullscreen display mode. |
| 44 | .It Fl -windowed |
| 45 | Run emulator in windowed display mode. |
| 46 | .It Fl -resolution Ar res |
| 47 | Display resolution (640\(mu480, 800\(mu600, 1024\(mu768, etc) |
| 48 | .It Fl -nospeedlimit |
| 49 | Disable core speed limiter. |
| 50 | This should be used with the dummy audio plugin. |
| 51 | .It Fl -cheats Ar cheat-spec |
| 52 | Enable or list cheat codes for the given rom file. |
| 53 | .It Fl -corelib Ar filepath |
| 54 | Specifies a filename (optionally with a preceding directory path) to load a specific |
| 55 | .Nm |
| 56 | core library. |
| 57 | .It Fl -configdir Ar directory |
| 58 | Specifies a directory to look for the |
| 59 | .Pa mupen64plus.cfg |
| 60 | file. |
| 61 | Default is |
| 62 | .Pa ~/.config/mupen64plus/ . |
| 63 | .It Fl -datadir Ar directory |
| 64 | Specifies a directory to search for shared data files (fonts, cheat codes, .ini files). |
| 65 | Default is |
| 66 | .Pa ${PREFIX}/share/mupen64plus/ . |
| 67 | .It Fl -plugindir Ar directory |
| 68 | Specifies a directory to search for plugin files. |
| 69 | Default is |
| 70 | .Pa ${PREFIX}/lib/mupen64plus/ . |
| 71 | .It Fl -sshotdir Ar directory |
| 72 | Specifies a directory to save screenshots captured during gameplay. |
| 73 | Default is |
| 74 | .Pa ~/.local/share/mupen64plus/screenshot/ . |
| 75 | .It Fl -gfx Ar plugin\(hyspec |
| 76 | Specifies a |
| 77 | .Ar plugin\(hyspec |
| 78 | to select a graphics plugin for use during emulation. |
| 79 | .It Fl -audio Ar plugin\(hyspec |
| 80 | Specifies a |
| 81 | .Ar plugin\(hyspec |
| 82 | to select an audio plugin for use during emulation. |
| 83 | .It Fl -input Ar plugin\(hyspec |
| 84 | Specifies a |
| 85 | .Ar plugin\(hyspec |
| 86 | to select an input plugin for use during emulation. |
| 87 | .It Fl -rsp Ar plugin\(hyspec |
| 88 | Specifies a |
| 89 | .Ar plugin\(hyspec |
| 90 | to select an RSP plugin for use during emulation. |
| 91 | .It Fl -emumode Ar mode |
| 92 | Specifies which mode the emulator core should run in. |
| 93 | .Ar mode |
| 94 | should be set to one of the following numbers: |
| 95 | .Bl -inset |
| 96 | .It 0 |
| 97 | Pure Interpreter |
| 98 | .It 1 |
| 99 | Cached Interpreter |
| 100 | .It 2 |
| 101 | Dynamic Recompiler (DynaRec) |
| 102 | .El |
| 103 | .It Fl -testshots Ar list |
| 104 | Take screenshots at frames given in the comma\(hyseparated |
| 105 | .Ar list , |
| 106 | then quit. |
| 107 | .It Fl -core-compare-send |
| 108 | Use the core comparison debugging feature, in data sending mode. |
| 109 | If the core was not compiled with support for the Core Comparison feature, then the emulator will exit with an error. |
| 110 | .It Fl -core-compare-recv |
| 111 | Use the core comparison debugging feature, in data receiving mode. |
| 112 | If the core was not compiled with support for the Core Comparison feature, then the emulator will exit with an error. |
| 113 | .It Fl -set Ar param\(hyspec |
| 114 | Set the value of a |
| 115 | .Nm |
| 116 | configuration parameter. |
| 117 | This option may be used multiple times. |
| 118 | The format of |
| 119 | .Ar param\(hyspec |
| 120 | is |
| 121 | .Dl Section\(hyName[Param\(hyName]=Value |
| 122 | .It Fl -nosaveoptions |
| 123 | Do not save the given command\(hyline options into the |
| 124 | .Nm |
| 125 | configuration file to use as defaults in the future. |
| 126 | .It Fl -verbose |
| 127 | Print lots of information. |
| 128 | Useful for debugging but unnecessary for normal use. |
| 129 | .El |
| 130 | .Sh plugin\(hyspec |
| 131 | .Bl -ohang |
| 132 | .It (plugin\(hyname) |
| 133 | Filename (without path) of plugin to use. |
| 134 | Application will search through several directories to look for a matching plugin name. |
| 135 | .It (plugin\(hypath) |
| 136 | Full directory path and filename of plugin. |
| 137 | .It Sq dummy |
| 138 | Use the dummy plugin. |
| 139 | .El |
| 140 | .Sh cheat\(hyspec |
| 141 | .Bl -ohang |
| 142 | .It Sq list |
| 143 | Show all of the available cheat codes. |
| 144 | .It Sq all |
| 145 | Enable all of the available cheat codes. |
| 146 | .It (codelist) |
| 147 | A comma separated list of cheat code numbers to enable. |
| 148 | .El |
| 149 | .Sh KEY COMMANDS |
| 150 | The following shortcut keys can be used during emulation. |
| 151 | These are the default key values; nearly all of them may be set to different keys by editing the |
| 152 | .Nm |
| 153 | configuration file. |
| 154 | .Bl -tag -width Alt-Enter |
| 155 | .It Escape |
| 156 | Quit the emulator. |
| 157 | .It 0\(en9 |
| 158 | Select virtual |
| 159 | .Sq slot |
| 160 | for save/load state. |
| 161 | .It F5 |
| 162 | Save emulator state to current slot. |
| 163 | .It F7 |
| 164 | Load emulator state from current slot. |
| 165 | .It F9 |
| 166 | Reset emulator. |
| 167 | .It F10 |
| 168 | Slow down emulator speed by 5 percent. |
| 169 | .It F11 |
| 170 | Speed up emulator speed by 5 percent. |
| 171 | .It F12 |
| 172 | Take screenshot. |
| 173 | .It Alt\(hyEnter |
| 174 | Toggle fullscreen mode. |
| 175 | This is not supported on Windows. |
| 176 | .It p or P |
| 177 | Pause/continue emulation. |
| 178 | .It m or M |
| 179 | Mute/unmute sound. |
| 180 | .It f or F |
| 181 | Fast Forward (playback at 250% normal speed as long as key is pressed). |
| 182 | .It g or G |
| 183 | Press GameShark button (if cheats are enabled). |
| 184 | .It / or \&? |
| 185 | Advance one frame if paused. |
| 186 | .It \(lB |
| 187 | Decrease volume. |
| 188 | .It \(rB |
| 189 | Increase volume. |
| 190 | .El |
| 191 | .Sh FILES |
| 192 | The default location for the |
| 193 | .Nm |
| 194 | configuration file is |
| 195 | .Pa ~/.config/mupen64plus/ . |
| 196 | The default location of the saved screenshots is |
| 197 | .Pa ~/.local/share/mupen64plus/screenshot/ . |
| 198 | The default location of the save states is |
| 199 | .Pa ~/.local/share/mupen64plus/save/ . |
| 200 | .Sh AUTHORS |
| 201 | .Nm |
| 202 | was originally started by Richard42 and nmn, and is based on Mupen64 (originally written by Hacktarux). |
| 203 | .Pp |
| 204 | This man page was written by ebenblues, and updated by Richard42 and bentley. |
| 205 | .Sh COPYRIGHT |
| 206 | Mupen64plus is \(co 2008\(en2013 The Mupen64plus Team |
| 207 | .Pp |
| 208 | License GPLv2+, |
| 209 | .Lk https://gnu.org/licenses/gpl.html GNU GPL version 2 or later |
| 210 | .Pp |
| 211 | This is free software: you are free to change and redistribute it. |
| 212 | There is |
| 213 | .Em no warranty , |
| 214 | to the extent permitted by law. |
| 215 | .Sh BUGS |
| 216 | To report bugs or make feature requests, use the |
| 217 | .Lk https://code.google.com/p/mupen64plus/issues/list "issue tracker" |