integrations/bullet/CMakeLists.txt

@@ -5,34 +5,39 @@ if ( NOT Bullet_FOUND )
 else()
     message( STATUS "Bullet is poorly packaged, you might need to disable support for it" )
 
+    add_library(fgglbt STATIC)
+
     if ( MSVC )
         # see https://github.com/microsoft/vcpkg/issues/7877
-        target_link_libraries(fggl PUBLIC LinearMath Bullet3Common BulletDynamics BulletSoftBody BulletCollision BulletInverseDynamics)
+        target_link_libraries(fgglbt PUBLIC LinearMath Bullet3Common BulletDynamics BulletSoftBody BulletCollision BulletInverseDynamics)
     else()
         # FIXME: this shouldn't be necessary, for modern cmake, linking the libraries should be enough
-        target_compile_definitions(fggl PUBLIC ${BULLET_DEFINITIONS})
+        target_compile_definitions(fgglbt PUBLIC ${BULLET_DEFINITIONS})
 
         if ( BULLET_INCLUDE_DIRS STREQUAL "include/bullet" )
             message( STATUS "Bullet include path is relative - hard-coding" )
             # FIXME possible debian packing bug: path is relative in BulletConfig.cmake
             # FIXME debian packaging bug: BulletConfig.cmake lists BulletInverseDynamics, but that's packaged in bullet-extras
-            target_include_directories(fggl PUBLIC ${BULLET_ROOT_DIR}/${BULLET_INCLUDE_DIRS})
+            target_include_directories(fgglbt PUBLIC ${BULLET_ROOT_DIR}/${BULLET_INCLUDE_DIRS})
         else()
-            target_include_directories(fggl PUBLIC ${BULLET_INCLUDE_DIRS})
+            target_include_directories(fgglbt PUBLIC ${BULLET_INCLUDE_DIRS})
         endif()
-        target_link_libraries(fggl PUBLIC ${BULLET_LIBRARIES})
+        target_link_libraries(fgglbt PUBLIC ${BULLET_LIBRARIES})
     endif()
 
