summaryrefslogtreecommitdiffstats
path: root/games/RetroArch/README
blob: 8107802733d9f863432a1832460ef672e64b2dab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
RetroArch is the reference frontend for the libretro API. Popular
examples of implementations for this API includes videogame system
emulators and game engines, but also more generalized 3D programs.
These programs are instantiated as dynamic libraries. We refer to these
as "libretro cores".

libretro is an API that exposes generic audio/video/input callbacks. A
frontend for libretro (such as RetroArch) handles video output, audio
output, input and application lifecycle. A libretro core written in
portable C or C++ can run seamlessly on many platforms with very
little/no porting effort.

While RetroArch is the reference frontend for libretro, several other
projects have used the libretro interface to include support for
emulators and/or game engines. libretro is completely open and free for
anyone to use.

RetroArch will require at least one of the libretro cores to play any
games.

Optional dependencies:
  ffmpeg jack libsixel libxkbcommon mbedtls miniupnpc nvidia-cg-toolkit
  OpenAL python3 qt5 SDL2 vulkan-sdk wayland-egl wayland-protocols

Note: RetroArch can optionally use wayland-protocols during the build if
it is installed. Instead of installing wayland-egl mesa can be rebuilt
with Wayland support, using the following configure parameters.

  --with-egl-platforms=x11,drm,wayland

To build debugging symbols for RetroArch use:
  DEBUG=yes ./RetroArch.SlackBuild

If building debugging symbols asan can also be built:
  DEBUG=yes ASAN=yes ./RetroArch.SlackBuild

Discord integration can be enabled with:
  DISCORD=yes

Python3 support for shaders will need to be enabled with:
  PYTHON=yes ./RetroArch.SlackBuild

If pulseaudio is installed it can be disabled during the build with:
  PULSE=no ./RetroArch.SlackBuild

The Qt5 frontend can be disabled with:
  QT=no ./RetroArch.SlackBuild

The materialui menu driver can be disabled with:
  GLUI=no ./RetroArch.SlackBuild

The ozone menu driver can be disabled with:
  OZONE=no ./RetroArch.SlackBuild

The rgui menu driver can be disabled with:
  RGUI=no ./RetroArch.SlackBuild

The xmb menu driver can be disabled with:
  XMB=no ./RetroArch.SlackBuild

All of the menu drivers can be disabled with:
  MENU=no ./RetroArch.SlackBuild

Alternatively pulseaudio can be disabled later in RetroArch's
configuration.

Retroarch optionally supports using OpenGL ES 2 and OpenGL ES 3 instead
of OpenGL which will require video card and driver support. This can be
done by building RetroArch with:
  GLES=yes ./RetroArch.SlackBuild
or
  GLES3=yes ./RetroArch.SlackBuild

RetroArch optionally supports using Vulkan instead of OpenGL, this will
require the vulkan-sdk from SBo and support for your video card and
driver.

For additional notes, please see README.SLACKWARE.

For more information on RetroArch or libretro please visit this site.

  https://docs.libretro.com/