-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.md
50 lines (42 loc) · 1.51 KB
/
README.md
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
# The Citrus Engine
The Citrus Engine, a game engine originally created for the Team Citrus project.
For this game engine, we have a simple goal in mind, **we want to create a simple, extendable, well documented, game engine**.
We also intend to use this game engine in our future projects, and hope others adopt it as well.
As well, by making the engine free software, we hope to set a precident in the game development world.
***If you are looking to contribute, the style guide can be found at docs/style.md, and the programmer's guide can be found at docs/guide.md.***
## Compiling requirements
- Python
- SCons
- Vulkan SDK
- OpenGL SDK
- GLM
- box2d
- Bullet3
- G++, or compatible C++ compiler (ie. clang, icc)
## TODOs
### High priority
- [x] Get a name for the engine
- [ ] Write a proper readme
- [x] Create build system
- [x] Create code structure
- [x] Create formating guide
- [ ] Integrate the Soloud sources into the engine
- [x] Necessary restructuring
- [ ] Copyright information
- [x] Sconscript files
- [ ] Write headers for the graphics API
- [ ] Write headers for the phyics API
- [ ] Write headers for general engine information
- [x] Write replacement functions and classes for some standard library functions and classes
- [x] `engine::Vector<T>`
- [x] `engine::pair<A, B>`
- [x] `engine::map<A, B>`
- [x] `engine::hash()`
- [x] `engine::hashMap<K, T>`
- [ ] Create the rendering pipeline
- [ ] Create the main loop
- [x] main()
- [ ] gameplayMain()
- [ ] physmain()
- [ ] draw()
- [ ] mix()