MediaWiki API

https://mupen64plus.org/wiki
Admin
MediaWiki API is a mature and stable interface for programmatically accessing and modifying wiki...
Tokens:1,639,226
Snippets:24,158
Trust Score:9.1
Update:5 months ago
Show doc for...
Tokens:
Raw
### Configure and Install Dependencies

Source: https://mupen64plus.org/wiki/index.php?action=edit&title=MacOSXInstructions

This is a generic example of how to configure, compile, and install a library from source. It is used here as an example for installing dependencies like SDL, SDL_ttf, and libpng.

```bash
./configure
make
sudo make install
```

--------------------------------

### Custom Installation Paths (Source)

Source: https://mupen64plus.org/wiki/index.php?action=edit&title=README

Example of how to specify a custom installation prefix when installing Mupen64Plus from source using 'make install'.

```bash
$ make all
$ su
# make PREFIX=/usr install
# exit
```

--------------------------------

### Example: Fetch revisions by prefix

Source: https://mupen64plus.org/wiki/index.php/Special%3AApiHelp/query

An example showing how to fetch revisions for pages starting with a specific prefix.

```APIDOC
## Example: Fetch revisions of pages beginning with `API/`.

```
api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions&continue= [open in sandbox]
```
```

--------------------------------

### Example: Fetch revisions of pages by prefix

Source: https://mupen64plus.org/wiki/api.php?action=help&recursivesubmodules=1

An example showing how to fetch revisions for pages that start with a specific prefix using the query action with a generator.

```APIDOC
## Example: Fetch revisions of pages by prefix

Fetch revisions of pages beginning with `API/`.
api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions&continue= [open in sandbox]
```

--------------------------------

### List all users

Source: https://mupen64plus.org/wiki/index.php/Special%3AApiHelp/query%2Ballusers

This example demonstrates how to list all registered users, starting from a specific username.

```APIDOC
## GET /api.php

### Description
Enumerates all registered users on the MediaWiki instance.

### Method
GET

### Endpoint
/api.php

### Query Parameters
- **action** (string) - Required - Must be "query".
- **list** (string) - Required - Must be "allusers".
- **aufrom** (string) - Optional - The user name to start enumerating from.
- **auto** (string) - Optional - The user name to stop enumerating at.
- **auprefix** (string) - Optional - Search for all users that begin with this value.
- **audir** (string) - Optional - Direction to sort in. Values: ascending, descending. Default: ascending.
- **augroup** (string) - Optional - Only include users in the given groups (e.g., bot, bureaucrat). Separate values with `|`.
- **auexcludegroup** (string) - Optional - Exclude users in the given groups. Separate values with `|`.
- **aurights** (string) - Optional - Only include users with the given rights. Maximum 50 values. Separate values with `|`.
- **auprop** (string) - Optional - Which pieces of information to include. Values: blockinfo, centralids, editcount, groups, implicitgroups, registration, rights. Separate values with `|`.
- **aulimit** (integer|string) - Optional - How many total user names to return. Must be between 1 and 500, or `max`. Default: 10.
- **auwitheditsonly** (boolean) - Optional - Only list users who have made edits.
- **auactiveusers** (boolean) - Optional - Only list users active in the last 30 days.
- **auattachedwiki** (string) - Optional - With `auprop=centralids`, also indicate whether the user is attached with the wiki identified by this ID.

### Request Example
```
api.php?action=query&list=allusers&aufrom=Y
```

### Response
#### Success Response (200)
- **query.allusers** (array) - An array of user objects, each containing user details.
  - **name** (string) - The username.
  - **userid** (integer) - The user ID.
  - **editcount** (integer) - The number of edits made by the user (if `auprop=editcount` is set).
  - **registration** (string) - The registration timestamp (if `auprop=registration` is set).
  - **groups** (array) - An array of groups the user belongs to (if `auprop=groups` is set).
  - **implicitgroups** (array) - An array of implicit groups the user belongs to (if `auprop=implicitgroups` is set).
  - **rights** (array) - An array of rights the user has (if `auprop=rights` is set).
  - **blockinfo** (object) - Information about the user's block status (if `auprop=blockinfo` is set).
    - **blocked** (boolean) - Whether the user is blocked.
    - **blockid** (integer) - The block ID.
    - **expiry** (string) - The block expiry timestamp.
    - **reason** (string) - The reason for the block.

```

--------------------------------

### Get info for 4 pages starting with 'T'

Source: https://mupen64plus.org/wiki/index.php/Special%3AApiHelp/query%2Ballpages

This example demonstrates how to retrieve information for a limited number of pages starting with a specific prefix. It utilizes the generator=allpages and prop=info parameters.

```api
api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info
```

--------------------------------

### Create User Account Example

Source: https://mupen64plus.org/wiki/index.php/Special%3AApiHelp/createaccount

This example demonstrates how to initiate the user account creation process by providing a username, password, return URL, and a create account token. Ensure you have obtained the necessary token beforehand.

```api
api.php?action=createaccount&username=Example&password=ExamplePassword&retype=ExamplePassword&createreturnurl=http://example.org/&createtoken=123ABC
```

--------------------------------

### Get all target pages, marking missing ones (generator)

Source: https://mupen64plus.org/wiki/index.php/Special%3AApiHelp/query%2Ballredirects

