This repository has been archived by the owner on May 26, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 152
/
README.md
133 lines (99 loc) · 4.99 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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
[Ethereal Engine](https://github.com/volcoma/EtherealEngine) - Cross-platform C++ Game Engine
THIS REPO IS NO LONGER MAINTAINED. IT can be used for educational purposes...
Development has been moved to https://github.com/volcoma/ace
============================================================================
[](https://www.codacy.com/app/volcoma/EtherealEngine?utm_source=github.com&utm_medium=referral&utm_content=volcoma/EtherealEngine&utm_campaign=badger)
[](https://gitter.im/EtherealEngine/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://travis-ci.org/volcoma/EtherealEngine)
[](https://ci.appveyor.com/project/volcoma/etherealengine)
[](LICENSE.txt)
 
 
 
[ Get more details at **codescene.io**.](https://codescene.io/projects/1800/jobs/latest-successful/results)
## INFO
Using c++14
WYSIWYG Editor
## STATUS
WIP - not production ready in any way
Building
-------------
Don't forget to update submodules
```
git clone https://github.com/volcoma/EtherealEngine.git
cd EtherealEngine
git submodule init
git submodule update
mkdir build
cd build
cmake ..
```
## PLATFORMS
It is written in a cross-platform manner using .
 |  | 
---------------| --------|--------
 |  |
 |  |
 | | 
 | | 
## ASSETS
Some high quality assets: https://github.com/volcoma/Library
Supported texture formats: png, tga, dds, ktx, pvr
Supported mesh formats: obj, fbx, dae, 3ds
Supported audio formats: ogg, wav
## SUGGESTIONS AND ISSUES
Any suggestions and help will be appreciated.
## BUILD
The engine uses the CMake build system.
## CODEBASE
 Using the latest and greatest features of the language.
## CODE STYLE
```c++
#include "some_header.h"
#include "some_other_header_impl.hpp"
namespace nsp
{
class some_class
{
public:
//-----------------------------------------------------------------------------
// Name : some_method ()
/// <summary>
/// This is a method comment description.
/// </summary>
//-----------------------------------------------------------------------------
void some_method();
//-----------------------------------------------------------------------------
// Name : some_templated_method ()
/// <summary>
/// This is a method comment description.
/// </summary>
//-----------------------------------------------------------------------------
template<typename T>
void some_templated_method();
public:
/// this is a member comment
int some_public_member = 0;
private:
/// this is a member comment
int some_private_member_ = 0;
}
template<typename T>
inline void some_class::some_templated_method()
{
// If the class is fully templated it is acceptable to put this inside the class
}
```
## PREVIEW
## LIBRARIES
bgfx - https://github.com/bkaradzic/bgfx
cereal - https://github.com/USCiLab/cereal
rttr - https://github.com/rttrorg/rttr
spdlog - https://github.com/gabime/spdlog
imgui - https://github.com/ocornut/imgui
assimp - https://github.com/assimp/assimp
glm - https://github.com/g-truc/glm
openal-soft = https://github.com/kcat/openal-soft