mirror of
https://github.com/Keyslam-Group/Concord.git
synced 2025-09-01 20:03:55 -04:00
Mirror of https://github.com/Keyslam-Group/Concord
67d67aad5f
* Added a "nothing docstring" at the top of each file we want to generate docs for. We have to do this or ldoc just straight up refuses to generate docs otherwise. * Fixed up a few incorrect docstrings * config.ld is the config file for ldoc These still need some work: a bunch of functions are still undocumented and also: type.lua & run.lua are completely undocumented. |
||
|---|---|---|
| doc | ||
| examples | ||
| lib | ||
| .gitattributes | ||
| .gitignore | ||
| conf.lua | ||
| config.ld | ||
| LICENSE | ||
| main.lua | ||
| README.md | ||
Concord
Concord is a feature complete ECS. It's main focus is on speed and usage. You should be able to quickly write code that performs well.
Documentation for Concord can be found in the Wiki tab.
Installation
Download the repository and drop it in your project, then simply require it as:
local Concord = require(PathToConcord).init()
You will only need to call .init once when you first require it.
Modules
Below is a list of modules. More information about what each done can be found in the Wiki
local Concord = require("concord")
local Entity = require("concord.entity")
local Component = require("concord.component")
local System = require("concord.system")
local Instance = require("concord.instance")
Contributors
Positive07: Constant support and a good rubberduck
Brbl: Early testing and issue reporting
Josh: Squashed a few bugs
Erasio: Took inspiration from HooECS. Also introduced me to ECS.
Licence
MIT Licensed - Copyright Justin van der Leij (Tjakka5)