Merge pull request #2 from Insality/develop

Develop

Author: Insality

.github/workflows/ci_workflow.yml

@@ -14,15 +14,15 @@ jobs:
           - uses: actions/setup-java@v3
             with:
                 distribution: 'zulu'
-                java-version: '17'
+                java-version: '21'
 
           - name: Build && Run
             run: |
-              deployer_url="https://raw.githubusercontent.com/Insality/defold-deployer/4/deployer.sh"
+              deployer_url="https://raw.githubusercontent.com/Insality/defold-deployer/1/deployer.sh"
               curl -s ${deployer_url} | bash -s lbd --headless --settings ./test/test.ini
 
           - name: Upload coverage reports to Codecov
             uses: codecov/codecov-action@v4.0.1
             with:
               token: ${{ secrets.CODECOV_TOKEN }}
-              slug: insality/decore
+              slug: insality/decore

.gitignore

@@ -10,4 +10,5 @@ deployer_build_stats.csv
 bob*.jar
 manifest.*.der
 /.editor_settings
-lls_export.json
+lls_export.json
+deployer_version_settings.ini

.vscode/settings.json

@@ -57,7 +57,8 @@
 		"~/Library/Application Support/Code/User/globalStorage/astronachos.defold",
 		"~/Library/Application Support/Code/User/workspaceStorage/d5f9bf017bc262ec86a14da3c3f3032d/astronachos.defold",
 		"~/Library/Application Support/Cursor/User/globalStorage/astronachos.defold",
-		"~/Library/Application Support/Cursor/User/workspaceStorage/d5f9bf017bc262ec86a14da3c3f3032d/astronachos.defold"
+		"~/Library/Application Support/Cursor/User/workspaceStorage/d5f9bf017bc262ec86a14da3c3f3032d/astronachos.defold",
+		"~/Library/Application Support/Cursor/User/workspaceStorage/98e90effb1b63af519b5132f34e59df1/astronachos.defold"
 	],
 	"Lua.workspace.ignorePatterns": [
 		"**/*.md"

README.md

@@ -14,30 +14,66 @@ The library in development stage. May be not fully tested and README may be not
 
 # Decore
 
-**Decore** - a Defold library for managing ECS game entities and components in a data-driven way. It provides functionality for creating and managing game entities with their components.
+**Decore** - a Defold library for managing ECS game entities and components in a data-driven way. The ECS is based on [tiny ECS](https://github.com/bakpakin/tiny-ecs) library.
 
 ## Features
 
-* **Entity Management**: Create and manage game entities
+* **Entity Management**: Register, create and manage game entities
 * **Component Management**: Add, remove and update entity components
 * **Easy Integration**: Simple setup and integration with Defold projects
 
 ## Installation
 
 Add in your `game.project` dependencies:
 ```
-https://github.com/Insality/decore/archive/refs/tags/1.zip
+https://github.com/Insality/decore/archive/refs/tags/2.zip
 ```
 
+### Basic Usage
+
+```lua
+local decore = require("decore.decore")
+
+function init(self)
+	local world = decore.new_world(
+		require("system.input.system_input").create(),
+		require("system.transform.system_transform").create(),
+		require("system.game_object.system_game_object").create(),
+	)
+
+	decore.register_entities("game", {
+		["player"] = require("entity.player.player_entity")
+	})
+
+	world:addEntity(decore.create_prefab("player"))
+end
+
+function update(self, dt)
+	self.world:update(dt)
+end
+
+
+function on_input(self, action_id, action)
+	return self.world.input:on_input(action_id, action)
+end
+
+
+function final(self)
+	self.world:clearEntities()
+	self.world:clearSystems()
+end
+```
+
+
 ## Quick API Reference
 
 ```lua
 local decore = require("decore.decore")
 
-decore.world(...)
+decore.new_world(...)
 decore.on_input(world, action_id, action)
 decore.on_message(world, message_id, [message], [sender])
-decore.final([world])
+decore.final(world)
 
 decore.system(system_module, system_id, [require_all_filters])
 decore.processing_system(system_module, system_id, [require_all_filters])
@@ -48,26 +84,30 @@ decore.register_entity(entity_id, entity_data, [pack_id])
 decore.register_entities(pack_id, entities)
 decore.unregister_entities(pack_id)
 
+decore.create([components])
+decore.create_prefab([prefab_id], [pack_id], [components])
+
 decore.register_component(component_id, [component_data], [pack_id])
-decore.register_components(components_data_or_path)
+decore.register_components(components_data)
 decore.unregister_components(pack_id)
 
-decore.create_entity([prefab_id], [pack_id], [data])
 decore.create_component(component_id, [component_pack_id])
 decore.apply_component(entity, component_id, [component_data])
 decore.apply_components(entity, [components])
 
 decore.get_entity_by_id(world, id)
-decore.find_entities_by_component_value(world, component_id, [component_value])
-decore.is_alive(world_or_system, entity)
+decore.find_entities(world, component_id, [component_value])
 
 decore.print_loaded_packs_debug_info()
 decore.print_loaded_systems_debug_info(world)
-decore.parse_command(command)
+
+decore.parse_command(command_string)
 decore.call_command(world, [command])
 
 decore.set_logger([logger_instance])
-decore.get_logger(name, [level])
+decore.get_logger([name], [level])
+
+decore.render_properties_panel(world, druid, properties_panel)
 ```
 
 ## License