Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nidorx/ecs-lua
ECS Lua is a fast and easy to use ECS (Entity Component System) engine for game development.
https://github.com/nidorx/ecs-lua
lua luajit roblox robloxlua
Last synced: 5 days ago
JSON representation
ECS Lua is a fast and easy to use ECS (Entity Component System) engine for game development.
- Host: GitHub
- URL: https://github.com/nidorx/ecs-lua
- Owner: nidorx
- License: mit
- Created: 2020-10-21T14:19:07.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-24T06:34:40.000Z (7 months ago)
- Last Synced: 2024-12-28T02:14:58.650Z (15 days ago)
- Topics: lua, luajit, roblox, robloxlua
- Language: Lua
- Homepage:
- Size: 6.98 MB
- Stars: 166
- Watchers: 9
- Forks: 58
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-love2d - ecs-lua - ECS Lua is a fast and easy to use ECS (Entity Component System) engine for game development. (Entity)
- awesome-defold - ecs-lua
README
# What is it?
ECS Lua is a fast and easy to use ECS (Entity Component System) engine for game development.
The basic idea of this pattern is to stop defining entities using a
[hierarchy](https://en.wikipedia.org/wiki/Inheritance_(object-oriented_programming)) of classes and start doing use of
[composition](https://en.wikipedia.org/wiki/Object_composition) in a Data Oriented Programming paradigm.
([More information on Wikipedia](https://en.wikipedia.org/wiki/Entity_component_system)).
Programming with an ECS can result in code that is more efficient and easier to extend over time.
# How does it work?
# Talk is cheap. Show me the code!
```lua
local World, System, Query, Component = ECS.World, ECS.System, ECS.Query, ECS.Component
local Health = Component(100)
local Position = Component({ x = 0, y = 0})
local isInAcid = Query.Filter(function()
return true -- it's wet season
end)
local InAcidSystem = System("process", Query.All( Health, Position, isInAcid() ))
function InAcidSystem:Update()
for i, entity in self:Result():Iterator() do
local health = entity[Health]
health.value = health.value - 0.01
end
end
local world = World({ InAcidSystem })
world:Entity(Position({ x = 5.0 }), Health())
```
# Features
**ECS Lua** has no external dependencies and is compatible and tested with [Lua 5.1], [Lua 5.2], [Lua 5.3], [Lua 5.4],
[LuaJit] and [Roblox Luau](https://luau-lang.org/)
- **Game engine agnostic**: It can be used in any engine that has the Lua scripting language.
- **Ergonomic**: Focused on providing a simple yet efficient API
- **FSM**: Finite State Machines in an easy and intuitive way
- **JobSystem**: To running systems in parallel (through [coroutines])
- **Reactive**: Systems can be informed when an entity changes
- **Predictable**:
- The systems will work in the order they were registered or based on the priority set when registering them.
- Reactive events do not generate a random callback when issued, they are executed at a predefined step.
# Goal
To be a lightweight, simple, ergonomic and high-performance ECS library that can be easily extended. The **ECS Lua**
does not strictly follow _"pure ECS design"_.
# Usage
Read our [Full Documentation][docs] to learn how to use **ECS Lua**.
# Get involved
All kinds of contributions are welcome!
🐛 **Found a bug?**
Let me know by [creating an issue][new-issue].
❓ **Have a question?**
[Roblox DevForum][discussions] is a good place to start.
⚙️ **Interested in fixing a [bug][bugs] or adding a [feature][features]?**
Check out the [contributing guidelines](CONTRIBUTING.md).
📖 **Can we improve [our documentation][docs]?**
Pull requests even for small changes can be helpful. Each page in the docs can be edited by clicking the
"Edit on GitHub" link at the bottom right.
[docs]: https://nidorx.github.io/ecs-lua
[bugs]: https://github.com/nidorx/ecs-lua/issues?q=is%3Aissue+is%3Aopen+label%3Abug
[features]: https://github.com/nidorx/ecs-lua/issues?q=is%3Aissue+is%3Aopen+label%3Afeature
[new-issue]: https://github.com/nidorx/ecs-lua/issues/new/choose
[discussions]: https://devforum.roblox.com/t/841175
[Lua 5.1]:https://app.travis-ci.com/github/nidorx/ecs-lua
[Lua 5.2]:https://app.travis-ci.com/github/nidorx/ecs-lua
[Lua 5.3]:https://app.travis-ci.com/github/nidorx/ecs-lua
[Lua 5.4]:https://app.travis-ci.com/github/nidorx/ecs-lua
[LuaJit]:https://app.travis-ci.com/github/nidorx/ecs-lua
[coroutines]:http://www.lua.org/pil/9.1.html
# License
This code is distributed under the terms and conditions of the [MIT license](LICENSE).