This example uses the generator functionality to get all target pages and marks the missing ones. It starts enumeration from the title 'B'.

```api
api.php?action=query&generator=allredirects&garunique=&garfrom=B
```

--------------------------------

### Install Mupen64Plus from Source

Source: https://mupen64plus.org/wiki/index.php/README

After building, use 'make install' as root to install from source. Customize the installation prefix by setting the PREFIX variable during the make command.

```bash
make all
$ su
# make PREFIX=/usr install
# exit
$
```

--------------------------------

### Generator for pages containing transclusions

Source: https://mupen64plus.org/wiki/api.php?action=help&recursivesubmodules=1

This example uses `generator=alltransclusions` to get the actual pages that contain the transclusions, starting from 'B'.

```APIDOC
## GET /api.php

### Description
Generates a list of pages that contain transclusions, starting from a specified title.

### Method
GET

### Endpoint
/api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be "query"
- **generator** (string) - Required - Must be "alltransclusions"
- **gatfrom** (string) - Optional - The title of the transclusion to start enumerating from.

### Request Example
```
api.php?action=query&generator=alltransclusions&gatfrom=B
```

### Response
#### Success Response (200)
- **query.pages** (object) - Contains a map of pages that contain the transclusions.
  - **[pageid]** (object) - Represents a page.
    - **title** (string) - The title of the page containing the transclusion.
```

--------------------------------

### Installation Options

Source: https://mupen64plus.org/wiki/index.php?diff=cur&oldid=23&title=CompilingFromGit

Configure installation paths for the prefix, shared data, libraries, plugins, and destination directory.

```shell
PREFIX=path   == install/uninstall prefix (default: /usr/local)
SHAREDIR=path == path to install shared data files (default: PREFIX/share/mupen64plus)
LIBDIR=path   == library prefix (default: PREFIX/lib)
PLUGINDIR=path == path to install plugin libraries (default: LIBDIR/mupen64plus)
DESTDIR=path  == path to prepend to all installation paths (only for packagers)
```

--------------------------------

### Generator for all transcluded titles

Source: https://mupen64plus.org/wiki/api.php?action=help&recursivesubmodules=1

This example uses `generator=alltransclusions` to get all transcluded titles, marking the missing ones. It starts from 'B'.

```APIDOC
## GET /api.php

### Description
Generates a list of all transcluded titles, marking missing ones, starting from a specified title.

### Method
GET

### Endpoint
/api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be "query"
- **generator** (string) - Required - Must be "alltransclusions"
- **gatunique** (boolean) - Optional - Only show distinct transcluded titles. When used as a generator, yields target pages instead of source pages.
- **gatfrom** (string) - Optional - The title of the transclusion to start enumerating from.

### Request Example
```
api.php?action=query&generator=alltransclusions&gatunique=&gatfrom=B
```

### Response
#### Success Response (200)
- **query.pages** (object) - Contains a map of pages generated from the transclusions.
  - **[pageid]** (object) - Represents a page.
    - **title** (string) - The title of the transcluded page.
```

--------------------------------

### Configure and Build wxmupen64plus

Source: https://mupen64plus.org/wiki/index.php/CrossCompilingOnLinux

Clone the wxmupen64plus repository and configure its build system using waf. This command sets up the necessary paths for wxWidgets, mupen64plus API, SDL, and specifies the target OS as Windows. It then builds the project and installs it to a specified directory. Finally, it copies the data files.

```bash
hg clone --cwd ./source/ https://bitbucket.org/auria/wxmupen64plus
(MXE="$(pwd)/mxe";BASE="$(pwd)"; target=i686-pc-mingw32; cd source/wxmupen64plus/ && WINDRES=${target}-windres CC="${target}-gcc" CXX="${target}-g++" ./waf configure --wxinclude="${MXE}/usr/${target}/include/wx-2.9/" --wxconfig="${target}-wx-config-nounicode" --mupenapi="${BASE}/source/mupen64plus-core/src/api/" --sdlconfig="${target}-sdl-config" --wxhome="${MXE}/usr/${target}/" --targetos=windows --debugger=false --prefix=/ --bindir=/ --datadir=wxm64pdata/  && ./waf && ./waf --destdir="${BASE}/test/" install)
cp -r ./source/wxmupen64plus/data ./test/wxm64pdata

```

--------------------------------

### Get pages containing the links (Generator)

Source: https://mupen64plus.org/wiki/index.php/Special%3AApiHelp/query%2Balllinks

This example utilizes the 'alllinks' module as a generator to retrieve pages that contain specific links, starting enumeration from 'B'.

```APIDOC
## GET api.php

### Description
Uses the 'alllinks' module as a generator to retrieve pages that contain links.

### Method
GET

### Endpoint
/api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - `query`
- **generator** (string) - Required - `alllinks`
- **galfrom** (string) - Optional - The title of the link to start enumerating from.

### Request Example
```
GET /api.php?action=query&generator=alllinks&galfrom=B
```

### Response
#### Success Response (200)
- **query.pages** (object) - Contains a map of pages generated by the 'alllinks' module.
  - **[pageid]** (object) - Represents a page.
    - **ns** (integer) - Namespace ID.
    - **title** (string) - Title of the page.
```

--------------------------------

### Build Mupen64Plus from Source

Source: https://mupen64plus.org/wiki/index.php/README

Unzip the source, navigate to the directory, and use 'make all' to build Mupen64Plus and its plugins.

