Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Welcome to ÖbEngine's wiki
What is ÖbEngine ?
It's a free, open-source 2d game engine created on top of C++, SFML and Lua.
Want to learn how to use it ?
Fine ! That's what this Wiki is for, take your time and enjoy !
Road to 1.0 : https://github.com/Sygmei/ObEngine/wiki/Road-to-1.0
🏁 Getting started
- 🖊 My first project : Create a simple empty project !
- 🗺 My first map : Create your first empty map !
- 📏 Project Structure : Learn about the folder structure of an ÖbEngine project
- 🖼 LevelSprites : Add some sprites to your level
- 📐 Colliders : Add some colliders to your level
- 🔳 EditorGrid : Use a grid for precise level edition
- 🤖 GameObjects : Add dynamic objects on your map !
- 🖊 Scripting : Learn how to script in ÖbEngine
- 📜 Read the Docs : Read docs to learn more about the engine
- ⌨️ Keyboard and Actions : Using the Keyboard and binding keys to Actions
- 🔉 Sounds and Musics : Add some sounds and musics to your game
- 🗄 Vili Format : Tutorial on Vili
😨 Getting further
- 👨💻 Debugging : Kill all the bugs !
- 📽 Animations : Add life in your game with Animations
- ⌚️ Manipulating Time : Manipulate Time in the Engine
- 🎨 Using the Canvas : Draw stuff using the Canvas !
- 🔗 SceneNodes : Link Scene elements together with SceneNodes
- 🚋 Trajectories : Moving your objects with Trajectories
: Learn more about the triggers
- 🔫 Triggers : The simpliest Trigger class
- 🔫 TriggerGroup : Managing Triggers with TriggerGroup
- 🔫 TriggerDatabase : Managing TriggerGroup with TriggerDatabase
- 🔫 TriggerDelay : Delaying Triggers
- 🔫 Managing a TriggerGroup : Creating and Managing a TriggerGroup
- 🔫 Joining a TriggerGroup : Joining an existing TriggerGroup
- 🖱 Cursor and Constraints : Using the Cursor
- 📁 Mounting and Paths : Everything about Mounting and Paths
- 👨🏭 Workspaces : Learn more about Workspaces
- 📏 Coordinates and Transform : How Coordinates and Transforms works
- 📷 Camera : Handle Camera(s)
- 🗺 Map files : Understand Map File Structure
- ➡️ PositionTransformers
- 🏭 The ResourceManager : Using the ResourceManager
😭 Advanced knowledge
- ♻️ Lua Environments : Learn the truth about Lua Environments
- ⚙️ Vili and Lua : Learn how to pass data from one to another
- 📏 Advanced Transform : Advanced knowledge on Transform
- 🗄 Advanced Vili : Discover more about Vili
- 💀 Errors in ÖbEngine : Handling and creating errors in ÖbEngine
- 📦 Packages and dependencies : Install and create Packages
- 👷 Extending ÖbEngine : Add your own code to ÖbEngine
- 🔌 Plugins for ObEngine : Create your very own plugins for ObEngine
- 📎 Binding to Lua : Binding code to Lua
- 🎮 Distribution : Distributing a game made with ÖbEngine
🔨 Using the Toolkit
- 🔧 The Toolkit : Using the Toolkit commands
- ⬇️ Extending Toolkit : Adding more commands to the Toolkit
- 🛠 Your own commands : Create your own commands
- ⌨️ Autocompletion : Add autocompletion to your custom commands