README.md

Lovity

A 3d unity like engine made with Love2d

Features

THIS DOCUMENTATION IS INCOMPLETE AND IS JUST A QUICK OVERVIEW

    I've tried to make the code easily understandable, just look at the code

Game Object and Components

local gameObject = engine.gameObject()
local meshRenderer = gameObject:addComponent(engine.meshRenderer)
meshRenderer.mesh = mesh
meshRenderer:addMaterial(material)

Meshes (.obj)

engine.mesh("assets/meshes/obj.obj")

Materials

engine.material("assets/shaders/material.glsl")

Dynamic Lighting

local gameObject = engine.gameObject()
local light = gameObject:addComponent(engine.light)
light.colour:set(1.0, 0.0, 0.0, 1.0)

Requires Shader to include the following:

#define NR_POINT_LIGHTS 5

struct Light {
    float strength;
    vec3 position;
    vec4 colour;
};

uniform Light lights[NR_POINT_LIGHTS];

TODO: number of lights dynamically set by the engine

Camera Frustum Culling

Greatly improves performance by only rendering what the camera can see

Robust Class System

Example: Mesh Renderer

class.name = "engine.meshRenderer"
class.base = "engine.renderer"

local graphics = love.graphics

function class:meshRenderer(mesh)
	class.base.renderer(self)

	self.colour = engine.colour(1.0, 1.0, 1.0, 1.0)
	self.mesh = mesh
end

function class:prerender(camera, frustum)
	local mesh = self.mesh

	if mesh then
		local scale, position = self.transform.scale, self.transform.globalPosition

		return frustum:sphereInFrustum(position.x, position.y, position.z, mesh.extent:magnitude() * math.max(math.max(scale.x, scale.y), scale.z))
	end

	return false
end

function class:render()
	graphics.setColor(self.colour)
	graphics.draw(self.mesh.source)
	graphics.setColor(1.0, 1.0, 1.0, 1.0)
end

Example: Movement Class

class.name = "movement"
class.base = "engine.monoBehaviour"

local mesh, material

function script:onLoad()
	local sh = engine.shader("assets/shaders/debug.glsl")
	material = engine.material(sh)

	mesh = engine.mesh("assets/meshes/cube.obj")
end

function class:awake()
	
end

function class:update(dt)
	local speed = 10.0

	if input:getKeyDown("escape") then
		love.event.quit()
	end

	if input:getKey("lshift") then
		speed = 100.0
	elseif input:getKey("lctrl") then
		speed = 1.0
	end

	if input:getKey("w") then
		self.transform.position = self.transform.position + self.transform.forward * dt * speed
	end

	if input:getKey("a") then
		self.transform.position = self.transform.position - self.transform.right * dt * speed
	end

	if input:getKey("d") then
		self.transform.position = self.transform.position + self.transform.right * dt * speed
	end

	if input:getKey("s") then
		self.transform.position = self.transform.position - self.transform.forward  * dt * speed
	end

	if input:getKey("space") then
		self.transform.position = self.transform.position + math.vector3(0, 1, 0) * dt * speed
	end

	if input:getKey("c") then
		self.transform.position = self.transform.position - math.vector3(0, 1, 0) * dt * speed
	end

	if input:getKey("left") then
		self.transform.rotation:rotate(0, 1, 0, dt)
	end

	if input:getKey("right") then
		self.transform.rotation:rotate(0, 1, 0, -dt)
	end

	if input:getMouseButton(1) then
		local gameObject = engine.gameObject()
		gameObject.transform.position:set(math.random() * 1000 - 500, math.random() * 1000 - 500, math.random() * 1000 - 500)
		local mr = gameObject:addComponent(engine.meshRenderer, mesh)
		mr:addMaterial(material)
	end

	local dx, dy = input:getMouseDelta()
	if math.abs(dx) > 0 then
		self.transform.rotation:rotate(0, 1, 0, -dt * dx)
	end
end