```bash
$ unzip Mupen64Plus-x-y-z-src.zip
$ cd Mupen64Plus-x-y-z-src
$ make all
```

--------------------------------

### Get pages containing the files (generator)

Source: https://mupen64plus.org/wiki/index.php/Special%3AApiHelp/query%2Ballfileusages

This example utilizes the `allfileusages` module as a generator to retrieve the pages that contain specific files. It starts enumerating from file 'B'.

```APIDOC
## GET api.php

### Description
Uses the `allfileusages` module as a generator to retrieve pages that contain the specified files.

### Method
GET

### Endpoint
/api.php

### Query Parameters
- **action** (string) - Required - Set to `query`.
- **generator** (string) - Required - Set to `allfileusages`.
- **gaffrom** (string) - Optional - The title of the file to start enumerating from.

### Request Example
```
api.php?action=query&generator=allfileusages&gaffrom=B
```

### Response
#### Success Response (200)
- **query.pages** (object) - An object containing pages, where each page represents a file. Properties include 'pageid', 'ns', and 'title'.

#### Response Example
```json
{
  "batchcomplete": "",
  "query": {
    "pages": {
      "201": {
        "pageid": 201,
        "ns": 0,
        "title": "Article about File"
      }
    }
  }
}
```
```

--------------------------------

### Plugin Specification Examples

Source: https://mupen64plus.org/wiki/index.php?diff=89&oldid=88&title=UIConsoleUsage

Illustrates how to specify plugins (graphics, audio, input, RSP) by either their filename in the plugin directory or their full path. 'dummy' is a special keyword for using a dummy plugin.

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

--------------------------------

### Get pages containing the transclusions (generator)

Source: https://mupen64plus.org/wiki/api.php?action=help&modules=query%2Balltransclusions

This example utilizes the 'alltransclusions' module as a generator to retrieve the actual pages that contain the transclusions, starting from a specified title 'B'.

```APIDOC
## GET api.php

### Description
Uses the 'alltransclusions' module as a generator to retrieve the pages containing the transclusions.

### Method
GET

### Endpoint
/w/api.php

### Query Parameters
- **action** (string) - Required - Must be "query".
- **generator** (string) - Required - Must be "alltransclusions".
- **gatfrom** (string) - Optional - The title of the transclusion to start enumerating from.

### Request Example
```
api.php?action=query&generator=alltransclusions&gatfrom=B
```
```

--------------------------------

### Get all linked titles, marking missing ones (Generator)

Source: https://mupen64plus.org/wiki/index.php/Special%3AApiHelp/query%2Balllinks

This example uses the 'alllinks' module as a generator to retrieve all linked titles, marking those that are missing. It starts enumeration from 'B'.

```APIDOC
## GET api.php

### Description
Uses the 'alllinks' module as a generator to retrieve all linked titles, marking missing ones.

### Method
GET

### Endpoint
/api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - `query`
- **generator** (string) - Required - `alllinks`
- **galunique** (boolean) - Optional - Only show distinct linked titles.
- **galfrom** (string) - Optional - The title of the link to start enumerating from.

### Request Example
```
GET /api.php?action=query&generator=alllinks&galunique=&galfrom=B
```

### Response
#### Success Response (200)
- **query.pages** (object) - Contains a map of pages generated by the 'alllinks' module.
  - **[pageid]** (object) - Represents a page.
    - **ns** (integer) - Namespace ID.
    - **title** (string) - Title of the page.
```

--------------------------------

### Link Account Example

Source: https://mupen64plus.org/wiki/index.php/Special%3AApiHelp/linkaccount

This example demonstrates how to initiate the process of linking an account from a third-party provider named 'Example'. It includes the required `action`, `provider`, `linkreturnurl`, and `linktoken` parameters.

