Home

Welcome to ÖbEngine's wiki

Introduction

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 !
  • 🤖 GameObjects Definition File : Define GameObjects and their Components
  • 🤖 Add GameObjects on map : Add your GameObjects on the map
  • 🤖 GameObjects Requirements : Define Requirements for your Objects
• 🖊 Scripting : Learn how to script in ÖbEngine
  • 🖊 Some basic Lua : Some basic required Lua knowledge
  • 🖊 Local Events : Local GameObject events
  • 🖊 Global Events
  • 🖊 Access Components : Access the Components of the GameObjects
  • 🖊 Requirements and parameters : Access the requirements values !
  • 🖊 ObEngine API : Use the ObEngine API
• 🔫 Events : Learn more about the events
  • 🔫 Listeners : How to listen to an event
  • 🔫 EventGroups : Managing Events with EventGroups
  • 🔫 EventNamespace : Managing EventGroups with EventNamespaces
  • 🔫 Scheduler : Playing with schedulers
• 📜 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
  • 🗄 Syntax : Syntax of Vili
  • 🗄 Attributes : Attributes in Vili
  • 🗄 DataTypes : DataTypes in Vili
  • 🗄 Parsing and Writing : Parsing .vili files and write .vili files
  • 🗄 Using Vili : Using vili in your scripts !
  • 🗄 Imports : Import vili files from your vili files !

😨 Getting further

• 👨‍💻 Debugging : Kill all the bugs !
• 📽 Animations : Add life in your game with Animations
  • 📽 Animation Files : Writing and understanding Animation files
  • 📽 Animation Commands : Make complex Animation with Animation commands
  • 📽 Animation Callbacks : Synchronize your game and your animations with callbacks
  • 📽 Animator : Manage all your animations with an Animator
• ⌚️ Manipulating Time : Manipulate Time in the Engine
  • ⌚️ TimeUtils : Discover various Time functions
  • ⌚️ Chronometer, TimeCheck and FramerateCounter : Use Chronometer and FramerateCounter
  • ⌚️ FramerateManager : Manage DeltaTime and more with the FramerateManager
• 🎨 Using the Canvas : Draw stuff using the Canvas !
• ✔️ Tasks : Implement sequences of actions with ease
• 🔗 SceneNodes : Link Scene elements together with SceneNodes
• 🚋 Trajectories : Moving your objects with Trajectories
• 🖱 Cursor and Constraints : Using the Cursor
• 📁 Mounting and Paths : Everything about Mounting and Paths
  • 📁 Mount.vili : The most important file of the engine
  • 📁 Path : Learn about how Paths are handled in ÖbEngine
  • 📁 File Loaders : Load files using Loaders
• 👨‍🏭 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
• 🎮 Gamepads and Joysticks : Learning how to use gamepads

😭 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
  • 🗄 Visibility : Attributes visibility
  • 🗄 Flags : Using Vili Flags
  • 🗄 Links : The LinkAttributes
  • 🗄 Templates : Creating and Using Templates
  • 🗄 Ranges : Ranges in Vili
  • 🗄 NodeIterator and NodeValidator : Advanced tasks with Vili nodes
• 💀 Errors in ÖbEngine : Handling and creating errors in ÖbEngine
• 📦 Packages and dependencies : Install and create Packages
  • 📦 Installing Packages : Install downloaded Packages
  • 📦 Creating your own packages : Create your own Package and distribute them
• 👷 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

😉 Bonus

• 🏗 Building ObEngine : Build ÖbEngine yourself !
• ❓ F.A.Q : Frequently Asked Questions
• 💾 License : ÖbEngine's license
• 🆘 Contributing : Contributing to ÖbEngine
• 🎢 Roadmap : ÖbEngine's Roadmap