RetroArch

https://docs.libretro.com
Admin
RetroArch is a frontend for emulators, game engines, and media players, enabling users to run...
Tokens:719,764
Snippets:7,563
Trust Score:9.8
Update:4 days ago
Show doc for...
Tokens:
Raw
### Install core dependencies

Source: https://docs.libretro.com/development/retroarch/compilation/android

Reference to the dependencies repository and an example of installing a development library via apt-get.

```bash
https://github.com/libretro/libretro-deps/

#these deps can usually be installed via apt-get install (don't forget to append -dev at the end). for example:

sudo apt-get install libfaac-dev
```

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

### Install GCC and Make

Source: https://docs.libretro.com/development/retroarch/compilation/windows

Installs the compiler and build automation tools.

```bash
pacman -S make
pacman -S gcc
```

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

### Preview documentation with dev-server

Source: https://docs.libretro.com/meta/how-to-contribute

Start the built-in MkDocs development server to preview changes locally.

```bash
mkdocs serve
```

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

### Verify Python and pip installation

Source: https://docs.libretro.com/meta/how-to-contribute

Check that Python and pip are installed on your system before proceeding with the documentation build setup.

```bash
python --version
pip --version
```

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

### Get Linux graphic card information

Source: https://docs.libretro.com/guides/generating-retroarch-logs

Use this command to retrieve details about the installed graphics card.

```bash
lspci -nnk | grep -A 3 VGA
```

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

### Build the documentation site

Source: https://docs.libretro.com/meta/how-to-contribute

Generate the static documentation site in the site directory.

```bash
mkdocs build
```

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

### PLAY_REPLAY_SLOT command example

Source: https://docs.libretro.com/development/retroarch/network-control-interface

Starts playback of a replay from a specific slot. Requires BSV movie support. Response: `PLAY_REPLAY_SLOT <identifier>`.

```bash
retroarch --command "PLAY_REPLAY_SLOT 1"

```

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

### Compile for Windows x64 with Visual Studio 2017

Source: https://docs.libretro.com/development/cores/core-specific/pcsx2

Run these commands from the PCSX2 source directory to build the libretro core with Visual Studio 2017. If you get 'Could not find named generator', install 'mingw-w64-x86_64-cmake' instead of the regular cmake on Msys2/Mingw. If you get 'Visual Studio 15 2017 could not find any instance of Visual Studio', install 'Visual C++ tools for CMake' under 'Desktop development with C++'.

```shell
mkdir build
cd build
cmake .. -DLIBRETRO=ON -DCMAKE_BUILD_TYPE=Release -G"Visual Studio 15 2017 Win64"
cmake --build . --target pcsx2_libretro --config Release
```

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

### Install 64-bit Qt dependencies

Source: https://docs.libretro.com/development/retroarch/compilation/windows

Optional packages for 64-bit desktop GUI support.

```bash
pacman -S --noconfirm --needed mingw-w64-x86_64-qt5  mingw-w64-x86_64-openssl
```

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

### C89-compliant multiline comment and function pointer declaration

Source: https://docs.libretro.com/development/coding-standards

Shows the required legacy comment style with /* and */, a maximum column width of 80 characters, and each new line starting with a space and an asterisk. The example includes a function pointer declaration for get_sensor_input.

```C
/**
  * Retrieves the sensor state associated with the provided port and ID. This
  * function pointer may be set to NULL if retrieving sensor state is not
  * supported.
  * 
  * @param data  The input state struct
  * @param port
  * @param id    Sensor ID
  * 
  * @return The current state associated with the port and ID as a float
 **/
float (*get_sensor_input)(void *data, unsigned port, unsigned id);
```

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

### Install software-properties-common

Source: https://docs.libretro.com/guides/install-gnu

Ensures the necessary tools are installed to manage PPA package sources on your system.

```bash
sudo apt --update --yes install software-properties-common
```

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

### Example game folder structure

Source: https://docs.libretro.com/library/boom3

Recommended directory layout for organizing the .pk4 files within the content directory.

```text
└── contents/
    └── doom3/
        ├── base/
        │   ├── pak000.pk4
        │   ├── pak001.pk4
        │   ├── pak002.pk4
        │   ├── pak003.pk4
        │   ├── pak004.pk4
        │   ├── pak005.pk4
        │   ├── pak006.pk4
        │   ├── pak007.pk4
        │   └── pak008.pk4
        └── d3xp/
            ├── pak000.pk4 
            └── pak001.pk4
```

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

### Compile for Windows x64 with Visual Studio 2019

Source: https://docs.libretro.com/development/cores/core-specific/pcsx2

Run these commands from the PCSX2 source directory to build the libretro core with Visual Studio 2019. If you get 'Could not find named generator', install 'mingw-w64-x86_64-cmake' instead of the regular cmake on Msys2/Mingw.

```shell
mkdir build
cd build
cmake .. -DLIBRETRO=ON -G"Visual Studio 16 2019"
cmake --build . --target pcsx2_libretro --config Release
```
Tokens:
Raw