Skip to content

alchemist/alchemist-ecsrx

Repository files navigation

Alchemist EcsRx Plugin

Provides EcsRx related projects, nodes and code generation templates to Alchemist.

alchemist-image

Npm Version Npm Downloads Join Discord Chat

For more about Alchemist go look at: Alchemist Application

What does the plugin do?

Allows creation of EcsRx related projects/nodes etc, such as:

Projects

  • EcsRx Class Library (Creates an EcsRx class library project for .net core)

Nodes

  • EventNode (Creates an Event class)
  • ModelNode (Creates a simple POCO class)
  • ComponentNode (Creates an EcsRx Component)
  • GroupNode (Creates an EcsRx Group)
  • ConverntionSystemNode (Creates an EcsRx system based upon conventions)
  • ManualSystemNode (Creates an EcsRx manual system)

Helper Components

  • ComponentSection (Allows sections of components)
  • ReactivePropertiesSection (Builds on top of the dotnet property section but adds reactive types)
  • SystemsSection (Allows sections for systems)

How do I use it?

If you are developing on top of the library then add the dependency to @alchemist/ecsrx.

For using with alchemist application do the following plugin setup:

  • Create a ecsrx folder within alchemist plugins directory
  • Put the index.js file into the ecsrx directory
  • Run alchemist

The plugin should be picked up, and allow you to create EcsRx projects, it does depend upon @alchemist/dotnet plugin.

Blurb

This library is still very much a work in progress so the docs will be sparse and if you want to know more head on over to the discord channel.