aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 8435225fb43b13b175e8ff2338a3d0f856fa9ee2 (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
FAQE
====

Faqe is a simple quake-inspired clone.

It is currently a work in progress.

Dependencies
------------

- OpenGL 3.2+
- SDL2
- eprintf (make)
- libpng 1.2+
- linmath (make)
- GNU make (make)
- pkg-config (make)

Compilation
-----------

Make sure a copy of the linmath and eprintf modules can be located in
the directory containing the faqe project. Optionally `EPRINTF_PATH`
and `LINMATH_PATH` can be set to specify their locations.

You can use config.mk to permanently specify any compilation options
(including the aforementioned `_PATH` variables).

Then run `make`. The project does not have an install target yet.

Assets
------

faqe currently looks for assets relative to its working
directory. Assets should be located in a directory called
"assets". faqe currently only tries to load one model called
"utah.fmd".

Example assets can be downloaded from [here][assets].

Contributing
------------

To contribute, please send a patch to the mailing list at
[faqe-devel@the-tk.com][list-mailto].

List archives can be found [here][list-archive].

[assets]: https://the-tk.com/shit/assets.tgz "Example Assets"
[list-mailto]: mailto:faqe-devel@the-tk.com "faqe Development Mailing List"
[list-archive]: https://the-tk.com/archive/faqe-devel/ "faqe Development Mailing List Archive"