draco 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fabf6d184411f5d8dc5782499dfd2e7d07174333f6927566fb3fe51d59ae0df3
-  data.tar.gz: 5a647308729162793c8d4841b86f954298640d319dbfa836f8cb072f491c04cb
+  metadata.gz: 363ccf9c3649a752219bca392bdc13b88defbd864a63afb5615969986e59c070
+  data.tar.gz: 81dcbc8225646cec6efc357ecaacfd89334e9a183caad035cf4bd2ece9a01470
 SHA512:
-  metadata.gz: 6e754598051acec8e35c62d40d52c255bf2187fa68b6e2e18112de90661af7faa53b9bb7fc402b8425df99bac3fb6d9d6a3cf15dabb0f956004dd43a63d04ae7
-  data.tar.gz: a558139ee8f227e9307c406453b18a5280ceac36ee0386fbd3998eebfe975cb0fc6e21effff52292aab4b594fbef56498a69623aa75586d6229a0b34740613a2
+  metadata.gz: aa089a7a6abe9b615d07e8def023fad13fedcbca605e78bc1acf181431b1659961811074a9238f79702b7e1e9ddd76782a173fd079ed5f7ae04a2ee83905c660
+  data.tar.gz: e6a70346719b8cf5e5269924158bcbad7ed4ea66440686c57931b7dc6232d467adf6abeac5740970e6d16a573d61a66af27c5626599ed115a7a87624d9ac9bdf

data/.github/workflows/ruby.yml

@@ -22,8 +22,7 @@ jobs:
       - name: Set up Ruby
         # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
         # change this to (see https://github.com/ruby/setup-ruby#versioning):
-        # uses: ruby/setup-ruby@v1
-        uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6
       - name: Install dependencies

data/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
   NewCops: enable
   Exclude:
     - "benchmark.rb"
