aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 32 insertions, 3 deletions
diff --git a/README.md b/README.md
index 59a46a0..1e22d96 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,7 @@
1Spear 1Spear
2===== 2=====
3 3
4Spear is a simple 3D game framework I have been working on since I started learning Haskell, and is therefore more of a "let's see where I can get to" kind of project. 4Spear is a simple 3D game framework 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.
5
6The 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.
7 5
8Installation 6Installation
9------------ 7------------
@@ -21,4 +19,35 @@ Documentation
21 19
22An online copy of the haddocks can be found [here][0]. 20An online copy of the haddocks can be found [here][0].
23 21
22Features
23--------
24
25### Application and Input
26* Easy way to set up a window with the desired OpenGL context version.
27* Raw polled, toggled and delayed input.
28* High resolution timer.
29
30### Assets
31* MD2 and OBJ model loaders.
32* BMP image loader.
33* Assets backed up by Resource for automatic (and optionally, manual) deletion.
34
35### Collision
36* Simple collision library featuring AABBs and bounding spheres (more to come).
37
38### OpenGL
39* High level OpenGL >=3 wrappers.
40* OpenGL resources (VAOs, buffers, textures, etc.) backed up by Resource for automatic (and optionally, manual) deletion.
41
42### Math
43* Vectors, matrices, quaternions, cameras, etc.
44* The Spatial type class for objects that can be moved around in 3D space.
45
46### Render
47* Static and vertex-animated model resources, compiled into a VAO for efficient rendering.
48* Static and vertex-animated model renderers. Vertex animation is done in a vertex shader.
49
50### Scene
51* Automated loading of scenes and scene resources as described by scene files.
52
24[0]: http://shellblade.net/docs/Spear/index.html 53[0]: http://shellblade.net/docs/Spear/index.html