Tesseract-Engine/README.md

![](./assets/images/Banner.png)

# Tesseract-Engine

**A 3D Game Engine for Small to Medium-sized Games**

![Lua](https://img.shields.io/badge/Lua-Support-blue) ![C++](https://img.shields.io/badge/C%2B%2B-Built%20With-orange) ![Version](https://img.shields.io/badge/Version-0.0.81-brightgreen) ![License](https://img.shields.io/badge/License-MIT-green)

Tesseract-Engine is a lightweight and powerful game engine designed for developers working on small to medium-sized projects. With a simple and visually appealing interface, it offers a LUA scripting environment and is built in C++ for optimal performance.

Join The Discord!
[https://discord.gg/qAc4RrYH](https://discord.gg/qAc4RrYH)

---

## Features
- **User-Friendly Interface**: Simplifies the game development process.
- **Lua Scripting Support**: Integrates Lua for customizable and flexible scripting.
- **Engine Tools**: Includes utilities like a profiler and playback system.
- **High Compatibility**: Supports various asset formats, including OBJ files and dynamic textures.

---

## Tools and Libraries Used

- [ImGui](https://github.com/ocornut/imgui): For UI creation.
- [GCML](https://dock-it.dev/GigabiteStudios/gcml): General C Macros Library
- [DLL-Extractor](https://dock-it.dev/Bit-By-Byte/DLL-Extractor): For managing and extracting DLL dependencies.

---

## Development History

### Note: Screenshots are sorted by version.


## **Version 0.0.131**
**Updates:**
- Added Guizmos
- Added Mesh Visualisers
- Added Global Settings
- Lua Changes
    - Added Intelisence Headers for Engine and KeyCodes
    - Changed Lua `require` to not need a path
- Added Culling
- Fixed GLCalls Count 
- Removed Unused Code (TestMesh.cpp)

**Screenshot:**

![](./assets/images/SS-Dev2_5-Fixed.png) 

## **Version 0.0.102**
**Updates:**
- Added More Themes
- Added `Engine.KeyDown()`
- Added `KeyCode` "Returns a Bool if the key is down"
    - `local KeyCode = require("keycode")`
    - `KeyCode:Space`
    - `KeyCode:A`
- Fixed Primary Camera on Load
- Remade Transform Inspector
- Remade Camera Inspector
- Remade Play/Pause Button
- Added -DTIMERS to include more Profiler Timers (May slow down Engine)
- Remade Mesh Componenet Inspector to be cleaner

**Screenshot:**

![](./assets/images/SS-Dev2_4.png)

### **Version 0.0.93**
**Updates:**
- Added support for OBJ Files with MTL Textures
- Optimised OBJ Importer
- Added `Engine.Expose("var name", <local var>)`
    - This Exposes a variable to the editor GUI
- Made the LUA Engine be a `require("engine")`
- Remade Profiler to be more readable

**Screenshot:**

![](./assets/images/SS-Dev2_3.png)

### **Version 0.0.76**
**Updates:**
- **Engine Profiler**: Visualize frame resource usage for optimization.
- **Playback System**: Start and pause gameplay with automatic scene saving and restoration.
- **Lua Math Library**: Includes `math.lua` for advanced calculations.
    ```lua
    local Math = require("math")
    ```
- **Temporary File Access**: Added C++ function to create temporary files.

**Screenshot:**

![](./assets/images/SS-Dev2_2.png)

---

### **Version 0.0.68**
**Updates:**
- **Script Component**: Enhanced Lua scripting integration.
- **Lua Editor (WIP)**: A basic Lua script editor.
- **Lua Binding**: API for interfacing Lua with the engine.
    ```lua
    Engine.GetGameObjectByTag("")
    Component::GetComponent("")
    Engine.Log("")
    Transform:SetPosition(vec3)
    Transform:SetRotation(vec3)
    ```

**Screenshot:**

![](./assets/images/SS-Dev2_1.png)

---

### **Version 0.0.50**
**Updates:**
- **Texture Preview**: Automatic texture and model loading.

**Screenshot:**

![](./assets/images/SS-Dev2_0.png)

---

### **Version 0.0.45**
**Updates:**
- **OBJ File Support**: Added compatibility for OBJ asset files.

**Screenshot:**

![](./assets/images/SS-Dev1_4.png)

---

### **Version 0.0.37**
**Updates:**
- **Dynamic Texture Support**: Enhanced texture management and rendering.

**Screenshot:**

![](./assets/images/SS-Dev1_3.png)

---

### **Version 0.0.33**
**Screenshot:**

![](./assets/images/SS-Dev1_2.png)

---

### **Version 0.0.23**
**Screenshot:**

![](./assets/images/SS-Dev1_1.png)

---

### **Version 0.0.15**
**Screenshot:**

![](./assets/images/SS-Dev1_0.png)