aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: e6d368d49da576628d9ab7fea93f06225ee9de0e (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
Spear
=====

Spear is a simple 2.5D game engine I have been working on since I started learning Haskell.
The project's goal is to put what I learn into practise, to explore how far I can get with Haskell and if the results
are decent enough, to build one or two game demos along the way.

Installation
------------

Simply clone the repo and build with cabal:

```
$ git clone https://github.com/jeannekamikaze/Spear.git
$ cd Spear
$ cabal install
```

Documentation
-------------

An online copy of the haddocks can be found [here][0].

Features
--------

### Application and Input
* Easy way to set up a window with the desired OpenGL context version.
* Raw polled, toggled and delayed input.
* High resolution timer.

### Assets
* MD2 and OBJ model loaders.
* BMP image loader.
* Assets backed up by Resource for automatic (and optionally, manual) deletion.

### Collision
* Simple collision library featuring AABBs and bounding circles.

### OpenGL
* OpenGL >=3 wrapper library.
* OpenGL resources (VAOs, buffers, textures, etc.) backed up by Resource for automatic (and optionally, manual) deletion.

### Math
* Vectors, matrices, quaternions, cameras, segments, rays, etc.
* The Spatial2 and Spatial3 type classes for objects that can be moved around in 2D and 3D space, respectively.

### Render
* Static and vertex-animated model resources, compiled into a VAO for efficient rendering.
* Static and vertex-animated model renderers. Vertex animation is done in a vertex shader.

### Scene
* Automated loading of scenes and scene resources as described by scene files.

[0]: http://shellblade.net/docs/Spear/index.html