X-Git-Url: https://notaz.gp2x.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=source%2Fmupen64plus-core%2FREADME;fp=source%2Fmupen64plus-core%2FREADME;h=45c53c932c22d448c0491cb2afc83eef9a32b3e0;hb=451ab91e3827a6384981b3300e2a7000d2eaba58;hp=0000000000000000000000000000000000000000;hpb=a2ab25365b5b0dddbee476d695d8a31151407581;p=mupen64plus-pandora.git diff --git a/source/mupen64plus-core/README b/source/mupen64plus-core/README new file mode 100644 index 0000000..45c53c9 --- /dev/null +++ b/source/mupen64plus-core/README @@ -0,0 +1,153 @@ +Mupen64Plus-Core README +----------------------- + +The most current version of this README and more documentation can be found on +the Mupen64Plus wiki: + +http://code.google.com/p/mupen64plus/wiki/README + +Mupen64Plus is based off of mupen64, originally created by Hacktarux. This +package contains the only the Mupen64Plus core library. For a fully functional +emulator, the user must also install graphics, sound, input, and RSP plugins, +as well as a user interface program (called a front-end). + +README Sections + 1. Requirements for building or running Mupen64Plus + 2. Building From Source + 3. Installation + 4. Key Commands In Emulator + +1. Requirements and Pre-requisites +---------------------------------- + +*Binary Package Requirements* + + - SDL 1.2 + - libpng + - freetype 2 + - zlib + +*Source Build Requirements* + +In addition to the binary libraries, the following packages are required if you +build Mupen64Plus from source: + + - GNU C and C++ compiler, libraries, and headers + - GNU make + - Development packages for all the libraries above + +2. Building From Source +----------------------- + +If you downloaded the binary distribution of Mupen64Plus, skip to the +Installation section. To build the source distribution, unzip and cd into the +projects/unix directory, then build using make: + + $ unzip mupen64plus-core-x-y-z-src.zip + $ cd mupen64plus-core-x-y-z-src/projects/unix + $ make all + +Type 'make' by itself to view all available build options: + + $ make + Mupen64Plus makefile. + Targets: + all == Build Mupen64Plus and all plugins + clean == remove object files + install == Install Mupen64Plus and all plugins + uninstall == Uninstall Mupen64Plus and all plugins + Options: + BITS=32 == build 32-bit binaries on 64-bit machine + LIRC=1 == enable LIRC support + NO_ASM=1 == build without assembly (no dynamic recompiler or MMX/SSE code) + SHAREDIR=path == extra path to search for shared data files + OPTFLAGS=flag == compiler optimization (default: -O3) + PIC=(1|0) == Force enable/disable of position independent code + OSD=(1|0) == Enable/disable build of OpenGL On-screen display + NEW_DYNAREC=1 == Replace dynamic recompiler with Ari64's experimental dynarec + POSTFIX=name == String added to the name of the the build (default: '') + Install Options: + PREFIX=path == install/uninstall prefix (default: /usr/local/) + SHAREDIR=path == path to install shared data (default: PREFIX/share/mupen64plus/) + LIBDIR=path == path to install plugin libs (default: PREFIX/lib) + INCDIR=path == path to install core header files (default: PREFIX/include/mupen64plus) + DESTDIR=path == path to prepend to all installation paths (only for packagers) + Debugging Options: + PROFILE=1 == build gprof instrumentation into binaries for profiling + DEBUG=1 == add debugging symbols to binaries + DEBUGGER=1 == build graphical debugger + DBG_CORE=1 == print debugging info in r4300 core + DBG_COUNT=1 == print R4300 instruction count totals (64-bit dynarec only) + DBG_COMPARE=1 == enable core-synchronized r4300 debugging + DBG_TIMING=1 == print timing data + DBG_PROFILE=1 == dump profiling data for r4300 dynarec to data file + V=1 == show verbose compiler output + +3. Installation +--------------- + +*Binary Distribution* + +To install the binary distribution of Mupen64Plus, su to root and run the +provided install.sh script: + + $ su + # ./install.sh + # exit + $ + +The install script will copy the executable to /usr/local/bin and a directory +called /usr/local/share/mupen64plus will be created to hold plugins and other +files used by mupen64plus. + +NOTE: By default, install.sh uses /usr/local for the install prefix. Although +the user can specify an alternate prefix to install.sh at the commandline, the +mupen64plus binary was compiled to look for the install directory in /usr/local, +so specifying an alternate prefix to install.sh will cause problems (the +mupen64plus front-end application will not find the directory containing the +core library) unless the directory to which you install it is known by your +dynamic library loader (ie, included in /etc/ld.conf.so) + +If you want to use a prefix other than /usr/local, you may also download the +source code package and build with the PREFIX option (see below). + +*Source Distribution* + +After building mupen64plus and all plugins, su to root and type 'make install' +to install Mupen64Plus. The install process will copy the executable to +$PREFIX/bin and a directory called $PREFIX/share/mupen64plus will be created +to hold plugins and other files used by mupen64plus. By default, PREFIX is set +to /usr/local. This can be changed by passing the PREFIX option to make. NOTE: +you must pass the prefix, when building AND installing. For example, to install +mupen64plus to /usr, do this: + + $ make PREFIX=/usr all + $ sudo make PREFIX=/usr install + $ + +4. Key Commands In Emulator +--------------------------- +The keys or joystick/mouse inputs which will be mapped to the N64 controller +for playing the games are determined by the input plugin. The emulator core +also supports several key commands during emulation, which may be configured by +editing the ~/.config/mupen64plus/mupen64plus.cfg file. They are: + + Escape == Quit the emulator + 0-9 == Select virtual 'slot' for save/load state (F5 and F7) commands + F5 == Save emulator state + F7 == Load emulator state + F9 == Reset emulator + F10 == slow down emulator by 5% + F11 == speed up emulator by 5% + F12 == take screenshot +Alt-Enter == Toggle between windowed and fullscreen (may not be supported by all video plugins) + p or P == Pause on/off + m or M == Mute/unmute sound + g or G == Press "Game Shark" button (only if cheats are enabled) + / or ? == single frame advance while paused + F == Fast Forward (playback at 250% normal speed while F key is pressed) + [ == Decrease volume + ] == Increase volume + + +