```APIDOC
## POST action=linkaccount

### Description
Links an account from a third-party provider to the current user. This module requires write permissions and only accepts POST requests.

### Method
POST

### Endpoint
/api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be `linkaccount`.
- **provider** (string) - Required - The name of the third-party provider.
- **linkreturnurl** (string) - Required - The absolute return URL for third-party authentication flows.
- **linktoken** (string) - Required - A 'csrf' token retrieved from `action=query&meta=tokens`.

#### Request Body
Parameters specific to the authentication requests, determined by `action=query&meta=authmanagerinfo`.

### Request Example
```
api.php?action=linkaccount&provider=Example&linkreturnurl=http://example.org/&linktoken=123ABC
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the linking process (e.g., PASS, FAIL, UI, REDIRECT, RESTART).
- **linkcontinue** (string) - Parameters for continuing the process after a UI or REDIRECT response.
- **redirecttarget** (string) - URL to redirect the user to for third-party authentication.
- **messages** (array) - Messages related to the linking process.
```

--------------------------------

### Retrieve Category Info with Prefix Filter

Source: https://mupen64plus.org/wiki/api.php?action=help&modules=query%2Ballcategories

This example demonstrates how to use the 'allcategories' module as a generator to get information about category pages themselves. It filters categories starting with 'List' and requests their 'info' property.

```api
api.php?action=query&generator=allcategories&gacprefix=List&prop=info
```

--------------------------------

### Configure and build wxmupen64plus

Source: https://mupen64plus.org/wiki/index.php?action=history&feed=atom&title=CrossCompilingOnLinux

Clone the wxmupen64plus source, then configure and build it using waf. This involves setting several environment variables like MXE, BASE, target, WINDRES, CC, CXX, and specifying paths for wxWidgets, mupen64plus API, and SDL. The build process also includes installing the application and copying data files.

```bash
hg clone --cwd ./source/ https://bitbucket.org/auria/wxmupen64plus
(MXE="$(pwd)/mxe";BASE="$(pwd)"; target=i686-pc-mingw32; cd source/wxmupen64plus/ &amp;&amp; WINDRES=${target}-windres CC="${target}-gcc" CXX="${target}-g++" ./waf configure --wxinclude="${MXE}/usr/${target}/include/wx-2.9/" --wxconfig="${target}-wx-config-nounicode" --mupen64plusAPI="${BASE}/source/mupen64plus-core/src/api/" --sdlconfig="${target}-sdl-config" --wxhome="${MXE}/usr/${target}/" --targetos=windows --debugger=false --prefix=/ --bindir=/ --datadir=wxm64pdata/ &amp;&amp; ./waf &amp;&amp; ./waf --destdir="${BASE}/test/" install)
```

```bash
cp -r ./source/wxmupen64plus/data ./test/wxm64pdata
```

--------------------------------

### Set Installation Paths

Source: https://mupen64plus.org/wiki/index.php?action=history&feed=atom&title=CompilingFromGit

Specify BINDIR and MANDIR to set the installation paths for the mupen64plus binary and manual page. Defaults are PREFIX/bin/ and PREFIX/share/man, respectively.

```shell
BINDIR=path
```

```shell
MANDIR=path
```

--------------------------------

### Input Plugin API: InitiateControllers

Source: https://mupen64plus.org/wiki/index.php?action=edit&title=Mupen64Plus_v2.0_Plugin_API

Sets up controller data structures.

```c
void InitiateControllers(CONTROL_INFO ControlInfo);
```

--------------------------------

### Get contributors for a page

Source: https://mupen64plus.org/wiki/api.php?action=help&modules=query&submodules=1

This example demonstrates how to get the list of contributors for the 'Main Page'.

```APIDOC
## GET query?prop=contributors

### Description
Get the list of logged-in contributors and the count of anonymous contributors to a page.

### Method
GET

### Endpoint
/api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be "query"
- **prop** (string) - Required - Must be "contributors"
- **titles** (string) - Required - The title of the page to get contributors for.
- **pcgroup** (string) - Optional - Only include users in the given groups. Values (separate with `|` or alternative): bot, bureaucrat, interface-admin, suppress, sysop.
- **pcexcludegroup** (string) - Optional - Exclude users in the given groups. Values (separate with `|` or alternative): bot, bureaucrat, interface-admin, suppress, sysop.
- **pcrights** (string) - Optional - Only include users having the given rights. Maximum number of values is 50 (500 for clients that are allowed higher limits).
- **pcexcluderights** (string) - Optional - Exclude users having the given rights. Maximum number of values is 50 (500 for clients that are allowed higher limits).
- **pclimit** (integer) - Optional - How many contributors to return. The value must be between 1 and 500. Default: 10.
- **pccontinue** (string) - Optional - When more results are available, use this to continue.

### Request Example
```json
{
  "example": "api.php?action=query&prop=contributors&titles=Main_Page"
}
```

### Response
#### Success Response (200)
- **query.pages[pageid].contributors** (array) - List of contributors.
- **query.pages[pageid].contributors.anonymouscount** (integer) - Count of anonymous contributors.

#### Response Example
```json
{
  "example": "{\n  \"batchcomplete\": \"\",\n  \"continue\": {\n    \"continue\": \"1000\",\n    \"clcontinue\": \"| |1000|\"\n  },\n  \"query\": {\n    \"pages\": {\n      \"1\": {\n        \"pageid\": 1,\n        \"ns\": 0,\n        \"title\": \"Main Page\",\n        \"contributors\": [\n          {\n            \"name\": \"User1\",\n            \"editcount\": 12345,\n            \"deleted\": \"\"\n          },\n          {\n            \"name\": \"User2\",\n            \"editcount\": 6789,\n            \"deleted\": \"\"\n          }\n        ],\n        \"anonymouscount\": 5\n      }\n    }\n  }\n}"
}
```
```

--------------------------------

### Install Mupen64Plus using install script

Source: https://mupen64plus.org/wiki/index.php?action=edit&oldid=39&title=MacOSXInstructions

Installs Mupen64Plus to the system using the provided installation script. This is typically done before packaging the application.

```bash
sudo ./install.sh
```

--------------------------------

### List Users Starting at 'Y'

Source: https://mupen64plus.org/wiki/api.php?action=help&modules=query%2Ballusers

This example demonstrates how to list users whose usernames start with 'Y'. It uses the `aufrom` parameter to specify the starting point for the enumeration.

```api
api.php?action=query&list=allusers&aufrom=Y
```

--------------------------------

### Install Mupen64Plus Binary Distribution

Source: https://mupen64plus.org/wiki/index.php?action=history&feed=atom&title=README

To install the pre-compiled binary distribution, switch to the root user and execute the `install.sh` script.

```bash
$ su
# ./install.sh
# exit
$
```

--------------------------------

### Example: Fetch revisions of pages by prefix

Source: https://mupen64plus.org/wiki/api.php?action=help&modules=query

An example of how to fetch revisions for pages whose titles start with a specific prefix.

```APIDOC
api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions&continue=
```

--------------------------------

### Configure and Build wxMupen64plus

Source: https://mupen64plus.org/wiki/index.php?action=history&feed=atom&title=CrossCompilingOnLinux

Clone the wxMupen64plus source, configure the build with specific paths and targets, build the project, and install it. Ensure the data files are copied manually after installation.

```bash
hg clone --cwd ./source/ https://bitbucket.org/auria/wxmupen64plus
(MXE="$(pwd)/mxe";BASE="$(pwd)"; target=i686-pc-mingw32; cd source/wxmupen64plus/ && WINDRES=${target}-windres CC="${target}-gcc" CXX="${target}-g++" ./waf configure --wxinclude="${MXE}/usr/${target}/include/wx-2.9/" --wxconfig="${target}-wx-config-nounicode" --mupenapi="${BASE}/source/mupen64plus-core/src/api/" --sdlconfig="${target}-sdl-config" --wxhome="${MXE}/usr/${target}/" --targetos=windows --debugger=false --prefix=/ --bindir=/ --datadir=wxm64pdata/ && ./waf && ./waf --destdir="${BASE}/test/" install)
```

```bash
cp -r ./source/wxmupen64plus/data ./test/wxm64pdata
```

--------------------------------

### Get page info using generator

Source: https://mupen64plus.org/wiki/api.php?action=help&modules=query%2Bcategorymembers

This example shows how to use the `generator=categorymembers` to get information about pages within a category.

```APIDOC
## GET api.php

