Relintai/godot-lportal
1
0
Fork 0
mirror of https://github.com/Relintai/godot-lportal.git synced 2024-11-11 10:52:09 +01:00
Code Issues Packages Projects Releases Wiki Activity
Portal rendering / culling module for Godot
63 Commits 3 Branches 1 Tag 1.1 MiB
C++ 99.9%
b774f54022
Go to file
lawnjelly b774f54022
Add files via upload
2019-09-23 11:27:57 +01:00
images Add files via upload 2019-09-23 11:27:57 +01:00
config.py Add files via upload 2019-09-11 08:09:36 +01:00
INSTRUCTIONS.md Update INSTRUCTIONS.md 2019-09-23 11:20:02 +01:00
lbitfield_dynamic.cpp Dynamic objects now working 2019-09-13 19:15:25 +01:00
lbitfield_dynamic.h Dynamic objects now working 2019-09-13 19:15:25 +01:00
lbound.cpp More debugging support 2019-09-18 11:04:02 +01:00
lbound.h More debugging support 2019-09-18 11:04:02 +01:00
ldebug.cpp More debugging support 2019-09-18 11:04:02 +01:00
ldebug.h Debug lines to show clipping planes to portals 2019-09-23 11:14:41 +01:00
ldob.cpp More debugging support 2019-09-18 11:04:02 +01:00
ldob.h More debugging support 2019-09-18 11:04:02 +01:00
LICENSE Initial commit 2019-09-11 08:04:27 +01:00
lplanes_pool.cpp Hiding of unvisited rooms more efficient 2019-09-15 16:16:09 +01:00
lplanes_pool.h Hiding of unvisited rooms more efficient 2019-09-15 16:16:09 +01:00
lportal_all.cpp More debugging support 2019-09-18 11:04:02 +01:00
lportal.cpp Debug lines to show clipping planes to portals 2019-09-23 11:14:41 +01:00
lportal.h Debug lines to show clipping planes to portals 2019-09-23 11:14:41 +01:00
LPortalTutorial.zip Add files via upload 2019-09-18 12:27:01 +01:00
lroom_converter.cpp Debug lines to show clipping planes to portals 2019-09-23 11:14:41 +01:00
lroom_converter.h More debugging support 2019-09-18 11:04:02 +01:00
lroom_manager.cpp Debug lines to show clipping planes to portals 2019-09-23 11:14:41 +01:00
lroom_manager.h Debug lines to show clipping planes to portals 2019-09-23 11:14:41 +01:00
lroom.cpp Debug lines to show clipping planes to portals 2019-09-23 11:14:41 +01:00
lroom.h Debug lines to show clipping planes to portals 2019-09-23 11:14:41 +01:00
lvector.h DOB visibility culling added 2019-09-16 14:23:10 +01:00
README.md Update README.md 2019-09-23 11:22:47 +01:00
register_types.cpp Refactor LRooms and LPortals to no longer be part of scene graph 2019-09-15 15:39:01 +01:00
register_types.h Add files via upload 2019-09-11 08:09:36 +01:00
SCsub Optional convex hull bound for rooms 2019-09-17 14:30:31 +01:00
TUTORIAL.md Update TUTORIAL.md 2019-09-18 13:28:31 +01:00

README.md

godot-lportal

Portal rendering module for Godot 3.2
Work in progress

Although not yet released, I am trying to make sure that committed versions are runnable, so if you want to test out the system, simply follow the installation instructions. Note that the function definitions are still subject to change, but any rooms you build should be compatible with later versions.

Video of initial testing:
https://www.youtube.com/watch?v=xF_3Fe2HRdk
https://www.youtube.com/watch?v=NmlWkkhGoJA

Feel free to leave suggestions / feature requests on the issue tracker, especially regarding ease of use.

Current status

The system is mostly working. I am now testing / polishing the interface and adding debugging. I will leave PVS and closable portals until after the first release.

Roadmap

  • Auto conversion of named room spatials and portal mesh instances to LRoom and LPortal DONE
  • Auto creation of mirror portals DONE
  • Recursive determine visibility DONE
  • Prevent memory allocations (use pools for plane vectors) DONE
  • Add support for objects moving between rooms - cameras, players, physics etc - DONE
  • Refactor code, moving LRooms and LPortals outside scene graph DONE
  • Cleanup code, Optimize DONE
  • Handle special cases (multiple portals views into room etc) DONE
  • Optimize non-moving statics DONE
  • Optional convex hull bound for rooms DONE
  • Add debug graphical view of portal planes DONE
  • Add debug graphical view of room bounds
  • Bug fixing / testing ONGOING
  • Closable portals
  • PVS (primary and secondary)
  • Investigate multiple passes (shadows, lights)

Instructions

See INSTRUCTIONS.md and TUTORIAL.md

Installation

You will need to compile Godot from source (for now). See: http://docs.godotengine.org/en/3.0/development/compiling/index.html

Once the engine is compiling okay on your system, to add the module:

  • Create a folder inside godot/modules called 'lportal'
  • Clone / download this repository as a zip file and place the files in the lportal folder
  • Compile the engine as normal, it should automatically pick up the lportal module
  • Note that to export to other platforms you will also have to compile export templates for those platforms

You will know the installation was successful when you see a new Node type 'LRoomManager' in the Godot IDE.