Emulation/mupen64plus-core
1
0
Fork 0
mirror of https://github.com/mupen64plus/mupen64plus-core.git synced 2024-06-02 19:27:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

updated README, added INSTALL file

Browse source
This commit is contained in:
Richard Goedeken 2009-12-13 14:34:10 -05:00
parent d9278bf601
commit ec0495b529
2 changed files with 60 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
INSTALL Normal file
View file

@ -0,0 +1,26 @@
Mupen64Plus-Core INSTALL
------------------------
This text file was written to explain the installation process of the
Mupen64Plus-Core module.
If this module is part of a Mupen64Plus source code bundle, the user should run
the "m64p_install.sh" script in the root of the unzipped bundle to install all
of the included modules in the bundle.
If this module is a standalone source code release, you should build the library
from source code and install it via the makefile, like this:
$ cd projects/unix
$ make all
$ sudo make install
If you want to build the Mupen64Plus-Core module for installation in a home
folder for a single user, you may build it like this (replacing <my-folder>
with your desired local installation path):
$ cd projects/unix
$ make all SHAREDIR=<my-folder>
$ sudo make install LIBDIR=<my-folder> SHAREDIR=<my-folder>

43
README
View file

@ -1,11 +1,15 @@
Mupen64Plus-Core README
-----------------------
The most current version of this README and more documentation can be found on the Mupen64Plus wiki:
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. The package contains the only the Mupen64Plus core library. For a fully functional emulator, the user must also install graphics, sound, input, and RSP plugins.
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
@ -25,7 +29,8 @@ README Sections
*Source Build Requirements*
In addition to the binary libraries, the following packages are required if you build Mupen64Plus from source:
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
@ -34,7 +39,9 @@ In addition to the binary libraries, the following packages are required if you
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:
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
@ -72,20 +79,35 @@ Type 'make' by itself to view all available build options:
*Binary Distribution*
To install the binary distribution of Mupen64Plus, su to root and run the provided install.sh script:
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.
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 (mupen64plus will not find the install directory). If you want to use a prefix other than /usr/local, you will have to download the source package and build with the PREFIX option (see below).
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 (mupen64plus
will not find the install directory). If you want to use a prefix other than
/usr/local, you will have to download the source 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:
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 all
$ sudo make PREFIX=/usr install
@ -93,7 +115,10 @@ After building mupen64plus and all plugins, su to root and type 'make install' t
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:
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