### Description
Retrieves information about pages within a category by using `categorymembers` as a generator.

### Method
GET

### Endpoint
/api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - Set to `query`.
- **generator** (string) - Required - Set to `categorymembers`.
- **gcmtitle** (string) - Required - The category to enumerate. Must include the `Category:` prefix.
- **prop** (string) - Required - Which properties to get for each page. Example: `info`.
- **cmlimit** (integer) - Optional - The maximum number of pages to return. Defaults to 10. Maximum is 500.

### Request Example
```
api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info
```

### Response
#### Success Response (200)
- **query.pages** (object) - An object where keys are page IDs and values are page objects containing requested properties.

#### Response Example
```json
{
  "batchcomplete": "",
  "query": {
    "pages": {
      "123": {
        "pageid": 123,
        "ns": 0,
        "title": "Example Page",
        "contentmodel": "wikitext",
        "imagerepository": "local",
        "imageinfo": []
      }
    }
  }
}
```
```

--------------------------------

### View Available Make Targets and Options

Source: https://mupen64plus.org/wiki/index.php?action=history&feed=atom&title=README

Run `make` without arguments to display all available build targets, options, and installation configurations.

```bash
$ make
Mupen64Plus makefile. 
Targets:
all == Build Mupen64Plus and all plugins
clean == remove object files
rebuild == clean and re-build all
install == Install Mupen64Plus and all plugins
uninstall == Uninstall Mupen64Plus and all plugins
Options:
BITS=32 == build 32-bit binaries on 64-bit machine
VCR=1 == enable video recording
LIRC=1 == enable LIRC support
NO_RESAMP=1 == disable libsamplerate support in jttl_audio
NO_ASM=1 == build without assembly (no dynamic recompiler or MMX/SSE code)
GUI=NONE == build without GUI support
GUI=GTK2 == build with GTK2 GUI support (default)
GUI=QT4 == build with QT4 GUI support
Install Options:
PREFIX=path == install/uninstall prefix (default: /usr/local/)
SHAREDIR=path == path to install shared data (default: PREFIX/share/mupen64plus/)
BINDIR=path == path to install mupen64plus binary (default: PREFIX/bin/)
LIBDIR=path == path to install plugin libs (default: SHAREDIR/plugins/)
MANDIR=path == path to install manual files (default: PREFIX/man/man1/)
Debugging Options:
PROFILE=1 == build gprof instrumentation into binaries for profiling
DBGSYM=1 == add debugging symbols to binaries
DBG=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_PROFILE=1 == dump profiling data for r4300 dynarec to data file
```

--------------------------------

### Mupen64Plus Input Plugin Configuration Example

Source: https://mupen64plus.org/wiki/index.php?fulltext=1&profile=default&search=%241&title=Special%3ASearch

Example of configuring an input plugin for Mupen64Plus. Sets the controller mode to 1 and specifies the SDL joystick name for the main controller.

```text
Set controller #1 '''<code>mode</code>''' parameter to 1, and set the SDL joystick name of your desired main controller in to the '' 
```

--------------------------------

### Get parameter information for all submodules of a module

Source: https://mupen64plus.org/wiki/api.php?action=help&modules=paraminfo

This example shows how to get parameter information for all submodules of a given module, such as all submodules of 'action=query'.

```APIDOC
## GET api.php

### Description
Obtain parameter information for all submodules of a specified module.

### Method
GET

### Endpoint
/api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be "paraminfo".
- **modules** (string) - Required - Module name with wildcard to specify all submodules (e.g., "query+*").

