fantasy 0.1.11 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb68d8561352d746b2ccdbec94196c568436a0164619f325f0762c200d9d4a71
-  data.tar.gz: a11a5b19442edc60fc11d3c803ec40df543c9f1a176f7f7d6a3b11ad4dcf2eed
+  metadata.gz: 0d18d89b226d845f1a7f3a85ec0eb26efd18ad3d4820e35079b5d93bf2844fad
+  data.tar.gz: 60bf1ff81ec6fcec9a4225e0550dc110d6d0686742f4ac6e6611f8f1b7e43158
 SHA512:
-  metadata.gz: e705ad65f134cf775e3bf2ef847643bbd8a2efcc49630837f555f57df019573c9356190db394cddb647ed95420441ea0ce8d42099ba43f006c89e05b63452fa9
-  data.tar.gz: c6e6506581053c11940b0fd3bed2205ae4b003a2efd35016a84e04640cc75ad9300a8276ff8562ec8f33eba229b3017c7ba4f38306d165271d637e7c0e51b66a
+  metadata.gz: d2876e85b3def3d90aeb0ad7792a1cc56b6ef8a59c5a967827d5271a6fa13fcd053fa1d2008a2abc7cbd85e477c89ad224a5fac4640abb47ee0447de1d5349bd
+  data.tar.gz: 9c39646cebbfc0588b760604c89367022c5feb5c7d2836f1b68aa2c957790d5fce125b97f0ab3a49191234323bbccb3a0d638e6b359c45261f89bf2295e6b7cf

data/.rubocop.yml

@@ -10,4 +10,25 @@ Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
 
 Layout/LineLength:
-  Max: 120
+  Max: 180
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Naming/MethodParameterName:
+  AllowedNames: ["x", "y", "to", "r", "g", "b", "a", "up"]
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+Metrics/MethodLength:
+  Max: 15
+
+Style/AccessorGrouping:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Max: 180
+
+Metrics/ClassLength:
+  Max: 180

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private - README.md CHANGELOG.md
+--markup markdown
+--markup-provider redcarpet
+--output-dir docs

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [0.1.13] - 2022-04-01
+
+- Data Persistance: Disk module
+- Sound and Music support for volume configuration
+
+
 ## [0.1.11] - 2022-03-26
 
 - Better jumping and gravity physics

data/Gemfile

@@ -7,6 +7,6 @@ ruby ">= 3.0.0"
 # Specify your gem's dependencies in fantasy.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
 gem "minitest", "~> 5.0"
+gem "rake", "~> 13.0"
 gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    fantasy (0.1.13)
+      gosu (~> 1.4.1)
+      vector2d (~> 2.2.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    contracts (0.9)
+    gosu (1.4.3)
+    minitest (5.15.0)
+    parallel (1.22.1)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rubocop (1.26.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+    vector2d (2.2.3)
+      contracts (~> 0.9.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  fantasy!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  yard
+
+RUBY VERSION
+   ruby 3.0.2p107
+
+BUNDLED WITH
+   2.2.32

data/README.md

@@ -96,7 +96,7 @@ Or install it yourself as:
 
 ## Features
 
-### Game Scene transitions
+### Game Scenes
 
 Easy to configure 3 basic game states:
 
@@ -209,7 +209,7 @@ Simple way to set up:
 - Image background
 - Repeatable image background
 
-### Data Persistance (TODO)
+### Data Persistance
 
 Simple mechanism to save data in disk. For user preferences, game progress, high scores and others
 
@@ -234,9 +234,13 @@ For easy creation of:
 
 Multiple movement animation effects like in [DoTween](http://dotween.demigiant.com/documentation.php) (TODO)
 
+### Externalized Variables (TODO)
+
+Values that can be changed while the game is running. They can be in a Variables file. The game "watch" this file and update the variable in real time.
+
 ## API
 
-### Game Scene transitions
+### Game Scenes
 
 Configure your game elements on each Scene:
 
@@ -314,8 +318,8 @@ player.on_collision do |other|
 end
 
 player.on_after_move do
-  if player.position.x > SCREEN_WIDTH
-    player.position.x = SCREEN_WIDTH
+  if player.position.x > Global.screen_width
+    player.position.x = Global.screen_width
   end
 
   if player.position.x < 0
@@ -339,13 +343,13 @@ class Player < Actor
     move_with_cursors
   end
 
-  on_collision do |other|
+  def on_collision_do(other)
     if other.name == "enemy"
       destroy
     end
   end
 
-  on_after_move do
+  def on_after_move_do
     if @position.x > SCREEN_WIDTH
       @position.x = SCREEN_WIDTH
     end
@@ -401,7 +405,7 @@ on_presentation do
 end
 
 # Replicable (by default) Image
-# position is relative to Global.camera
+# position is relative to Camera.main
 on_game do
   background = Background.new(image_name: "beach")
   # background.replicable = false # if you don't want the image to replicate
@@ -409,13 +413,28 @@ on_game do
 end
 ```
 
+### Data Persistance
+
+```ruby
+Disk.data.records = [120_000, 11_000, 678]
+Disk.data.last_level = 3
+Disk.data.sound_volume = 12
+Disk.save # data stored in ./disk/data.json
+
+# ... in another session
+
+Disk.data.records # => [120_000, 11_000, 678]
+Disk.data.last_level # => 3
+Disk.data.sound_volume # => 12
+```
+
 ### Camera
 
 ```ruby
 on_game do
   on_loop do
     # Camera follows player
-    Global.camera.position.y = player.position.y - (SCREEN_HEIGHT / 2)
+    Camera.main.position.y = player.position.y - (SCREEN_HEIGHT / 2)
   end
 end
 ```
@@ -440,10 +459,10 @@ Music.stop
 
 ```ruby
 # ./maps/sky.txt
-#0       0        0
-#    1          0
-#
-#0    0     0
+# 0     0
+#  0  1
+#   0   0
+# 0    01
 
 planet = Actor.new("planet")
 star = Actor.new("star")
@@ -486,6 +505,10 @@ Clock.new { icon.visible = !icon.visible }.repeat(seconds: 1)
 - Tests are missing
 - Allow Ruby 2.5+
 
+## Assets
+
+- Images for the test fixtures: https://kenney.nl/
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.