[mupen64plus-pandora.git] / source / front-end / README

===============================================================================
-------------------------------------------------------------------------------
Mupen64plus-ui-console README                                              v2.0
-------------------------------------------------------------------------------
===============================================================================

The latest documentation for this plugin can be found at:

https://code.google.com/p/mupen64plus/wiki/UIConsoleUsage

-------------------------------------------------------------------------------
Console Options
-------------------------------------------------------------------------------

At startup, the mupen64plus program will look for a user configuration file
called 'mupen64plus.cfg'.  If this file does not exist, it will be created and
default settings will be written. If desired, an alternate config directory can
be specified using the --configdir commandline option.

Run 'mupen64plus --help' for a complete list of commandline options: 

 $ mupen64plus --help
Usage: mupen64plus [parameter(s)] [romfile]

Parameters:
    --noosd               : disable onscreen display
    --osd                 : enable onscreen display
    --fullscreen          : use fullscreen display mode
    --windowed            : use windowed display mode
    --resolution (res)    : display resolution (640x480, 800x600, 1024x768, etc)
    --nospeedlimit        : disable core speed limiter (should be used with dummy audio plugin)
    --cheats (cheat-spec) : enable or list cheat codes for the given rom file
    --corelib (filepath)  : use core library (filepath) (can be only filename or full path)
    --configdir (dir)     : force configation directory to (dir); should contain mupen64plus.cfg
    --datadir (dir)       : search for shared data files (.ini files, languages, etc) in (dir)
    --plugindir (dir)     : search for plugins in (dir)
    --sshotdir (dir)      : set screenshot directory to (dir)
    --gfx (plugin-spec)   : use gfx plugin given by (plugin-spec)
    --audio (plugin-spec) : use audio plugin given by (plugin-spec)
    --input (plugin-spec) : use input plugin given by (plugin-spec)
    --rsp (plugin-spec)   : use rsp plugin given by (plugin-spec)
    --emumode (mode)      : set emu mode to: 0=Pure Interpreter 1=Interpreter 2=DynaRec
    --testshots (list)    : take screenshots at frames given in comma-separated (list), then quit
    --set (param-spec)    : set a configuration variable, format: ParamSection[ParamName]=Value
    --core-compare-send   : use the Core Comparison debugging feature, in data sending mode
    --core-compare-recv   : use the Core Comparison debugging feature, in data receiving mode
    --nosaveoptions       : do not save the given command-line options in configuration file
    --verbose             : print lots of information
    --help                : see this help message

(plugin-spec):
    (pluginname)          : filename (without path) of plugin to find in plugin directory
    (pluginpath)          : full path and filename of plugin
    'dummy'               : use dummy plugin

(cheat-spec):
    'list'                : show all of the available cheat codes
    'all'                 : enable all of the available cheat codes
    (codelist)            : a comma-separated list of cheat code numbers to enable,
                            with dashes to use code variables (ex 1-2 to use cheat 1 option 2)

-------------------------------------------------------------------------------
Cheats
-------------------------------------------------------------------------------

To list the available cheats in the rom:

mupen64plus --cheats list "/path/to/my/rom.v64"

If there are cheats in the rom, you will get (in the output console):

UI-Console: 3 cheat code(s) found for ROM 'MY ROM'
   0: [Enable All Levels] (This is needed to be able to Play all Levels of the Game)
   1: [Enable All Weapons] (This is needed to be able to Play with all Weapons of the Game)
   2: etc...

All you have to do to use this cheats is:

mupen64plus --cheats 0,1,2 "/path/to/my/rom.v64"
Commit	Line	Data
5288f542	1	===============================================================================
	2	-------------------------------------------------------------------------------
	3	Mupen64plus-ui-console README v2.0
	4	-------------------------------------------------------------------------------
	5	===============================================================================
	6
	7	The latest documentation for this plugin can be found at:
	8
	9	https://code.google.com/p/mupen64plus/wiki/UIConsoleUsage
	10
	11	-------------------------------------------------------------------------------
	12	Console Options
	13	-------------------------------------------------------------------------------
	14
	15	At startup, the mupen64plus program will look for a user configuration file
	16	called 'mupen64plus.cfg'. If this file does not exist, it will be created and
	17	default settings will be written. If desired, an alternate config directory can
	18	be specified using the --configdir commandline option.
	19
	20	Run 'mupen64plus --help' for a complete list of commandline options:
	21
	22	$ mupen64plus --help
	23	Usage: mupen64plus [parameter(s)] [romfile]
	24
	25	Parameters:
	26	--noosd : disable onscreen display
	27	--osd : enable onscreen display
	28	--fullscreen : use fullscreen display mode
	29	--windowed : use windowed display mode
	30	--resolution (res) : display resolution (640x480, 800x600, 1024x768, etc)
	31	--nospeedlimit : disable core speed limiter (should be used with dummy audio plugin)
	32	--cheats (cheat-spec) : enable or list cheat codes for the given rom file
	33	--corelib (filepath) : use core library (filepath) (can be only filename or full path)
	34	--configdir (dir) : force configation directory to (dir); should contain mupen64plus.cfg
	35	--datadir (dir) : search for shared data files (.ini files, languages, etc) in (dir)
	36	--plugindir (dir) : search for plugins in (dir)
	37	--sshotdir (dir) : set screenshot directory to (dir)
	38	--gfx (plugin-spec) : use gfx plugin given by (plugin-spec)
	39	--audio (plugin-spec) : use audio plugin given by (plugin-spec)
	40	--input (plugin-spec) : use input plugin given by (plugin-spec)
	41	--rsp (plugin-spec) : use rsp plugin given by (plugin-spec)
	42	--emumode (mode) : set emu mode to: 0=Pure Interpreter 1=Interpreter 2=DynaRec
	43	--testshots (list) : take screenshots at frames given in comma-separated (list), then quit
	44	--set (param-spec) : set a configuration variable, format: ParamSection[ParamName]=Value
	45	--core-compare-send : use the Core Comparison debugging feature, in data sending mode
	46	--core-compare-recv : use the Core Comparison debugging feature, in data receiving mode
	47	--nosaveoptions : do not save the given command-line options in configuration file
	48	--verbose : print lots of information
	49	--help : see this help message
	50
	51	(plugin-spec):
	52	(pluginname) : filename (without path) of plugin to find in plugin directory
	53	(pluginpath) : full path and filename of plugin
	54	'dummy' : use dummy plugin
	55
	56	(cheat-spec):
	57	'list' : show all of the available cheat codes
	58	'all' : enable all of the available cheat codes
	59	(codelist) : a comma-separated list of cheat code numbers to enable,
	60	with dashes to use code variables (ex 1-2 to use cheat 1 option 2)
	61
	62	-------------------------------------------------------------------------------
	63	Cheats
	64	-------------------------------------------------------------------------------
65
66	To list the available cheats in the rom:
67
68	mupen64plus --cheats list "/path/to/my/rom.v64"
69
70	If there are cheats in the rom, you will get (in the output console):
71
72	UI-Console: 3 cheat code(s) found for ROM 'MY ROM'
73	0: [Enable All Levels] (This is needed to be able to Play all Levels of the Game)
74	1: [Enable All Weapons] (This is needed to be able to Play with all Weapons of the Game)
75	2: etc...
76
77	All you have to do to use this cheats is:
78
79	mupen64plus --cheats 0,1,2 "/path/to/my/rom.v64"
80
81