### Request Example
```
api.php?action=paraminfo&modules=query%2B*
```
```

--------------------------------

### Mupen64Plus-UI-Console Install Options

Source: https://mupen64plus.org/wiki/index.php?diff=cur&oldid=23&title=CompilingFromGit

Specify installation paths for the mupen64plus binary and manual page.

```shell
BINDIR=path    == path to install mupen64plus binary (default: PREFIX/bin/)
MANDIR=path    == path to install mupen64plus manual page (default: PREFIX/share/man)
```

--------------------------------

### Get Link Page Information (API)

Source: https://mupen64plus.org/wiki/index.php/Special%3AApiHelp/query%2Blinks

This example uses the 'generator=links' to get information about the pages that are linked from 'Main Page'. It combines 'generator=links' with 'prop=info'.

```api
api.php?action=query&generator=links&titles=Main%20Page&prop=info
```

--------------------------------

### Build Mupen64Plus with Extra Components

Source: https://mupen64plus.org/wiki/index.php/CrossCompilingOnLinux

Compile Mupen64Plus along with specific extra components like RSP and video plugins. This example shows how to build multiple components and specific plugins with custom build options.

```bash
M64P_COMPONENTS="rsp-z64 video-arachnoid video-glide64 video-z64 rsp-cxd4" ./m64p_get.sh
M64P_COMPONENTS="rsp-z64 video-arachnoid video-glide64 video-z64 rsp-cxd4" ./m64p_build.sh CROSS_COMPILE=i686-pc-mingw32- HOST_CPU=i686 UNAME=MINGW
M64P_COMPONENTS="rsp-z64" ./m64p_build.sh CROSS_COMPILE=i686-pc-mingw32- HOST_CPU=i686 UNAME=MINGW HLEVIDEO=1
M64P_COMPONENTS="rsp-cxd4" ./m64p_build.sh CROSS_COMPILE=i686-pc-mingw32- HOST_CPU=i686 UNAME=MINGW SSE=SSSE3
M64P_COMPONENTS="rsp-cxd4" ./m64p_build.sh CROSS_COMPILE=i686-pc-mingw32- HOST_CPU=i686 UNAME=MINGW SSE=none
```

--------------------------------

### API Help Examples

Source: https://mupen64plus.org/wiki/api.php

Examples demonstrating how to access help documentation for the API.

```APIDOC
## Examples

Help for the main module:
`api.php?action=help`

All help in one page:
`api.php?action=help&recursivesubmodules=1`
```

--------------------------------

### Get information about files used in a page

Source: https://mupen64plus.org/wiki/api.php?action=help&modules=query%2Bimages

This example shows how to use the generator=images combined with prop=info to get detailed information about all files used on a page.

```APIDOC
## GET api.php

### Description
Returns information about files generated from a list of pages.

### Method
GET

### Endpoint
/api.php

### Query Parameters
- **action** (string) - Required - Must be "query".
- **generator** (string) - Required - Must be "images" or "im".
- **titles** (string) - Required - The page title(s) to query. Separate multiple titles with '|'.
- **prop** (string) - Required - Specifies the properties to retrieve for the generated images. For example, "info" to get file metadata.
- **imlimit** (integer or `max`) - Optional - How many files to return. Maximum value is 500. Defaults to 10.
- **imcontinue** (string) - Optional - Used to continue pagination when more results are available.

### Request Example
```
api.php?action=query&generator=images&titles=Main%20Page&prop=info
```

### Response
#### Success Response (200)
- **query.pages[pageid]** (object) - Contains properties of the generated images, such as 'title', 'ns', 'size', 'timestamp', etc., depending on the 'prop' parameter.

#### Response Example
```json
{
  "batchcomplete": "",
  "continue": {
    "imcontinue": 1,
    "continue": "-1"
  },
  "query": {
    "pages": {
      "1": {
        "pageid": 1,
        "ns": 0,
        "title": "Main Page",
        "imagerepository": "local",
        "imageinfo": [
          {
            "url": "https://mupen64plus.org/wiki/images/a/a1/Example.jpg",
            "descriptionurl": "https://mupen64plus.org/wiki/index.php/File:Example.jpg",
            "descriptionshorturl": "https://mupen64plus.org/wiki/index.php?curid=1",
            "timestamp": "2023-01-01T10:00:00Z",
            "size": 12345,
            "width": 100,
            "height": 100,
            "mime": "image/jpeg",
            "thumburl": "https://mupen64plus.org/wiki/images/thumb/a/a1/Example.jpg/100px-Example.jpg",
            "thumbwidth": 100,
            "thumbheight": 100
          }
        ]
      }
    }
  }
}
```
```

--------------------------------

### JSON API Result Example

Source: https://mupen64plus.org/wiki/api.php?action=query&amisecuritysensitiveoperation=foo&meta=authmanagerinfo

This is an example of the JSON output from the MediaWiki API, showing authentication manager information. Specify `format=json` to get this output.

```json
{
    "batchcomplete": "",
    "query": {
        "authmanagerinfo": {
            "canauthenticatenow": "",
            "cancreateaccounts": "",
            "securitysensitiveoperationstatus": "reauth"
        }
    }
}

