Skip to content

Latest commit

 

History

History
107 lines (78 loc) · 3.65 KB

README.md

File metadata and controls

107 lines (78 loc) · 3.65 KB
Raw

3DreamEngine Discord server

Features

  • Easy to use yet powerful 3D extension to LÖVE
  • Fast forward rendering with alpha pass
  • Metalness workflow (albedo, normal, roughness, metallic, ao, emission)
  • HDR with bloom
  • Refractions, specular and diffuse reflections
  • Screen space ambient occlusion (ssao)
  • Particle batches and sprites
  • Particle/foliage systems
  • Simple custom shaders
  • Eye adaption effect
  • Cascade directional shadow mapping
  • Point shadow mapping
  • Smooth shadows
  • Distance fog
  • Godrays
  • Included shaders for wind animation, water, ...
  • Supports .obj, .glb, .gltf, .dae and .vox
  • Threaded texture loading
  • Optional high performance file format to minimize loading times
  • Included optimized vec2, vec3, vec4, mat2, mat3 and mat4 library
  • Box2D extension to support basic 3D physics
  • Dynamic clouds, sun, moon, stars and rainbows

screenshots

Development

Due to rapid changes to 3Dream I am sometimes working on a separate beta branch.

Documentation

Undocumented features are subject to change. They will receive a proper documentation once finished.

Documentation hosted on GitHub

Emmy-love-api recommended for proper EmmyLua support.

How to use?

--load 3DreamEngine
local dream = require("3DreamEngine")

--optionally set settings
dream:setBloom(3)

--init (applies settings)
dream:init()

--loads a object
local yourObject = dream:loadObject("examples/monkey/object")

--creates a light
local light = dream:newLight("point", dream.vec3(3, 2, 1), dream.vec3(1.0, 0.75, 0.2), 50.0)

--add shadow to light source
light:addNewShadow()

function love.draw()
	--prepare for rendering
	dream:prepare()
	
	--add light
	dream:addLight(light)
	
	--rotate, offset and draw
	yourObject:resetTransform()
	yourObject:rotateY(love.timer.getTime())
	yourObject:translate(0, 0, -3)
	dream:draw(yourObject)
	
	--render
	dream:present()
end

function love.update()
	--update resource loader
	dream:update()
end

Examples

We have examples in the examples folder. The provided main.lua contains a demo selection screen.

Credits

License (MIT/EXPAT LICENSE)

Copyright 2020 Luke100000 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.