https://github.com/tesselode/nata

Entity management for Lua.
https://github.com/tesselode/nata

Last synced: 3 days ago
JSON representation

Entity management for Lua.

• Host: GitHub
• URL: https://github.com/tesselode/nata
• Owner: tesselode
• License: mit
• Created: 2017-11-12T09:02:47.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2021-01-20T04:02:02.000Z (almost 4 years ago)
• Last Synced: 2024-08-02T06:17:12.529Z (3 months ago)
• Language: Lua
• Homepage: https://tesselode.github.io/nata/
• Size: 228 KB
• Stars: 43
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

• awesome-love2d - nata - Hybrid OOP/ECS entity management. (Entity)

README

        
Nata

----

Nata is a Lua library for managing entities in games. It allows you to create **entity pools**, which are containers that hold all the objects in a game, like geometry, characters, and collectibles. At its simplest, pools hold entities and allow you to call functions on them, but they also provide a minimal structure for an Entity Component System organization.

To see Nata in action, open the demo with LÖVE from the root directory:

```

love demo

```

## Installation

To use Nata, place `nata.lua` in your project, and then add this code to the files where you use Nata:

```lua

local nata = require 'nata' -- if your nata.lua is in the root directory

local nata = require 'path.to.nata' -- if it's in subfolders

```

## Documentation

### [Tutorial](https://tesselode.github.io/nata/topics/tutorial.md.html) | [API reference](https://tesselode.github.io/nata/)

## Contributing

Nata is a young library, so feel free to make suggestions about the design! Issues and pull requests are always welcome.

To run the tests, run the following command from the root directory:

```

busted test

```

The tests are very new, so they might have mistakes and/or not cover every edge case. Please help me improve them!