```

--------------------------------

### Configure and Build wxmupen64plus

Source: https://mupen64plus.org/wiki/index.php?oldid=28&title=CrossCompilingOnLinux

Clone the wxmupen64plus source code and configure its build system using waf. This command sets up the build environment, compiles the application, and installs it to a specified destination. Ensure the MXE environment and core mupen64plus API paths are correctly set.

```bash
hg clone --cwd ./source/ https://bitbucket.org/auria/wxmupen64plus
(MXE="$(pwd)/mxe";BASE="$(pwd)"; target=i686-pc-mingw32; cd source/wxmupen64plus/ && WINDRES=${target}-windres CC="${target}-gcc" CXX="${target}-g++" ./waf configure --wxinclude="${MXE}/usr/${target}/include/wx-2.9/" --wxconfig="${target}-wx-config-nounicode" --mupen64plusApi="${BASE}/source/mupen64plus-core/src/api/" --sdlconfig="${target}-sdl-config" --wxhome="${MXE}/usr/${target}/" --targetos=windows --debugger=false --prefix=/ --bindir=/ --datadir=wxm64pdata/  && ./waf && ./waf --destdir="${BASE}/test/" install)
```

--------------------------------

### Mupen64Plus Command-Line Help

Source: https://mupen64plus.org/wiki/index.php?action=history&feed=atom&title=README

Display all available command-line options for the mupen64plus emulator. Use these to customize runtime behavior.

```bash
$ mupen64plus --help
Usage: mupen64plus [parameter(s)] rom

Parameters:
--nogui : do not display GUI
--fullscreen : turn fullscreen mode on
--noosd : disable onscreen display.
--gfx (path) : use gfx plugin given by (path)
--audio (path) : use audio plugin given by (path)
--input (path) : use input plugin given by (path)
--rsp (path) : use rsp plugin given by (path)
--emumode (number) : set emu mode to: 0=Interpreter 1=DynaRec 2=Pure Interpreter
--sshotdir (dir) : set screenshot directory (dir)
--configdir (dir) : force config dir (must contain mupen64plus.conf)
--installdir (dir) : force install dir (place to look for plugins, icons, lang, etc)
--noask : dont ask to force load on bad dumps
--testshots (list) : take screenshots at frames given in comma-separated list, then quit
-h, --help : see this help message
```

--------------------------------

### Get Revisions with Start Time

Source: https://mupen64plus.org/wiki/api.php?action=help&modules=query&submodules=1

Retrieves revisions made after a specific timestamp.

```APIDOC
## Get Revisions with Start Time

### Description
Retrieves revisions made after a specific timestamp.

### Method
GET

### Endpoint
/api.php

### Query Parameters
- **action** (string) - Required - Must be "query".
- **prop** (string) - Required - Must be "revisions".
- **titles** (string) - Required - The title of the page.
- **rvlimit** (integer) - Optional - The maximum number of revisions to return.
- **rvprop** (string) - Required - Specifies the properties to retrieve for each revision (e.g., "timestamp|user|comment").
- **rvdir** (string) - Optional - The direction to list revisions. Use "newer" to get revisions after `rvstart`.
- **rvstart** (string) - Optional - Timestamp to start listing revisions from (e.g., "2006-05-01T00:00:00Z").

### Request Example
```
api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer&rvstart=2006-05-01T00:00:00Z
```
```

--------------------------------

### Get User Contributions Feed

Source: https://mupen64plus.org/wiki/index.php/Special%3AApiHelp/feedcontributions

Retrieve a user's contributions feed. This example shows how to get contributions for a specific user. The feed format defaults to RSS.

```api
api.php?action=feedcontributions&user=Example
```

--------------------------------

### Mupen64Plus Command-line Options

Source: https://mupen64plus.org/wiki/index.php/README

Run 'mupen64plus --help' to view all available command-line parameters. These options control GUI display, fullscreen mode, plugin paths, emulation settings, and configuration directories.

```bash
$ mupen64plus --help
Usage: mupen64plus [parameter(s)] rom

Parameters:
        --nogui                 : do not display GUI
        --fullscreen            : turn fullscreen mode on
        --noosd                 : disable onscreen display.
        --gfx (path)            : use gfx plugin given by (path)
        --audio (path)          : use audio plugin given by (path)
        --input (path)          : use input plugin given by (path)
        --rsp (path)            : use rsp plugin given by (path)
        --emumode (number)      : set emu mode to: 0=Interpreter 1=DynaRec 2=Pure Interpreter
        --sshotdir (dir)        : set screenshot directory to (dir)
        --configdir (dir)       : force config dir (must contain mupen64plus.conf)
        --installdir (dir)      : force install dir (place to look for plugins, icons, lang, etc)
        --noask                 : dont ask to force load on bad dumps
        --testshots (list)      : take screenshots at frames given in comma-separated list, then quit
        -h, --help              : see this help message

```

--------------------------------

### Mupen64Plus-Core Install Options

Source: https://mupen64plus.org/wiki/index.php?diff=cur&oldid=23&title=CompilingFromGit

Specify the installation path for core header files.

```shell
INCDIR=path   == path to install core header files (default: PREFIX/include/mupen64plus)
```

--------------------------------

### MediaWiki API JSON Result Example

Source: https://mupen64plus.org/wiki/api.php?action=query&prop=info&titles=Main+Page

This is an example of a JSON response from the MediaWiki API, detailing information about a specific page. Use `format=json` to get this output for application integration.

```json
{
    "batchcomplete": "",
    "query": {
        "pages": {
            "1": {
                "pageid": 1,
                "ns": 0,
                "title": "Main Page",
                "contentmodel": "wikitext",
                "pagelanguage": "en",
                "pagelanguagehtmlcode": "en",
                "pagelanguagedir": "ltr",
                "touched": "2015-07-22T03:58:39Z",
                "lastrevid": 18,
                "length": 660
            }
        }
    }
}