-    target_include_directories( fggl
+    target_link_libraries( fgglbt PUBLIC fggl )
+    target_include_directories( fgglbt
         PUBLIC
             $<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/include>
             $<INSTALL_INTERFACE:include>
     )
 
     # bullet cpp files
-    target_sources( fggl
+    target_sources( fgglbt
         PRIVATE
+            src/module.cpp
             src/simulation.cpp
             src/phys_draw.cpp
+            src/service.cpp
     )
 endif()

integrations/bullet/include/fggl/phys/bullet/bullet.hpp

@@ -37,46 +37,6 @@
 
 #include "fggl/phys/types.hpp"
 #include "fggl/phys/bullet/types.hpp"
-
-namespace fggl::phys::bullet {
-
-	/**
-	 * Bullet integration module.
-	 *
-	 * This provides the ability for FGGL to use bullet as a physics backened. Bullet is mature, stable physics
-	 * engine which makes it suitable for most use cases. For use with FGGL there is a reasonable amount of copying
-	 * back and forth to keep the two states in sync.
-	 */
-	/*struct BulletModule : ecs3::Module {
-		public:
-			BulletModule() = default;
-
-			[[nodiscard]]
-			std::string name() const override {
-				return "phys::Bullet3";
-			}
-
-			void onLoad(ecs3::ModuleManager&, ecs3::TypeRegistry &types) override {
-				// dependencies
-				types.make<phys::CollisionCallbacks>();
-				types.make<phys::CollisionCache>();
-
-				types.make<phys::RigidBody>();
-				types.make<phys::Dynamics>();
-
-				// my types
-				types.make<phys::bullet::BulletBody>();
-			}
-
-	};*/
-
-} // namespace fggl::phys::bullet
-
-namespace fggl::phys {
-
-	// allows using fggl::phys::Bullet3 as the module name
-	//using Bullet3 = bullet::BulletModule;
-
-} // namespace fggl::phys
+#include "fggl/phys/bullet/module.hpp"
 
 #endif //FGGL_PHYS_BULLET_BULLET_HPP

integrations/bullet/include/fggl/phys/bullet/module.hpp

+/*
+ * This file is part of FGGL.
+ *
+ * FGGL is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
+ * later version.
+ *
+ * FGGL is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with FGGL.
+ * If not, see <https://www.gnu.org/licenses/>.
+ */
+
+//
+// Created by webpigeon on 31/07/22.
+//
+
+#ifndef FGGL_INTEGRATIONS_BULLET_PHYS_BULLET_MODULE_HPP
+#define FGGL_INTEGRATIONS_BULLET_PHYS_BULLET_MODULE_HPP
+
+#include "fggl/modules/module.hpp"
+#include "fggl/entity/module.hpp"
+
+#include "fggl/phys/types.hpp"
+#include "fggl/phys/service.hpp"
+#include "fggl/phys/bullet/types.hpp"
+
+namespace fggl::phys::bullet {
+
+	constexpr util::GUID CONFIG_PHYS_BODY = util::make_guid("phys::body");
+
+	struct Bullet {
+		constexpr static const char* name = "fggl::phys::bullet";
+		constexpr static const std::array<modules::ModuleService, 1> provides = {
+			phys::PhysicsProvider::service
+		};
+		constexpr static const std::array<modules::ModuleService, 1> depends = {
+			entity::EntityFactory::service
+		};
+		static bool factory(modules::ModuleService name, modules::Services& serviceManager);
+	};
+
+} // namespace fggl::phys::bullet
+
+namespace fggl::phys {
+	using Bullet3 = bullet::Bullet;
+
+} // namespace fggl::phys
+
+#endif //FGGL_INTEGRATIONS_BULLET_PHYS_BULLET_MODULE_HPP

integrations/bullet/include/fggl/phys/bullet/motion.hpp

@@ -34,6 +34,7 @@
 #define FGGL_PHYS_BULLET_MOTION_HPP
 
 #include "types.hpp"
+#include "fggl/debug/logging.hpp"
 
 namespace fggl::phys::bullet {
 
@@ -41,11 +42,16 @@ namespace fggl::phys::bullet {
 		public:
 			FgglMotionState(entity::EntityManager* world, entity::EntityID entity) : m_world(world), m_entity(entity) {
 			}
-			virtual ~FgglMotionState() = default;
+			~FgglMotionState() override = default;
 
 			void getWorldTransform(btTransform& worldTrans) const override {
-				const auto& transform = m_world->get<fggl::math::Transform>(m_entity);
-				worldTrans.setFromOpenGLMatrix( glm::value_ptr(transform.model()) );
+				const auto* transform = m_world->tryGet<fggl::math::Transform>(m_entity);
+				if ( transform == nullptr ) {
+					debug::error("BT: attempted to get transform of entity without transform component.");
+					return;
+				}
+
+				worldTrans.setFromOpenGLMatrix(glm::value_ptr(transform->model()));
 			}
 
 			void setWorldTransform(const btTransform& worldTrans) override {

integrations/bullet/include/fggl/phys/bullet/service.hpp

+/*
+ * This file is part of FGGL.
+ *
+ * FGGL is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
+ * later version.
+ *
+ * FGGL is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with FGGL.
+ * If not, see <https://www.gnu.org/licenses/>.
+ */
+
+//
+// Created by webpigeon on 01/08/22.
+//
+
+#ifndef FGGL_INTEGRATIONS_BULLET_PHYS_BULLET_BULLETSERVICE_H
+#define FGGL_INTEGRATIONS_BULLET_PHYS_BULLET_BULLETSERVICE_H
+
+#include "fggl/phys/service.hpp"
+
+namespace fggl::phys::bullet {
+
+	class BulletProvider : public phys::PhysicsProvider {
+		public:
+			PhysicsEngine* create(entity::EntityManager* entityManager, entity::EntityFactory* factory) override;
+	};
+
+}
+
+#endif //FGGL_INTEGRATIONS_BULLET_PHYS_BULLET_BULLETSERVICE_H

integrations/bullet/include/fggl/phys/bullet/types.hpp

@@ -75,6 +75,14 @@ namespace fggl::phys::bullet {
 			explicit BulletPhysicsEngine(entity::EntityManager* world);
 			~BulletPhysicsEngine() override;
 
+			// copy is not allowed
+			BulletPhysicsEngine(const BulletPhysicsEngine&) = delete;
+			BulletPhysicsEngine& operator=(const BulletPhysicsEngine&) = delete;
+
+			// move is not allowed
+			BulletPhysicsEngine(BulletPhysicsEngine&&) = delete;
+			BulletPhysicsEngine& operator=(BulletPhysicsEngine&&) = delete;
+
 			void step() override;
 			void onEntityDeath(entity::EntityID entity);
 
@@ -83,7 +91,19 @@ namespace fggl::phys::bullet {
 			std::vector<entity::EntityID> raycastAll(math::vec3 from, math::vec3 to) override;
 			std::vector<entity::EntityID> sweep(PhyShape& shape, math::Transform& from, math::Transform& to) override;
 
-			bool debugDraw = false;
+			/**
+			 * Add a rigid body to the physics world.
+			 *
+			 * The body should not currently be in the simulation. Physics position will be synced with the motion
+			 * state prior to it being added to the simulation. This method should not need to be called manually, it
+			 * is called when the entity is decoded.
+			 *
+			 * @param entity the entity the BulletBody is attached to.
+			 * @param body the pre-configured bullet body.
+			 */
+			void addBody(entity::EntityID entity, BulletBody& body);
+
+			void setDebugDraw(bool enabled) override;
 		private:
 			entity::EntityManager* m_ecs;
 			BulletConfiguration m_config;
@@ -92,14 +112,12 @@ namespace fggl::phys::bullet {
 			ContactCache m_contactCache;
 
 			/**
-			 * Check for ECS components which aren't in the physics world and add them.
-			 */
-			void checkForPhys();
-
-			/**
-			 * Sync the bullet world state back to the ECS.
+			 * Force position and rotation in the ECS to match those from the physics world.
+			 *
+			 * As FGGL uses motion states, this should not be required. As it iterates all entities in a scene this is
+			 * also a very expensive operation.
 			 */
-			void forceSyncToECS();
+			void syncTransformToECS();
 
 			/**
 			 * Deal with physics collisions

integrations/bullet/src/module.cpp

+/*
+ * This file is part of FGGL.
+ *
+ * FGGL is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
+ * later version.
+ *
+ * FGGL is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with FGGL.
+ * If not, see <https://www.gnu.org/licenses/>.
+ */
+
+//
+// Created by webpigeon on 31/07/22.
+//
+
+#include "fggl/phys/bullet/module.hpp"
+#include "fggl/phys/bullet/service.hpp"
+
+namespace fggl::phys::bullet {
+
+	bool Bullet::factory(modules::ModuleService service, modules::Services& services) {
+		if ( service == phys::PhysicsProvider::service ) {
+			services.bind<phys::PhysicsProvider, BulletProvider>();
+		}
+		return false;
+	}
+
+} // namespace fggl::phys::bullet
\ No newline at end of file

integrations/bullet/src/service.cpp

+/*
+ * This file is part of FGGL.
+ *
+ * FGGL is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
+ * later version.
+ *
+ * FGGL is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with FGGL.
+ * If not, see <https://www.gnu.org/licenses/>.
+ */
+
+//
+// Created by webpigeon on 01/08/22.
+//
+
+#include "fggl/phys/bullet/service.hpp"
+#include "fggl/phys/bullet/types.hpp"
+#include "fggl/phys/bullet/motion.hpp"
+
+namespace fggl::phys::bullet {
+
+	constexpr float UNIT_EXTENT = 0.5F;
+
+	btCollisionShape* create_bullet_shape(const YAML::Node& node) {
+		auto type = node["type"].as<std::string>("MISSING");
+		if ( type == "sphere" ) {
+			auto radius = node["radius"].as<float>(UNIT_EXTENT);
+			return new btSphereShape(radius);
+		} else if ( type == "box" ) {
+			auto extents = node["extents"].as<math::vec3>(math::vec3(UNIT_EXTENT));
+			return new btBoxShape(btVector3(extents.x, extents.y, extents.z));
+		} else {
+			debug::warning("unknown shape type: {}, assuming unit sphere", type);
+			return new btSphereShape(0.5F);
+		}
+	}
+
+	void setup_body(BodyType type, btRigidBody& body) {
+		if ( type != BodyType::STATIC ) {
+			body.setRestitution(0.5F);
+			body.setRollingFriction(0.0F);
+
+			// kinematic bodies cannot sleep
+			if (type == BodyType::KINEMATIC) {
+				auto flags = (body.getCollisionFlags() | btCollisionObject::CF_KINEMATIC_OBJECT);
+				body.setCollisionFlags(flags);
+				body.setActivationState(DISABLE_DEACTIVATION);
+			}
+		}
+	}
+
+	void add_bt_body(const entity::ComponentSpec& spec, entity::EntityManager& manager, const entity::EntityID& id) {
+		auto& body = manager.add<BulletBody>(id);
+		body.motion = new FgglMotionState(&manager, id);
+
+		auto type = spec.get<BodyType>("type", BodyType::DYNAMIC);
+		auto mass = 0.0F;
+
+		// non-static objects can have mass
+		if ( type != BodyType::STATIC ) {
+			mass = spec.get<float>("mass", 1.0F);
+		}
+
+		// calculate inertia
+		btCollisionShape* shape = create_bullet_shape(spec.config["shape"]);
+		btVector3 inertia(0, 0, 0);
+		if ( type != BodyType::STATIC ) {
+			shape->calculateLocalInertia(mass, inertia);
+		}
+
+		// construction information for the simulation
+		btRigidBody::btRigidBodyConstructionInfo constructionInfo {
+			mass,
+			body.motion,
+			shape,
+			inertia
+		};
+
+		body.body = new btRigidBody(constructionInfo);
+		setup_body(type, *body.body);
+
+		// add the body to the simulation
+		if ( type == BodyType::DYNAMIC ) {
+			manager.add<phys::Dynamics>(id);
+		}
+	}
+
+	PhysicsEngine* BulletProvider::create(entity::EntityManager* entityManager, entity::EntityFactory* factory) {
+		auto* engine = new BulletPhysicsEngine(entityManager);
+
+		// FIXME: this won't work across multiple scenes - reactive approach might be better...
+		factory->bind(util::make_guid("phys::Body"), add_bt_body, [engine](auto& manager, const auto& entity) {
+			debug::trace("adding entity {} to physics scene...", (uint64_t)entity);
+			auto& physComp = manager.template get<BulletBody>(entity);
+			engine->addBody(entity, physComp);
+		});
+
+		return engine;
+	}
+
+} // namespace fggl::phys::bullet
\ No newline at end of file

integrations/bullet/src/simulation.cpp

@@ -35,7 +35,7 @@ namespace fggl::phys::bullet {
 		return {fgglVec.x, fgglVec.y, fgglVec.z};
 	}
 
-	BulletPhysicsEngine::BulletPhysicsEngine(entity::EntityManager* world) : m_ecs(world), m_config(), m_world(nullptr) {
+	BulletPhysicsEngine::BulletPhysicsEngine(entity::EntityManager* world) : m_ecs(world), m_config(), m_world(nullptr), m_debug(nullptr) {
 		m_config.broadphase = new btDbvtBroadphase();
 		m_config.collisionConfiguration = new btDefaultCollisionConfiguration();
 		m_config.dispatcher = new btCollisionDispatcher(m_config.collisionConfiguration);
@@ -47,9 +47,6 @@ namespace fggl::phys::bullet {
 			m_config.solver,
 			m_config.collisionConfiguration);
 
-		m_debug = std::make_unique<debug::BulletDebugDrawList>();
-		m_world->setDebugDrawer( m_debug.get() );
-		m_debug->setDebugMode(1);
 
 		// callbacks (for handling bullet -> ecs)
 
@@ -58,7 +55,8 @@ namespace fggl::phys::bullet {
 	}
 
 	void BulletPhysicsEngine::step() {
-		checkForPhys();
+		// this is now handled on creation
+		//checkForPhys();
 
 		auto dynamicEnts = m_ecs->find<phys::Dynamics, phys::bullet::BulletBody>();
 		for (auto& ent : dynamicEnts) {
@@ -77,88 +75,41 @@ namespace fggl::phys::bullet {
 		//syncToECS();
 		pollCollisions();
 
-		if ( debugDraw ) {
+		// if debug draw is enabled, trigger a draw call
+		if ( m_debug != nullptr ) {
 			m_world->debugDrawWorld();
 		}
 	}
 
-	inline btCollisionShape* shape_to_bullet(const phys::RigidBody& fgglBody) {
-		if ( fgglBody.shape == nullptr ) {
-			// they forgot to put a shape, we'll assume a unit sphere to avoid crashes...
-			return new btSphereShape(0.5f);
-		}
+	void BulletPhysicsEngine::addBody(entity::EntityID /*entity*/, BulletBody &body) {
+		// ensure static objects are placed correctly by setting their transforms to the correct value
+		btTransform transform;
+		body.body->getMotionState()->getWorldTransform(transform);
+		body.body->setWorldTransform(transform);
 
-		switch (fgglBody.shape->type) {
-			case phys::ShapeType::BOX: {
-				auto extents = ((phys::Box*)fgglBody.shape)->extents;
-				return new btBoxShape({extents.x, extents.y, extents.z});
-			}
-			case phys::ShapeType::SPHERE: {
-				float radius = ((phys::Sphere*)fgglBody.shape)->radius;
-				return new btSphereShape(radius);
-			}
-			default:
-				return new btSphereShape(0.5f);
-		}
+		m_world->addRigidBody(body.body);
 	}
 
-	void BulletPhysicsEngine::checkForPhys() {
-		// FIXME without reactive-based approaches this is very slow
-		auto entsWantPhys = m_ecs->find<phys::RigidBody>();
-		for (auto ent : entsWantPhys) {
-			auto* btComp = m_ecs->tryGet<BulletBody>(ent);
-			if ( btComp != nullptr ) {
-				// they are already in the simulation
-				continue;
-			}
-
-			// set up the bullet proxy for our object
-			btComp = &m_ecs->add<BulletBody>(ent);
-			const auto& fgBody = m_ecs->get<phys::RigidBody>(ent);
-			btComp->motion = new FgglMotionState(m_ecs, ent);
-
-			// collisions
-			btCollisionShape* colShape = shape_to_bullet(fgBody);
-			btVector3 localInt(0, 0, 0);
-			if ( !fgBody.isStatic() ) {
-				colShape->calculateLocalInertia(fgBody.mass, localInt);
-			}
-
-			// setup the construction information
-			btRigidBody::btRigidBodyConstructionInfo bodyCI(
-				fgBody.mass,
-				btComp->motion,
-				colShape,
-				localInt
-			);
-			btComp->body = new btRigidBody(bodyCI);
-			btComp->body->setUserIndex( static_cast<int>(ent) );
-
-
-			if (!fgBody.isStatic()) {
-				btComp->body->setRestitution(0.5f);
-				btComp->body->setRollingFriction(0.0f);
-			}
-
-			if ( fgBody.type == BodyType::KINEMATIC ) {
-				auto flags = btComp->body->getCollisionFlags() | btCollisionObject::CF_KINEMATIC_OBJECT;
-				btComp->body->setCollisionFlags( flags );
-
-				// we don't have a clean way of saying a kinematic object moved, so just prevent sleeping.
-				// if this turns out to be an issue, we'll need to revisit this.
-				btComp->body->setActivationState( DISABLE_DEACTIVATION );
-			}
-
-			m_world->addRigidBody( btComp->body );
+	void BulletPhysicsEngine::setDebugDraw(bool active)  {
+		if ( active ) {
+			m_debug = std::make_unique<debug::BulletDebugDrawList>();
+			m_world->setDebugDrawer(m_debug.get());
+			m_debug->setDebugMode(btIDebugDraw::DBG_DrawWireframe);
+		} else {
+			m_debug = nullptr;
 		}
 	}
 
-	void BulletPhysicsEngine::forceSyncToECS() {
+	void BulletPhysicsEngine::syncTransformToECS() {
 		const auto physEnts = m_ecs->find<math::Transform, BulletBody>();
 		for (const auto& ent : physEnts) {
-			auto& transform = m_ecs->get<math::Transform>(ent);
 			auto& physBody = m_ecs->get<BulletBody>(ent);
+			// don't bother syncing things with motion states, it's not necessary
+			if ( physBody.motion != nullptr ) {
+				continue;
+			}
 
+			auto& transform = m_ecs->get<math::Transform>(ent);
 			if ( physBody.body->isKinematicObject() ) {
 				continue;
 			}
@@ -185,11 +136,12 @@ namespace fggl::phys::bullet {
 		auto entRB = m_ecs->find<BulletBody>();
 		for (const auto& ent : entRB) {
 			auto& bulletBody = m_ecs->get<BulletBody>(ent);
-			m_world->removeCollisionObject(bulletBody.body);
+			if ( bulletBody.body != nullptr ) {
+				m_world->removeCollisionObject(bulletBody.body);
+			}
 
 			// release resources and delete
 			bulletBody.release();
-			//m_ecs->remove<BulletBody>(ent);
 		}
 
 		// delete the world

integrations/entt/CMakeLists.txt

-target_include_directories( fggl
-        PUBLIC
-            $<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/include>
-            $<INSTALL_INTERFACE:include>
-)

integrations/lua/CMakeLists.txt

+add_library(fggl-lua)
+
+find_package(Lua REQUIRED)
+target_link_libraries(fggl-lua PUBLIC ${LUA_LIBRARIES})
+target_include_directories(fggl-lua INTERFACE ${LUA_INCLUDE_DIR})
+
+# Link to FGGL
+target_link_libraries(fggl-lua PUBLIC fggl)
+
+# sources and include directories
+target_sources(fggl-lua
+    PRIVATE
+        src/engine.cpp
+        src/module.cpp
+)
+target_include_directories(fggl-lua
+    PUBLIC
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/include>
+        $<INSTALL_INTERFACE:include>
+)

integrations/lua/include/fggl/script/lua/engine.hpp

+/*
+ * This file is part of FGGL.
+ *
+ * FGGL is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
+ * later version.
+ *
+ * FGGL is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with FGGL.
+ * If not, see <https://www.gnu.org/licenses/>.
+ */
+
+//
+// Created by webpigeon on 15/10/22.
+//
+
+#ifndef FGGL_INTEGRATIONS_LUA_SCRIPT_LUA_ENGINE_HPP
+#define FGGL_INTEGRATIONS_LUA_SCRIPT_LUA_ENGINE_HPP
+
+#include "fggl/script/engine.hpp"
+#include "fggl/data/storage.hpp"
+
+extern "C" {
+	#include "lua.h"
+	#include "lauxlib.h"
+	#include "lualib.h"
+};
+
+namespace fggl::script::lua {
+
+	class LuaScriptEngine : public ScriptEngine {
+		public:
+			LuaScriptEngine(data::Storage* storage);
+			virtual ~LuaScriptEngine();
+
+			void onActivate() override;
+			void onDeactivate() override;
+			void onUpdate() override;
+
+			void onEvent(const std::string& name) override;
+
+			// running scripts
+			bool run(const char* script) override;
+			bool load(const char* filename) override;
+
+			// variables
+			void setGlobal(const char* name, void* ptr) override;
+
+		private:
+			data::Storage* m_storage;
+			lua_State* m_state;
+			void release();
+	};
+
+	class LuaScriptProvider : public ScriptProvider {
+		public:
+			LuaScriptProvider(data::Storage* storage);
+
+			virtual ~LuaScriptProvider() = default;
+			LuaScriptEngine* create() override;
+
+		private:
+			data::Storage* m_storage;
+	};
+
+}
+
+#endif //FGGL_INTEGRATIONS_LUA_SCRIPT_LUA_ENGINE_HPP

integrations/lua/include/fggl/script/lua/module.hpp

+/*
+ * This file is part of FGGL.
+ *
+ * FGGL is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
+ * later version.
+ *
+ * FGGL is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with FGGL.
+ * If not, see <https://www.gnu.org/licenses/>.
+ */
+
+//
+// Created by webpigeon on 15/10/22.
+//
+
+#ifndef FGGL_INTEGRATIONS_LUA_SCRIPT_LUA_MODULE_HPP
+#define FGGL_INTEGRATIONS_LUA_SCRIPT_LUA_MODULE_HPP
+
+#define FGGL_HAS_LUA
+
+#include "fggl/modules/module.hpp"
+#include "fggl/entity/module.hpp"
+#include "fggl/script/engine.hpp"
+#include "fggl/data/module.hpp"
+#include "fggl/assets/packed/adapter.hpp"
+
+
+namespace fggl::script::lua {
+
+	constexpr auto MIME_LUA = assets::from_mime("text/lua");
+	constexpr auto SCRIPT_LUA = assets::make_asset_type("script/lua");
+
+	struct Lua {
+		constexpr static const char* name = "fggl::script::lua";
+		constexpr static const std::array<modules::ServiceName, 1> provides = {
+			script::ScriptProvider::service
+		};
+		constexpr static const std::array<modules::ServiceName, 2> depends = {
+			data::SERVICE_STORAGE,
+			assets::CheckinAdapted::service
+		};
+		static bool factory(modules::ServiceName name, modules::Services& serviceManager);
+	};
+
+} // namespace fggl::script::lua
+
+namespace fggl::script {
+	using Lua = lua::Lua;
+
+} // namespace fggl::script
+
+#endif //FGGL_INTEGRATIONS_LUA_SCRIPT_LUA_MODULE_HPP

integrations/lua/src/engine.cpp

+/*
+ * This file is part of FGGL.
+ *
+ * FGGL is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
+ * later version.
+ *
+ * FGGL is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with FGGL.
+ * If not, see <https://www.gnu.org/licenses/>.
+ */
+
+//
+// Created by webpigeon on 15/10/22.
+//
+
+#include "fggl/script/lua/engine.hpp"
+#include "fggl/debug/logging.hpp"
+
+#include "fggl/scenes/game.hpp"
+#include "fggl/entity/loader/loader.hpp"
+
+#include <cassert>
+
+extern "C" {
+	int lua_switch_scene(lua_State *L) {
+		auto *scene = lua_tostring(L, -1);
+		auto *statePtr = (fggl::AppState *) (lua_topointer(L, -2));
+		statePtr->owner().change_state(scene);
+		return 0;
+	}
+
+	int lua_create_entity(lua_State *L) {
+		/*auto *prototype = lua_tostring(L, -1);
+		auto *statePtr = (fggl::scenes::Game*) (lua_topointer(L, -2));
+
+		auto *factory = statePtr->owner().service<fggl::entity::EntityFactory>();
+		//factory->create( statePtr->world(), , [](){} );
+		*/
+		return 0;
+	}
+
+	static void open_lua_fggl(lua_State *L) {
+		// switch scene
+		lua_pushcfunction(L, lua_switch_scene);
+		lua_setglobal(L, "switch_scene");
+	}
+}
+
+namespace fggl::script::lua {
+
+	LuaScriptProvider::LuaScriptProvider(data::Storage *storage) : m_storage(storage) {
+
+	}
+
+	LuaScriptEngine *LuaScriptProvider::create() {
+		return new LuaScriptEngine(m_storage);
+	}
+
+	LuaScriptEngine::LuaScriptEngine(data::Storage* storage) : m_state(luaL_newstate()), m_storage(storage) {
+		luaL_openlibs(m_state);
+		open_lua_fggl(m_state);
+	}
+
+	LuaScriptEngine::~LuaScriptEngine() {
+		release();
+	}
+
+	void LuaScriptEngine::release() {
+		if ( m_state != nullptr ) {
+			lua_close(m_state);
+			m_state = nullptr;
+		}
+	}
+
+	void LuaScriptEngine::onActivate() {
+		lua_getglobal(m_state, "print");
+		lua_pushstring(m_state, "LUA activate triggered");
+		lua_call(m_state, 1, 0);
+	}
+
+	void LuaScriptEngine::onDeactivate() {
+		lua_getglobal(m_state, "print");
+		lua_pushstring(m_state, "LUA deactivate triggered");
+		lua_call(m_state, 1, 0);
+	}
+
+	void LuaScriptEngine::onUpdate() {
+		lua_getglobal(m_state, "print");
+		lua_pushstring(m_state, "LUA update triggered");
+		lua_call(m_state, 1, 0);
+	}
+
+	void LuaScriptEngine::onEvent(const std::string &name) {
+		lua_getglobal(m_state, "print");
+		lua_pushstring(m_state, "LUA event triggered");
+		lua_call(m_state, 1, 0);
+	}
+
+	bool LuaScriptEngine::run(const char *script) {
+		auto result = luaL_dostring(m_state, script);
+		if ( !result ) {
+			fggl::debug::warning("lua error: {}", lua_tostring(m_state, -1));
+		}
+		return result;
+	}
+
+	bool LuaScriptEngine::load(const char *filename) {
+		assert( filename != nullptr);
+		auto path = m_storage->resolvePath(data::StorageType::Data, filename);
+
+		if ( !std::filesystem::exists(path) ) {
+			fggl::debug::warning("lua error: file does not exist: {}", path.c_str());
+			return false;
+		}
+
+		// load the file ( OK = 0 = false because reasons...)
+		auto result = !luaL_dofile(m_state, path.c_str());
+		if ( !result ) {
+			fggl::debug::warning("lua error: {}", lua_tostring(m_state, -1));
+			return false;
+		}
+		return true;
+	}
+
+	void LuaScriptEngine::setGlobal(const char *name, void *ptr) {
+		lua_pushlightuserdata(m_state, ptr);
+		lua_setglobal(m_state, name);
+	}
+
+}
\ No newline at end of file

integrations/lua/src/module.cpp

+/*
+ * This file is part of FGGL.
+ *
+ * FGGL is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
+ * later version.
+ *
+ * FGGL is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with FGGL.
+ * If not, see <https://www.gnu.org/licenses/>.
+ */
+
+//
+// Created by webpigeon on 15/10/22.
+//
+
+#include "fggl/script/lua/module.hpp"
+#include "fggl/script/lua/engine.hpp"
+
+namespace fggl::script::lua {
+
+	static assets::AssetTypeID is_lua(std::filesystem::path path) {
+		if ( path.extension() == ".lua" ) {
+			return SCRIPT_LUA;
+		}
+		return assets::INVALID_ASSET_TYPE;
+	}
+
+	bool Lua::factory(modules::ServiceName service, modules::Services &serviceManager) {
+
+		if ( service == ScriptProvider::service ) {
+			auto *storageService = serviceManager.get<data::Storage>();
+			serviceManager.bind<ScriptProvider,LuaScriptProvider>(storageService);
+
+			auto *assetPacker = serviceManager.get<assets::CheckinAdapted>();
+			assetPacker->setLoader(MIME_LUA, assets::NEEDS_CHECKIN, is_lua);
+
+			return true;
+		}
+
+		return false;
+	}
+
+}
\ No newline at end of file

tests/testfggl/util/guid.cpp

@@ -108,9 +108,11 @@ namespace {
 		EXPECT_EQ( false, guid2 < guid1);
 	}
 
+	#ifdef DEBUG
 	TEST(GuidTest, GuidToString) {
 		fggl::util::GUID guid = fggl::util::internString("test");
 		EXPECT_EQ("test", fggl::util::guidToString(guid));
 	}
+	#endif
 
 }

tools/pack/CMakeLists.txt

+add_executable(fgpak)
+
+target_link_libraries(fgpak fggl)
+
+target_sources(fgpak
+  PRIVATE
+    src/main.cpp
+)
\ No newline at end of file

tools/pack/src/binary.hpp

+/*
+ * This file is part of FGGL.
+ *
+ * FGGL is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
+ * later version.
+ *
+ * FGGL is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with FGGL.
+ * If not, see <https://www.gnu.org/licenses/>.
+ */
+
+/*
+ * This file is part of FGGL.
+ *
+ * FGGL is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
+ * later version.
+ *
+ * FGGL is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with FGGL.
+ * If not, see <https://www.gnu.org/licenses/>.
+ */
+
+//
+// Created by webpigeon on 11/09/22.
+//
+
+#ifndef FGGL_TOOLS_PACK_SRC_BINARY_HPP
+#define FGGL_TOOLS_PACK_SRC_BINARY_HPP
+
+#include <cstdint>
+#include <iostream>
+#include <cstdio>
+
+#include "fggl/data/model.hpp"
+
+namespace fggl::data {
+
+	enum class ModelType {
+			OPENGL
+	};
+
+	struct ModelHeader {
+		unsigned long guid;
+		std::size_t size;
+		ModelType type;
+	};
+
+	void write_mesh(FILE* file, const Mesh& mesh) {
+		static_assert( std::is_standard_layout_v<Vertex> );
+		static_assert( std::is_standard_layout_v<Mesh::IndexType> );
+
+		// write vertex data
+		std::size_t vertexCount = mesh.vertexCount();
+		fwrite( &vertexCount, sizeof(vertexCount), 1, file );
+		fwrite( mesh.vertexList().data(), sizeof(Vertex), vertexCount, file );
+
+		std::size_t indexCount = mesh.indexCount();
+		fwrite( &indexCount, sizeof(indexCount), 1, file);
+		fwrite( mesh.indexList().data(), sizeof(Mesh::IndexType), indexCount, file);
+	}
+
+	void write_model(FILE* file, const ModelHeader& header, const Mesh& mesh) {
+		assert( header.type == ModelType::OPENGL );
+		fwrite( &header , sizeof(ModelHeader), 1, file);
+		write_mesh(file, mesh);
+	}
+
+	void read_mesh(FILE* fin, data::Mesh& mesh) {
+		static_assert( std::is_standard_layout_v<Vertex> );
+		static_assert( std::is_standard_layout_v<Mesh::IndexType> );
+		std::size_t readCount;
+
+		// vertex data
+		std::size_t vertexCount = 0;
+		readCount = fread( &vertexCount, sizeof(vertexCount), 1, fin );
+		assert(ferror(fin) == 0);
+		if (readCount != 1) {
+			std::cerr << "failed to read vertex count" << std::endl;
+			return;
+		}
+
+		// push vertex data into mesh
+		auto* vertexData = new data::Vertex[vertexCount];
+		readCount = fread( vertexData, sizeof(Vertex), vertexCount, fin );
+		assert(ferror(fin) == 0);
+		if ( readCount != vertexCount ) {
+			std::cerr << "failed to read vertex data" << std::endl;
+			return;
+		}
+		for ( std::size_t i = 0; i < vertexCount; ++i) {
+			mesh.pushVertex(vertexData[i]);
+		}
+		delete[] vertexData;
+
+		// read index size
+		std::size_t indexCount = 0;
+		readCount = fread( &indexCount, sizeof(indexCount), 1, fin);
+		assert(ferror(fin) == 0);
+		if (readCount != 1 ) {
+			std::cerr << "failed to read index count" << std::endl;
+			return;
+		}
+
+		// read index data
+		auto* idxData = new Mesh::IndexType[indexCount];
+		readCount = fread( idxData, sizeof(Mesh::IndexType), indexCount, fin);
+		assert(ferror(fin) == 0);
+
+		if (readCount != indexCount) {
+			std::cerr << "failed to read index data, expected: " << indexCount << ", got: " << readCount  << std::endl;
+			return;
+		}
+
+		for (int i=0; i < indexCount; ++i) {
+			mesh.pushIndex( idxData[i] );
+		}
+		delete[] idxData;
+	}
+
+	void read_model(FILE* file, ModelHeader& header, Mesh& mesh) {
+		fread( &header, sizeof(ModelHeader), 1, file);
+		if ( header.type == ModelType::OPENGL ) {
+			read_mesh(file, mesh);
+		}
+	}
+
+}
+
+#endif //FGGL_TOOLS_PACK_SRC_BINARY_HPP

tools/pack/src/main.cpp

+/*
+ * This file is part of FGGL.
+ *
+ * FGGL is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
+ * later version.
+ *
+ * FGGL is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with FGGL.
+ * If not, see <https://www.gnu.org/licenses/>.
+ */
+
+//
+// Created by webpigeon on 11/09/22.
+//
+
+#include <cstdlib>
+#include <iostream>
+#include <fstream>
+#include <filesystem>
+#include <map>
+
+#include <yaml-cpp/yaml.h>
+
+#include "fggl/data/model.hpp"
+#include "fggl/data/procedural.hpp"
+#include "fggl/entity/loader/loader.hpp"
+
+#include "binary.hpp"
+
+constexpr const char* YAML_PREFAB = "prefabs";
+constexpr const char* YAML_COMPONENT = "components";
+
+constexpr uint32_t DEFAULT_STACKS = 16;
+constexpr uint32_t DEFAULT_SLICES = 16;
+constexpr const char *SHAPE_SPHERE{"sphere"};
+constexpr const char *SHAPE_BOX{"box"};
+
+namespace fggl {
+	static void process_shape(const YAML::Node &node, data::Mesh &mesh) {
+		auto transform = data::OFFSET_NONE;
+
+		auto offset = node["offset"].as<math::vec3>(math::VEC3_ZERO);
+		transform = glm::translate(transform, offset);
+
+		auto scale = node["scale"].as<math::vec3>(math::VEC3_ONES);
+		transform = glm::scale(transform, scale);
+		debug::debug("scale: {}, {}, {}", scale.x, scale.y, scale.z);
+
+		// now the shape itself
+		auto type = node["type"].as<std::string>();
+		if (type == SHAPE_BOX) {
+			data::make_cube(mesh, transform);
+		} else if (type == SHAPE_SPHERE) {
+			auto stacks = node["stacks"].as<uint32_t>(DEFAULT_STACKS);
+			auto slices = node["slices"].as<uint32_t>(DEFAULT_SLICES);
+			data::make_sphere(mesh, transform, stacks, slices);
+		} else {
+			debug::log(debug::Level::warning, "unknown shape type requested: {}", type);
+		}
+	}
+
+	static void process_mesh(const YAML::Node& spec, fggl::data::Mesh& mesh) {
+		// process shape structure
+		if (spec["shape"].IsSequence()) {
+			for (const auto &node : spec["shape"]) {
+				process_shape(node, mesh);
+			}
+		} else {
+			process_shape(spec["shape"], mesh);
+		}
+		mesh.removeDups();
+	}
+}
+
+void write_comp_static_model(FILE* fout, const YAML::Node& config) {
+	// calculate mesh
+	fggl::data::Mesh mesh;
+	fggl::process_mesh( config, mesh);
+
+	// calculate correct name
+	auto meshName = config["shape_id"];
+	auto meshNameStr = meshName.as<std::string>();
+	auto meshGuid = fggl::util::make_guid_rt(meshNameStr);
+
+	// header data
+	fggl::data::ModelHeader header{
+		.guid = meshGuid.get(),
+		.type = fggl::data::ModelType::OPENGL,
+	};
+
+	// write the mesh to disk
+	fggl::data::write_model( fout, header, mesh );
+}
+
+int main(int argc, char* argv[]) {
+	auto* packName = argv[1];
+	std::cout << "generating " << packName << std::endl;
+
+	std::map< fggl::util::GUID, std::string > guids;
+
+	// rollball
+	auto rollPath = std::filesystem::current_path() / "rollball.yml";
+	std::cout << rollPath << std::endl;
+
+	YAML::Node root = YAML::LoadFile(rollPath);
+	if ( !root ){
+		return EXIT_FAILURE;
+	}
+
+	//std::cout << root[ YAML_PREFAB ] << std::endl;
+
+	std::map<std::string, std::function<void(FILE* fout, const YAML::Node&)>> converters;
+	converters["StaticMesh"] = write_comp_static_model;
+
+	std::string meshFile = "rollball_models.bin";
+	FILE* fout = fopen(meshFile.c_str(), "w");
+
+	// pack prefabs
+	for (const auto& prefab : root[YAML_PREFAB]) {
+		// name
+		auto name = prefab["name"].as<std::string>();
+		auto nameRef = fggl::util::make_guid(name.c_str());
+		guids[nameRef] = name;
+		std::cout << name << std::endl;
+
+		// parent
+		//auto parentName = prefab["parent"].as<std::string>();
+		//auto parentGuid = fggl::util::make_guid(parentName.c_str());
+
+		// components
+		for( const auto& key : prefab[YAML_COMPONENT] ) {
+			auto compStr = key.first.as<std::string>();
+			auto compGuid = fggl::util::make_guid_rt(compStr);
+			guids[compGuid] = compStr;
+
+			// figure out the type
+			auto compWrite = converters.find(compStr);
+			if ( compWrite != converters.end()) {
+				compWrite->second(fout, key.second);
+			}
+		}
+
+	}
+
+	fclose(fout);
+
+	// guid table
+	std::cerr << "GUID Table" << std::endl;
+	std::cerr << "guid,str" << std::endl;
+	for (auto& [guid,str] : guids) {
+		std::cerr << guid.get() << "," << str << std::endl;
+	}
+
+	return EXIT_SUCCESS;
+}
\ No newline at end of file

vendor/README.md

+# Vendor Libraries
+This folder contains 3rd party code we need to ship with our build.
+Compile-time only dependencies, or dependencies which can be included using cmake directly will not be included within this folder.
+
+| Library    | Purpose                                          | Licence |
+|------------|--------------------------------------------------|---------|
+| GLAD       | Allow loading of OpenGL libraries and extentions | MIT     |
+| Dear IMGUI | Debugging UI/Editor windows                      | MIT     |
\ No newline at end of file