README 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. RetroArch is the reference frontend for the libretro API. Popular
  2. examples of implementations for this API includes videogame system
  3. emulators and game engines, but also more generalized 3D programs.
  4. These programs are instantiated as dynamic libraries. We refer to these
  5. as "libretro cores".
  6. libretro is an API that exposes generic audio/video/input callbacks. A
  7. frontend for libretro (such as RetroArch) handles video output, audio
  8. output, input and application lifecycle. A libretro core written in
  9. portable C or C++ can run seamlessly on many platforms with very
  10. little/no porting effort.
  11. While RetroArch is the reference frontend for libretro, several other
  12. projects have used the libretro interface to include support for
  13. emulators and/or game engines. libretro is completely open and free for
  14. anyone to use.
  15. RetroArch will require at least one of the libretro cores to play any
  16. games.
  17. Optional dependencies:
  18. jack-audio-connection-kit libsixel libxkbcommon mbedtls miniupnpc
  19. nvidia-cg-toolkit OpenAL qt5 wayland-egl
  20. Note: RetroArch can optionally use wayland-protocols during the build if
  21. it is installed. Instead of installing wayland-egl mesa can be rebuilt
  22. with Wayland support, using the following configure parameters.
  23. --with-egl-platforms=x11,drm,wayland
  24. To build debugging symbols for RetroArch use:
  25. DEBUG=yes ./RetroArch.SlackBuild
  26. If building debugging symbols asan can also be built:
  27. DEBUG=yes ASAN=yes ./RetroArch.SlackBuild
  28. Discord integration can be enabled with:
  29. DISCORD=yes
  30. Python3 support for shaders will need to be enabled with:
  31. PYTHON=yes ./RetroArch.SlackBuild
  32. If pulseaudio is installed it can be disabled during the build with:
  33. PULSE=no ./RetroArch.SlackBuild
  34. The Qt5 frontend can be disabled with:
  35. QT=no ./RetroArch.SlackBuild
  36. The materialui menu driver can be disabled with:
  37. GLUI=no ./RetroArch.SlackBuild
  38. The ozone menu driver can be disabled with:
  39. OZONE=no ./RetroArch.SlackBuild
  40. The rgui menu driver can be disabled with:
  41. RGUI=no ./RetroArch.SlackBuild
  42. The xmb menu driver can be disabled with:
  43. XMB=no ./RetroArch.SlackBuild
  44. All of the menu drivers can be disabled with:
  45. MENU=no ./RetroArch.SlackBuild
  46. Alternatively pulseaudio can be disabled later in RetroArch's
  47. configuration.
  48. Retroarch optionally supports using OpenGL ES 2 and OpenGL ES 3 instead
  49. of OpenGL which will require video card and driver support. This can be
  50. done by building RetroArch with:
  51. GLES=yes ./RetroArch.SlackBuild
  52. or
  53. GLES3=yes ./RetroArch.SlackBuild
  54. RetroArch optionally supports using Vulkan instead of OpenGL, this will
  55. require support for your video card and driver.
  56. For additional notes, please see README.SLACKWARE.
  57. For more information on RetroArch or libretro please visit this site.
  58. https://docs.libretro.com/