Skip to content
This repository has been archived by the owner on Nov 27, 2023. It is now read-only.

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
ItsFlare committed Oct 31, 2023
1 parent 1db3d56 commit 89bf172
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 19 deletions.
46 changes: 27 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,55 @@
# Voxelite
![](img/vx1.png)

**Voxelite** was a student project for professor Dachsbacher's computer graphics lab at the Karlsruhe Institute of Technology (Computer Science M.Sc.).
**Voxelite** was a student project for professor Dachsbacher's _Graphics & Game Development_ course at the Karlsruhe Institute of Technology (Computer Science M.Sc.).

It consists of a proposal, 4 sets of presentation slides, 8k lines of source code written in 3 months and was awarded the maximum grade.

## Goals

- Implement contemporary rendering techniques
- Implement contemporary graphics techniques
- Volumetric light scattering as post-process
- Cascaded shadow mapping (PCSS)
- Cascaded shadow mapping (+PCSS)
- Physically-based rendering
- Screen-space reflections
- Ambient occlusion
- Normal mapping
- Bloom
- Create an efficient OpenGL voxel renderer
- Transparency-compatible bloom
- Create an efficient OpenGL deferred voxel renderer
- Asynchronous chunk meshing
- Six total culling methods
- Nine total culling methods
- Texture atlas generation
- Asynchronous transparency sorting
- Mixed RGB flood-fill voxel lighting
- Generate procedural terrain
- Parallel noise-based chunk generator
- Includes a few different biomes and structures
- Spline tree for maximum configuration
- Multiple biomes and structures
- Practically unlimited world size
- RGB flood-fill voxel lighting

If you're thinking of a Minecraft clone - yes, pretty much that. We even stole the textures! Hopefully made up for it
If you're thinking of a Minecraft clone - yes, pretty much that. We even stole the textures! Hopefully made up for that
with all our enhancements ;-)

### Non-goals

- Add gameplay elements beyond block placement
- Create a well-documented, future-proof codebase
- Create a well-documented, impeccable codebase
- Cross-platform compatibility (Windows only)

## Dependencies

| Type | Solution |
| ------------------- | ------------- |
| Native bindings | LWJGL |
| OpenGL abstraction | BeaconGL |
| User Interface | ImGui |
| 3D Noise | OpenSimplex2 |
| Logging | Log4j |
| Data Structures | FastUtil |
| Testing | JUnit / JMH |
| Other | Gson / Jansi |
| Native bindings | [LWJGL](https://github.com/LWJGL/lwjgl3) |
| OpenGL abstraction | [BeaconGL](https://github.com/ItsFlare/BeaconGL) |
| User Interface | [ImGui](https://github.com/SpaiR/imgui-java) |
| 3D Noise | [OpenSimplex2](https://github.com/KdotJPG/OpenSimplex2) |
| Logging | [Log4j](https://github.com/apache/logging-log4j2) |
| Data Structures | [FastUtil](https://github.com/vigna/fastutil) |
| Testing | [JUnit](https://github.com/junit-team/junit5) / [JMH](https://github.com/openjdk/jmh) |
| Other | [Gson](https://github.com/google/gson) / [Jansi](https://github.com/fusesource/jansi) |

## Thanks
- Prof. Dr.-Ing. Carsten Dachsbacher
- Killian Herveau, M.Sc
- Reiner Dolp, M.Sc
- Baldur Karlsson ([renderdoc](https://github.com/baldurk/renderdoc))
Binary file added img/vx1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 89bf172

Please sign in to comment.