Groverburger's Super Simple 3D Engine (SS3D) is my take on simplifying love 11's new 3D capabilities into a ready-to-use library for simple 3D games.
Get the latest version of SS3D and a simple tutorial on the Github page here:
https://github.com/groverburger/ss3d
Here's a gif from the attached demo:
Here's the entire main.lua file for the demo shown above:
Code: Select all
-- store global reference to the Engine for use in calling functions
Engine = require "engine"
function love.load()
-- make the mouse cursor locked to the screen
love.mouse.setRelativeMode(true)
love.window.setTitle("ss3d 1.2 demo")
love.window.setMode(1024, 1024*9/16, {})
love.graphics.setBackgroundColor(0.52,0.57,0.69)
Paused = false
-- create a Scene object which stores and renders Models
-- arguments refer to the Scene's camera's canvas output size in pixels
Scene = Engine.newScene(love.graphics.getWidth(), love.graphics.getHeight())
DefaultTexture = love.graphics.newImage("texture.png")
Timer = 0
Scene.camera.pos.x = 0
Scene.camera.pos.z = 5
-- define vertices to be used in the creation of a new Model object for the Scene
local cubeVerts = {
-- front
{-1,-1,-1, 0,0},
{1,-1,-1, 1,0},
{-1,1,-1, 0,1},
{1,1,-1, 1,1},
{-1,1,-1, 0,1},
{1,-1,-1, 1,0},
-- back
{1,-1,1, 1,0},
{-1,-1,1, 0,0},
{-1,1,1, 0,1},
{-1,1,1, 0,1},
{1,1,1, 1,1},
{1,-1,1, 1,0},
-- right side
{-1,-1,1, 1,0},
{-1,-1,-1, 0,0},
{-1,1,-1, 0,1},
{-1,1,-1, 0,1},
{-1,1,1, 1,1},
{-1,-1,1, 1,0},
-- left side
{1,-1,-1, 0,0},
{1,-1,1, 1,0},
{1,1,-1, 0,1},
{1,1,1, 1,1},
{1,1,-1, 0,1},
{1,-1,1, 1,0},
-- top side
{-1,1,-1, 0,0},
{1,1,-1, 1,0},
{-1,1,1, 0,1},
{1,1,1, 1,1},
{-1,1,1, 0,1},
{1,1,-1, 1,0},
-- bottom side
{1,-1,-1, 1,0},
{-1,-1,-1, 0,0},
{-1,-1,1, 0,1},
{-1,-1,1, 0,1},
{1,-1,1, 1,1},
{1,-1,-1, 1,0},
}
-- turn the vertices into a Model with a texture
CubeModel = Engine.newModel(cubeVerts, DefaultTexture)
Scene:addModel(CubeModel)
-- define a tetrahedron model
local tetraVerts = {
{-1,-1,-1},
{-1,1,1},
{1,1,-1},
{-1,1,1},
{1,1,-1},
{1,-1,1},
{-1,-1,-1},
{1,1,-1},
{1,-1,1},
{-1,-1,-1},
{-1,1,1},
{1,-1,1},
}
-- add tetrahedrons to the scene
Tetrahedrons = {}
for i=1, 4 do
Tetrahedrons[#Tetrahedrons+1] = Engine.newModel(tetraVerts)
Tetrahedrons[i].wireframe = true
Scene:addModel(Tetrahedrons[i])
end
-- define vertices for a simple square floor
local floorVerts = {
{-1,-1,-1, 0,0},
{1,-1,-1, 1,0},
{-1,-1,1, 0,1},
{1,-1,1, 1,1},
{-1,-1,1, 0,1},
{1,-1,-1, 1,0},
}
-- scale the vertices, then turn the vertices into a Model with a texture
FloorModel = Engine.newModel(ScaleVerts(floorVerts, 20,4,20), DefaultTexture)
Scene:addModel(FloorModel)
end
function love.update(dt)
love.mouse.setRelativeMode(not Paused)
if Paused then
return
end
-- make the CubeModel go in circles and rotate
Timer = Timer + dt/4
CubeModel:setTransform({0,-1.5,0}, {Timer, cpml.vec3.unit_y, Timer, cpml.vec3.unit_z, Timer, cpml.vec3.unit_x})
for i=1, #Tetrahedrons do
Tetrahedrons[i]:setTransform({math.cos(Timer +i*math.pi*0.5)*12, math.sin(Timer +i)*0.75 +1, math.sin(Timer +i*math.pi*0.5)*12}, {Timer, cpml.vec3.unit_y, Timer, cpml.vec3.unit_z, Timer, cpml.vec3.unit_x})
end
-- simple first-person camera movement
local mx,my = 0,0
if love.keyboard.isDown("w") then
my = my - 1
end
if love.keyboard.isDown("a") then
mx = mx - 1
end
if love.keyboard.isDown("s") then
my = my + 1
end
if love.keyboard.isDown("d") then
mx = mx + 1
end
if mx ~= 0 or my ~= 0 then
local angle = math.atan2(my,mx)
local speed = 0.1
Scene.camera.pos.x = Scene.camera.pos.x + math.cos(Scene.camera.angle.x + angle)*speed
Scene.camera.pos.z = Scene.camera.pos.z + math.sin(Scene.camera.angle.x + angle)*speed
end
end
function love.mousemoved(x,y, dx,dy)
-- basic first person mouselook, built into Scene object
if not Paused then
Scene:mouseLook(x,y, dx,dy)
end
end
function love.keypressed(k)
if k == "space" then
Paused = not Paused
end
end
function love.draw()
-- render all Models in the Scene
love.graphics.setColor(1,1,1)
Scene:render()
-- render a HUD
Scene:renderFunction(
function ()
love.graphics.setColor(0,0,0)
love.graphics.print("groverburger's super simple 3d engine v1.2")
love.graphics.print("FPS: "..love.timer.getFPS(),0,16)
end
)
end
- Built in first person camera controls
- Engine encapsulated into a single file
- Readable and commented code
- 2D rendering / HUD support
- Rotatable and translatable models
- UV mapping
- Backface culling (enabled on a per-model basis)
- Wireframe rendering (enabled on a per-model basis)
- Simple directional ambient lighting
To Dos
- Simple phong lighting
- Obj file format import
- Simple collision handling
Installation
Just drag the engine.lua file into your project directory to install. SS3D does require CPML, which can be found here.
Download the latest version on Github, or as a .love attached to this post. Github link at top of this page.
Here's an example of what can be done with this engine.
This is a Minecraft clone I've been working on. I abstracted the engine I used for this project and that is what became SS3D.
https://github.com/groverburger/lovecraft
Feedback and suggestions are greatly appreciated!
Feel free to use SS3D for whatever no permission necessary.
This code is offered under the MIT license.
