mirror of
https://github.com/Keyslam-Group/Concord.git
synced 2025-09-02 12:24:11 -04:00
37 lines
1.1 KiB
Markdown
37 lines
1.1 KiB
Markdown
# 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](https://github.com/Tjakka5/Concord/wiki).
|
|
|
|
## Installation
|
|
Download the repository and drop it in your project, then simply require it as:
|
|
```lua
|
|
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
|
|
|
|
```lua
|
|
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)
|