```

--------------------------------

### Mupen64Plus-Audio-SDL Specific Build Options

Source: https://mupen64plus.org/wiki/index.php/Special%3ASearch/CompilingFromGit

Lists compile-time options for the Mupen64Plus-Audio-SDL module, controlling support for OSS, libsamplerate, and libspeexdsp.

```makefile
  General Options:
    NO_OSS=1      == build without OSS; disables Open Sound System support
    NO_SRC=1      == build without libsamplerate; disables src-* high-quality audio resampling
    NO_SPEEX=1    == build without libspeexdsp; disables speex-* high-quality audio resampling

```

--------------------------------

### Install Mupen64Plus Binary Distribution

Source: https://mupen64plus.org/wiki/index.php/README

Execute the install.sh script as root to install the binary distribution. This places the executable in /usr/local/bin and shared files in /usr/local/share/mupen64plus.

```bash
su
# ./install.sh
# exit
$
```

--------------------------------

### Get information about pages transcluding a specific title using generator

Source: https://mupen64plus.org/wiki/index.php/Special%3AApiHelp/query%2Btranscludedin

This example shows how to use the `generator=transcludedin` to get information about pages that transclude a given title. This is useful for batch operations.

```APIDOC
## GET query+generator=transcludedin

### Description
Find all pages that transclude the given pages and retrieve their information.

### Method
GET

### Endpoint
/api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be "query".
- **generator** (string) - Required - Must be "transcludedin" or "ti".
- **titles** (string) - Required - The title(s) of the pages to find transclusions for.
- **prop** (string) - Required - Properties to get for the generated pages. Example: "info".
- **tiprop** (string) - Optional - Which properties to get for the transcluding pages themselves (used by the generator). Values: pageid, title, redirect. Default: pageid|title|redirect.
- **tinamespace** (string) - Optional - Only include pages in these namespaces for the generator. Values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 2300, 2301, 2302, 2303. Use '*' for all.
- **tishow** (string) - Optional - Show only items that meet these criteria for the generator. Values: !redirect (non-redirects), redirect (redirects).
- **tilimit** (integer|string) - Optional - How many results to return from the generator. Type: integer or `max`. The value must be between 1 and 500. Default: 10.
- **ticontinue** (string) - Optional - When more results are available, use this to continue the query.

### Request Example
```
GET api.php?action=query&generator=transcludedin&titles=Main%20Page&prop=info
```

### Response
#### Success Response (200)
- **query.pages** (object) - Contains information about the generated pages.
  - **[pageid]** (object) - Information about a specific generated page (e.g., page info).
    - **pageid** (integer) - The ID of the page.
    - **ns** (integer) - The namespace of the page.
    - **title** (string) - The title of the page.
```

--------------------------------

### Generator Categories

Source: https://mupen64plus.org/wiki/index.php/Special%3AApiHelp/query%2Bcategories

This example shows how to use the `generator=categories` to get information about all categories used in a page.

```APIDOC
## GET query+generator=categories

### Description
Get information about all categories used in the page.

### Method
GET

### Endpoint
/w/api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - `query`
- **generator** (string) - Required - `categories`
- **titles** (string) - Required - The title of the page(s) to query.
- **prop** (string) - Required - Properties to retrieve for the generated categories (e.g., `info`).
- **cllimit** (integer|string) - Optional - How many categories to return. Accepts an integer between 1 and 500, or `max`. Default: 10.

### Request Example
```
api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info
```

### Response
#### Success Response (200)
- **query.pages[pageid]** (object) - Information about the categories generated.

#### Response Example
```json
{
  "batchcomplete": "",
  "query": {
    "pages": {
      "12345": {
        "pageid": 12345,
        "ns": 0,
        "title": "Albert Einstein",
        "categories": [
          {
            "pageid": 54321,
            "ns": 14,
            "title": "Category:Example Category"
          }
        ]
      }
    }
  }
}
```
```

--------------------------------

### Common Build Options

Source: https://mupen64plus.org/wiki/index.php?action=edit&title=CompilingFromGit

Lists general, installation, and debugging options applicable to most Mupen64Plus modules during compilation.

```makefile
General Options:
 BITS=32 == build 32-bit binaries on 64-bit machine
 APIDIR=path == path to find Mupen64Plus Core headers
 OPTFLAGS=flag == compiler optimization (default: -O3)
 PIC=(1|0) == Force enable/disable of position independent code

Install Options:
 PREFIX=path == install/uninstall prefix (default: /usr/local)
 SHAREDIR=path == path to install shared data files (default: PREFIX/share/mupen64plus)
 LIBDIR=path == library prefix (default: PREFIX/lib)
 PLUGINDIR=path == path to install plugin libraries (default: LIBDIR/mupen64plus)
 DESTDIR=path == path to prepend to all installation paths (only for packagers)

Debugging Options:
 DEBUG=1 == add debugging symbols
 V=1 == show verbose compiler output
```

--------------------------------

### View Available Build Options

Source: https://mupen64plus.org/wiki/index.php?action=edit&title=README

Command to display all available build targets and options for Mupen64Plus using make.

```bash
$ make Mupen64Plus
```
Tokens:
Raw