README
1For some build-environments where you want tight control over which dependencies
2that are linked statically / dynamically and how these libraries are configured,
3some additional measures are needed.
4
5On systems with the dependencies for [video/input platforms] fulfilled, the only
6needed libraries should be openctm, openal, freetype, sqlite3, and lua51 or
7luajit.
8
9For openal/freetype/luajit, there is a bash script in external/git/clone.sh that
10clones the repositories needed for a static build. CMake will check for the
11corresponding folders during configuration, and for the ones that are found,
12the normal FindModule will be side-stepped.
13
14To set up manually, just make sure that the following git mapping is correct:
15
16http://luajit.org/git/luajit-2.0.git external/luajit
17git://git.sv.nongnu.org/freetype/freetype2.git external/freetype
18git://github.com/mirros/openal-soft.git external/openal
19
20Note that for OpenAL, only LWA will use the git mirror (in order to apply
21patches) by default. For regular arcan, -DSTATIC_OPENAL=ON must also be specified.
22
23The download script also includes 'libuvc' for portable USB based video camera
24support. This is not used unless explicitly built into the decode frameserver
25as a build-time option (default=Off).
26
compat.README
1Compatibility Strategy:
2
3Arcan as a display server is protocol-less. There is an highly volatile API
4for segmenting the server into multiple-processes and a selection of in-house
5maintained backends that use this API to connect, draw and retrieve input.
6
7This means that with new versions, new updates to this API will need a full
8recompile to existing backends in order to remain usable, meaning that they
9should be updated 'in lockstep' with the main engine. This makes the API unfit
10- by design - for use by other projects, with the exception of the TUI library
11that is intended for 3rd party use.
12
13The maintained backends and their repositories are:
14
15SDL2:
16https://github.com/letoram/SDL2.git
17( may need to explicitly specify SDL_VIDEODRIVER=arcan SDL_AUDIORIVER=arcan )
18
19Xarcan:
20https://github.com/letoram/xarcan.git
21( see the README for compilation instructions )
22
23QEmu
24https://github.com/letoram/QEMU.git
25( activated with the -display arcan argument )
26
27In order to allow clients and toolkits written for other APIs and protocols
28to be used, we also have bridging tools that are given special consideration.
29
30The maintained bridging tools are:
31Waybridge (src/tools/waybridge)
32