meta: adapt readme
This commit is contained in:
parent
ccbff45f21
commit
5575b90271
1 changed files with 8 additions and 32 deletions
40
README.md
40
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
|
## 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()
|
function love.load()
|
||||||
core = Core()
|
birb.startCore()
|
||||||
end
|
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
|
|
||||||
|
|
Loading…
Reference in a new issue