diff options
Diffstat (limited to 'games/xroar/README_SBo.txt')
| -rw-r--r-- | games/xroar/README_SBo.txt | 32 |
1 files changed, 22 insertions, 10 deletions
diff --git a/games/xroar/README_SBo.txt b/games/xroar/README_SBo.txt index c7ccc12db3..0f685f6196 100644 --- a/games/xroar/README_SBo.txt +++ b/games/xroar/README_SBo.txt @@ -1,22 +1,31 @@ +xroar supports multiple audio systems and has two user interfaces, +gtk2 (using gtkglext) and sdl2 (very bare-bones; no menus). By +default, both UIs are built, as is support for PulseAudio and plain +ALSA audio. For most users, these defaults are just fine. If you have +different needs, read on. + Optional Dependencies ===================== -SDL2 - If this is installed, xroar's alternate "bare-bones" SDL2 - user inteface will be available via the "-ui sdl" option. - -jack - if you want to use JACK for audio output, install jack and set +jack - If you want to use JACK for audio output, install jack and set JACK=yes in the environment before building xroar. If JACK audio has x-runs, try 'setcap cap_ipc_lock,cap_sys_nice=ep /usr/games/xroar'. + If you don't know what jack is, or why you might want to use it, then + you don't want it. Environment Variables ===================== +JACK - see above. Default: no. + GTKGLEXT - If you have gtkglext installed, but don't want to build - xroar with it, export GTKGLEXT=no [1] [2]. + xroar with it, export GTKGLEXT=no [1] [2]. Default: yes. -SDL2 - If you have SDL2 installed, but don't want to build xroar with - it, export SDL2=no [2]. +SDL2 - If you don't want to build xroar with SDL2, export SDL2=no [2]. + This will remove the "-ui sdl" option, which is probably + of no consequence since the SDL user interface isn't very + featureful. Default: yes. OSS - use OSS for audio? Default is "no", export OSS="yes" to enable. Most users won't need this. @@ -28,9 +37,12 @@ Notes ===== [1]: Yes, gtkglext is optional, despite being listed in REQUIRES in - the .info file. There's no "either-or" syntax for REQUIRES, so - I had to list either gtkglext or SDL2, and the gtkglext UI - is a lot nicer so it's what most people will want. + the .info file. I made it a hard dependency because the SDL user + interface has no real GUI features, while the gtkglext UI acts + like a proper GUI application. Users who just take the defaults + will end up with the usable UI. If you're reading this, you're + welcome to ignore the REQUIRES="gtkglext" and build with SDL2 + only, if you have a reason to want to. [2]: At least one of SDL2 or gtkglext is required, so you can't build with SDL2=no GTKGLEXT=no. If you want to be super-pedantic, yes, |