From 5575b90271fbccc1b6b29ec80f109f9f2695fb06 Mon Sep 17 00:00:00 2001 From: Kazhnuz Date: Sun, 5 Apr 2020 18:48:57 +0200 Subject: [PATCH] meta: adapt readme --- README.md | 40 ++++++++-------------------------------- 1 file changed, 8 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 8e482c4..2a84206 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,20 @@ -# gamecore +# Birb Love2D Engine -Gamecore aim to be an integrated, simple core system for love2D. It aim to make work in a integrated way several managers to automatically handle inputs, screen, and several utilities to make game developpement easier and less repetitive. +Birb aim to be an integrated, simple engine for love2D. It aim to work as a set of managers to automatically handle inputs, screen, and several utilities to make game developpement easier and less repetitive. -Gamecore use [Classic](https://github.com/rxi/classic/) as its base Object +Birb use [Classic](https://github.com/rxi/classic/) as its base Object. ## How to load GameCore -To load gamecore, you basically need the following code. +The birb engine must be located in the `birb/` folder to work. After that, all you have to do is to load a gamecore based engine and then. + +Note : the `birb` and `utils` global namespace will be used by birb. ```` -Core = require "gamecore" +require "birb" function love.load() - core = Core() + birb.startCore() end ```` - -Then you have to create some scene object, - -## Gamecore managers - -- Debug - -- Input - -- Lang - -- Options - -- Screen - -- Scene Manager - -## GameCore modules - -Modules are utilies that you can load everywhere in your code and that aren't loaded specifically inside the core. - -- Scene Object - -- Assets - -- Menu System