diff options
| author | realtradam <[email protected]> | 2021-06-10 12:24:38 -0400 |
|---|---|---|
| committer | realtradam <[email protected]> | 2021-06-10 12:24:38 -0400 |
| commit | 685fcbe56929d574055fb8bdedb0053c7239987c (patch) | |
| tree | f70068afec701005405c8a379d13fdb6d95ceb3a | |
| parent | 3a960438c1cfd2211e6cc78095e67c7387e8480b (diff) | |
| download | FelECS-685fcbe56929d574055fb8bdedb0053c7239987c.tar.gz FelECS-685fcbe56929d574055fb8bdedb0053c7239987c.zip | |
update readme
| -rw-r--r-- | README.mdown | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/README.mdown b/README.mdown index 4b684cc..01dab79 100644 --- a/README.mdown +++ b/README.mdown @@ -3,19 +3,30 @@ [](https://codeclimate.com/github/realtradam/FelFlame/maintainability) [](https://codeclimate.com/github/realtradam/FelFlame/test_coverage) +[](https://felflame.tradam.fyi) # What is this? This is a Ruby ECS Framework for developing games. It is still a work in progress in the early stages, is not fit for use, and does not work. -It is designed to be platform agnosting, this means it should be able to work by plugging it into any ruby game engine/library/toolkit with minimal modifications. +It is designed to be platform agnostic, this means it should be able to work by plugging it into any ruby game engine/library/toolkit with minimal modifications. I wanted a reusable framework so I could quickly and effectively develop games. I also want it to be more complete, as opposed to barebones or boilerplate. I plan to eventually add functionality outside of just ECS such as loading tilesets, a camera system, etc. that are built into the framework to work seamlessly. -Below are the specifications I have imagined for this framework and have been written out. They are subject to change as FelFlame is developed and used. + +# What is currently implemented? + +Entities and Components are mostly implemented, with only a few non-critical functions missing. + +Systems, Scenes, and the Stage still needs to be implemented + +You can view the [Documentation here](https://felflame.tradam.fyi) + # Specification +Below are the specifications I have imagined for this framework and have been written out. They are subject to change as FelFlame is developed and used. + ## Aliases: ```ruby FF = FelFlame |