+    - "samples/**/*.rb"
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.5.0 (December 31, 2020)
+
+Features:
+
+  - Add `Draco::Tag` to easily define tag components [#6](https://github.com/guitsaru/draco/pull/6)

data/README.md

@@ -6,12 +6,36 @@ An Entity Component System is an architectural framework that decouples game obj
 build game objects through composition. This allows you to easily share small logic components between different game
 objects.
 
+## Sample Application
+
+This repository includes a sample application in `samples/teeny-tiny`.
+
+### Running the sample application
+
+1. Download the [latest release](https://github.com/guitsaru/draco/archive/main.zip) of this repository.
+2. Create a copy of DragonRuby GTK in a new folder.
+3. Copy the teeny-tiny directory from draco into your new DragonRuby GTK folder. `cp -r draco/samples/teeny-tiny dragonruby/teeny-tiny`.
+4. Run it using `./dragonruby teeny-tiny`.
+
 ## Installation
 
 1. Create a `lib` directory inside your game's `app` directory.
 2. Copy `lib/draco.rb` into your new `lib` directory.
 3. In your `main.rb` file, require `app/lib/draco.rb`.
 
+## Support
+
+- Find a bug? [Open an issue](https://github.com/guitsaru/draco/issues).
+- Need help? [Start a Discussion](https://github.com/guitsaru/draco/discussions) or [Join us in Discord: Channel #oss-draco](https://discord.gg/vPUNtwfm).
+
+## Versioning
+
+Draco uses [https://semver.org/].
+
+* Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+* Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
+* Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+
 ## Usage
 
 ### Components
@@ -23,7 +47,7 @@ These can be shared across many different types of game objects.
 class Visible < Draco::Component; end
 ```
 
-`Visible` is an example of a label component. An entity either has it, or it doesn't. We can also associate data with our
+`Visible` is an example of a tag component. An entity either has it, or it doesn't. We can also associate data with our
 components.
 
 ```ruby
@@ -44,6 +68,16 @@ component.x
 # => 110
 ```
 
+#### Tag Components
+
+The `Visible` class above is an example of a tag component. These are common enough that we don't necessarily want to
+define a bunch of empty component classes. Draco provides a way to generate these classes at runtime.
+
+```ruby
+Draco::Tag(:visible)
+# => Visible
+```
+
 ### Entities
 
 Entities are independant game objects. They consist of a unique id and a list of components.
@@ -129,6 +163,40 @@ world.systems << RenderSpriteSystem
 world.tick(args)
 ```
 
+Just like with entities, we can define a subclassed template for our world.
+
+```ruby
+class Overworld < Draco::World
+  entity Goblin
+  entity Player, position: { x: 50, y: 50 }, as: :player
+  systems RenderSpriteSystem, InputSystem
+end
+
+world = Overworld.new
+```
+
+### Named Entities
+
+If there are entities that are frequently accessed in our systems, we can give these a name. In the above example, our
+player entity has been given the name `player`. We can now access this directly from our world:
+
+```ruby
+world.player
+```
+
+### Fetching entities by id
+
+In some cases you'll want to keep track of entities by their id, such as when you want to keep track of another entity in a component.
+
+```ruby
+entity = Player.new
+entity.id
+# => 12
+
+world.entities[12] == entity
+# => true
+```
+
 ## Learn More
 
 Here are some good resources to learn about Entity Component Systems
@@ -140,6 +208,8 @@ Here are some good resources to learn about Entity Component Systems
 
 Draco is licensed under AGPL. You can purchase the right to use Draco under the [commercial license](https://github.com/guitsaru/draco/blob/master/COMM-LICENSE).
 
+Each purchase comes with free upgrades for the current major version of Draco.
+
 <a class="gumroad-button" href="https://guitsaru.itch.io/draco" target="_blank">Purchase Commercial License</a>
 
 ## Development

data/draco.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|samples)/}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/lib/draco.rb

@@ -5,7 +5,7 @@
 # An Entity Component System is an architectural pattern used in game development to decouple behavior from objects.
 module Draco
   # Public: The version of the library. Draco uses semver to version releases.
-  VERSION = "0.2.0"
+  VERSION = "0.5.0"
 
   # Public: A general purpose game object that consists of a unique id and a collection of Components.
   class Entity
@@ -39,8 +39,8 @@ module Draco
       @default_components[component] = defaults
     end
 
-    # Internal: Returns the default components for the class.
     class << self
+      # Internal: Returns the default components for the class.
       attr_reader :default_components
     end
 
@@ -300,6 +300,23 @@ module Draco
     end
   end
 
+  # Internal: Empty module to enable Tag() method.
+  module Tag; end
+
+  # Public: Creates a new empty component at runtime. If the given Class already exists, it reuses the existing Class.
+  #
+  # name - The symbol or string name of the component. It can be either camelcase or underscored.
+  #
+  # Returns a Class with superclass of Draco::Component.
+  def self.Tag(name) # rubocop:disable Naming/MethodName
+    klass_name = camelize(name)
+
+    return Object.const_get(klass_name) if Object.const_defined?(klass_name)
+
+    klass = Class.new(Component)
+    Object.const_set(klass_name, klass)
+  end
+
   # Public: Systems contain the logic of the game.
   # The System runs on each tick and manipulates the Entities in the World.
   class System
@@ -373,6 +390,62 @@ module Draco
 
   # Public: The container for current Entities and Systems.
   class World
+    @default_entities = []
+    @default_systems = []
+
+    # Internal: Resets the default components for each class that inherites Entity.
+    #
+    # sub - The class that is inheriting Entity.
+    #
+    # Returns nothing.
+    def self.inherited(sub)
+      super
+      sub.instance_variable_set(:@default_entities, [])
+      sub.instance_variable_set(:@default_systems, [])
+    end
+
+    # Public: Adds a default Entity to the World.
+    #
+    # entity - The class of the Entity to add by default.
+    # defaults - The Hash of default values for the Entity. (default: {})
+    #
+    # Examples
+    #
+    #   entity(Player)
+    #
+    #   entity(Player, position: { x: 0, y: 0 })
+    #
+    # Returns nothing.
+    def self.entity(entity, defaults = {})
+      name = defaults[:as]
+      @default_entities.push([entity, defaults])
+
+      attr_reader(name.to_sym) if name
+    end
+
+    # Public: Adds default Systems to the World.
+    #
+    # systems - The System or Array list of System classes to add to the World.
+    #
+    # Examples
+    #
+    #   systems(RenderSprites)
+    #
+    #   systems(RenderSprites, RenderLabels)
+    #
+    # Returns nothing.
+    def self.systems(*systems)
+      @default_systems += Array(systems).flatten
+    end
+
+    class << self
+      # Internal: Returns the default Entities for the class.
+      attr_reader :default_entities
+
+      # Internal: Returns the default Systems for the class.
+      attr_reader :default_systems
+    end
+
     # Public: Returns the Array of Systems.
     attr_reader :systems
 
@@ -384,8 +457,17 @@ module Draco
     # entities - The Array of Entities for the World (default: []).
     # systems - The Array of System Classes for the World (default: []).
     def initialize(entities: [], systems: [])
-      @entities = EntityStore.new(entities)
-      @systems = systems
+      default_entities = self.class.default_entities.map do |default|
+        klass, attributes = default
+        name = attributes[:as]
+        entity = klass.new(attributes)
+        instance_variable_set("@#{name}", entity) if name
+
+        entity
+      end
+
+      @entities = EntityStore.new(default_entities + entities)
+      @systems = self.class.default_systems + systems
     end
 
     # Public: Runs all of the Systems every tick.
@@ -440,22 +522,36 @@ module Draco
       def initialize(*entities)
         @entity_to_components = Hash.new { |hash, key| hash[key] = Set.new }
         @component_to_entities = Hash.new { |hash, key| hash[key] = Set.new }
+        @entity_ids = {}
 
         self << entities
       end
 
-      # Internal: Gets all Entities that implement all of the given Components
+      # Internal: Gets all Entities that implement all of the given Components or that match the given entity ids.
       #
-      # components - The Component Classes to filter by
+      # components_or_ids - The Component Classes to filter by
       #
       # Returns a Set list of Entities
-      def [](*components)
-        components
+      def [](*components_or_ids)
+        components_or_ids
           .flatten
-          .map { |component| @component_to_entities[component] }
+          .map { |component_or_id| select_entities(component_or_id) }
           .reduce { |acc, i| i & acc }
       end
 
+      # Internal: Gets entities by component or id.
+      #
+      # component_or_id - The Component Class or entity id to select.
+      #
+      # Returns an Array of Entities.
+      def select_entities(component_or_id)
+        if component_or_id.is_a?(Numeric)
+          Array(@entity_ids[component_or_id])
+        else
+          @component_to_entities[component_or_id]
+        end
+      end
+
       # Internal: Adds Entities to the EntityStore
       #
       # entities - The Entity or Array list of Entities to add to the EntityStore.
@@ -474,6 +570,8 @@ module Draco
       def add(entity)
         entity.subscribe(self)
 
+        @entity_ids[entity.id] = entity
+
         components = entity.components.map(&:class)
         @entity_to_components[entity].merge(components)
 
@@ -490,9 +588,10 @@ module Draco
       #
       # Returns the EntityStore
       def delete(entity)
-        components = @entity_to_components.delete(entity)
+        @entity_ids.delete(entity.id)
+        components = Array(@entity_to_components.delete(entity))
 
-        components.map(&:class).each do |component|
+        components.each do |component|
           @component_to_entities[component].delete(entity)
         end
       end
@@ -642,13 +741,36 @@ module Draco
   #
   # Returns a String.
   def self.underscore(string)
-    string.split("::").last.bytes.map.with_index do |byte, i|
+    string.to_s.split("::").last.bytes.map.with_index do |byte, i|
       if byte > 64 && byte < 97
-        downcased = byte + 32 # gemspec
+        downcased = byte + 32
         i.zero? ? downcased.chr : "_#{downcased.chr}"
       else
         byte.chr
       end
     end.join
   end
+
+  # Internal: Converts an underscored string into a camel case string.
+  #
+  # Examples
+  #
+  #   camlize("camel_case")
+  #   # => "CamelCase"
+  #
+  # Returns a string.
+  def self.camelize(string) # rubocop:disable Metrics/MethodLength
+    modifier = -32
+
+    string.to_s.bytes.map do |byte|
+      if byte == 95
+        modifier = -32
+        nil
+      else
+        char = (byte + modifier).chr
+        modifier = 0
+        char
+      end
+    end.compact.join
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: draco
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Matt Pruitt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-08 00:00:00.000000000 Z
+date: 2020-12-31 00:00:00.000000000 Z
 dependencies: []
 description: A library for Entities, Components, and Systems in games.
 email:
@@ -22,6 +22,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - COMM-LICENSE
 - Gemfile