docs/project-layout.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

---
title: Project Structure
---

```
assets/   - shaders and bundled assets for examples (must be licensed open)
bindgen/  - bindings generation
deps/     - third-party dependencies
docs/     - these docs you're reading now that get built with mkdocs
src/
    core/     - core game engine facilities
    logos/    -
    maths/
    platform/
    ral/
    render/
    resources/
    std/
    systems/
    ui/
```


#### Core

Core holds specifically functionality vital to making games or 3D applications. Contrast this with `std` which contains
code that could form the base layer of almost any software out there.

#### Std

Data structures, algorithms, memory management, etc - all code here forms a foundation for everything above it and can conceivably
be reused in non-game applications.