Tiny ECS as Defold Library

Ivan · September 13, 2024, 8:35pm

Hi! I’ve just packaged Tiny ECS as a Defold Library: https://github.com/ivanquirino/defold-tiny-ecs

To use it, add https://github.com/ivanquirino/defold-tiny-ecs/archive/refs/tags/1.3-3.zip as a dependency in your project. Then just require it like this:

local tiny = require("tinyecs.tiny")

Insality · September 14, 2024, 8:58am

There is Lua annotations for tiny-ecs here, if you are interested:

github.com

Insality/shooting_circles/blob/main/decore/decore_annotations.lua#L11-L80

    
      
          ---@class system
          ---@field id string|number|nil
          ---@field active boolean
          ---@field filter fun(self: system, entity: entity)|nil
          ---@field world world
          ---@field entities entity[]
          ---@field indices table<entity, number> @Entity index in entities table
          ---@field nocache boolean
          ---@field index number
          ---@field modified boolean
          ---@field interval number|nil
          ---@field onAdd fun(self: system, entity:entity)|nil
          ---@field onRemove fun(self: system, entity:entity)|nil
          ---@field onModify fun(dt:number)|nil
          ---@field onAddToWorld fun(self: system, world:world)|nil
          ---@field onRemoveFromWorld fun(self: system, world:world)|nil
          ---@field preWrap fun(dt:number)|nil
          ---@field postWrap fun()|nil
          ---@field update fun(dt:number)|nil
          ---@field preProcess fun(dt:number)|nil

This file has been truncated. show original

Ivan · September 14, 2024, 6:32pm

That is great, thank you! How can I put those annotations on the library and load them whenever the “tinyecs.tiny” file is loaded?

Insality · September 15, 2024, 7:16pm

Well, it is interested question how to make the library annotations are comfortable for everyone. I’m still not found which way is the best, there are several ways to do it.

Annotations are required to find type checking errors in the code faster and better code navigation

I’m using annotations in:

Defold Editor
Defold Kit (VS Code)
Any IDE + Lua Language Server (LLS)
I don’t use annotations

0 voters

The fully source annotated files is the best way for the Defold Kit or Defold Editor with new LLS. The Defold Kit can unpack the dependencies to make work “Go To Definition” function to the library code.

But for IDE with Lua Language Server there are two ways: copy source code or copy just “API Reference” like this annotations. So this kind of file I expected to see at /annotations/tinyecs/tiny.lua here.

Ivan · September 16, 2024, 12:55pm

I would use your annotations and make a pull request to the original repo, but it has PRs sitting there for 2 years already. I think I will add it just to my repo instead.