epervier
/
epervier-old
1
0
Fork 0
Code Issues 34 Pull Requests Releases Wiki Activity

chore: update readme and changelog

This commit is contained in:
Kazhnuz Klappsthul 2022-08-12 10:59:03 +02:00
parent 6d3c8de013
commit 5ab63a145a
2 changed files with 33 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## Unreleased
- Project renamed to Birb and rebased entirely on Sonic Radiance codebase
- Project renamed to Epervier Framework and rebased entirely on Sonic Radiance codebase
- New loading system
@ -25,7 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- **core/input:** extract virtualpads from the input controller
- **core:** The core is now separated from the rest of birb
- **core:** The core is now separated from the rest of the framework
- **core+assets:** Music are now managed directly by the core

42
README.md
View File

@ -1,20 +1,40 @@
# Birb Love2D Engine
# Épervier Framework
Birb aim to be an integrated, simple engine for love2D, in replacement of my old "gamecore" love2D engine. 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. It's also specialized in game with RPG mechanics, with functions to serialize/deserialize easily datas.
The Épervier Framework is an RPG-oriented framework 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. It's also specialized in game with RPG mechanics, with functions to serialize/deserialize easily datas.
Birb use [Classic](https://github.com/rxi/classic/) as its base Object.
Épervier use [Classic](https://github.com/rxi/classic/) as its base Object.
## How to load Birb
## Core features
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.
Épervier provide a lot of feature that can be usefull to create an RPG. This is a non-exhaustive list of what the framework can do :
Note : the `birb` and `utils` global namespace will be used by birb.
- Scene system to be able to change your gameplay easily, with transitions
- Easy data loading and parsing via the core.data module
- A save system using data serialization
- Tweening and time support via tween.lua
- A world system with support for camera, multiple hitbox per actor, and two type of physics (bump2D and bump3D) and tiled map loading (via sti.lua)
- A GUI system to make your game more easily have HUD and menus
- Several utilities functions
````
require "birb"
## How to load Épervier
function love.load()
birb.startCore()
The framework must be located in the `framework/` folder to work. After that, all you have to do is to load a gamecore based engine and then.
Note : the `framework`, `core`, `game` and `utils` global namespaces will be used by the framework.
```lua
require "framework"
function love.load(args)
framework.start("game", args)
end
````
```
### Launch in debug mode
To launch in debug mode, the love2D game must be launched with a DEBUGLEVEL bigger than 1, for instance :
```sh
love ./examples DEBUGLEVEL=4
```