osb 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfa8c9fd46a2c0c25b5ae9b9d88d1043e2f16a74b01ff0ae1f8f7561d448f7f0
-  data.tar.gz: 44a5c46b92e37bdb8f8f5694e8da2b28dabecc77d27793d43b15238ddc97382c
+  metadata.gz: 9ac326d1ca7ffd249550ff8762b4b8f1f3a56aad69dd567a5f4146938ae9ca70
+  data.tar.gz: e832ae17332a76d259c2813da3d5f602945bf9017f00080539042d7225caa029
 SHA512:
-  metadata.gz: 96064b59c3bbca5233109df31a39cf1867a1c598bfdb4f5583f992af578d43c9b4659c46f81ef8fcedd870e112aaa415bc27e88c290025700d8f7ea35a26e812
-  data.tar.gz: 601067ee4dd65cd6781b0a8719e988b5ba4f7888760a9dc4069b1d5369bfe497358314cf97ed01b3be9aee48a6cca0368e9bd6d0b31e59b930be818ba8be920b
+  metadata.gz: 1620c4004ef265061b2060969b115d02c28d848dd9f99cf1f3ef9045d3a5ce809025266a1637dbf19c72201d9c56dd10f618af81a8fede0cfe7caf8fca53962f
+  data.tar.gz: af61c900d6ced4c4f19007a1b569e96fcd089f64e9f2f2a8503095746ad195c5334a0abd847ef98d8bc75558afb16f7bb874f9ad063b1213370d40ddc2962d7c

data/.yardopts

@@ -0,0 +1,3 @@
+--no-private
+-
+README.md

data/README.md

@@ -0,0 +1,64 @@
+# osb
+A simple osu! storyboard framework written in Ruby.
+
+## Installation
+
+Install with Gem:
+```sh
+gem install osb
+```
+
+## Usage
+
+Create a storyboard container:
+```rb
+require "osb"
+include Osb
+sb = Storyboard.new
+```
+
+Create a static image:
+```rb
+sp = Sprite.new(file_path: "test.png")
+```
+
+Describe what it does:
+```rb
+sp.fade(start_time: 1000, start_opacity: 1)
+sp.move(start_time: 2000, start_position: [320, 640], end_position: [100, 100])
+sp.scale(start_time: 100, end_time: 200, start_scale: 1, end_scale: 2)
+```
+
+Add it to the container:
+```rb
+sb << sp
+```
+
+Generate your storyboard file:
+```rb
+sb.generate("path/to/your_storyboard_file.osb")
+```
+
+osb also supports DSL syntax.
+
+```rb
+storyboard do
+  out_path "path/to/your_storyboard_file.osb"
+
+  sprite file_path: "test.png" do
+    fade start_time: 1000, start_opacity: 1
+    
+    move start_time: 2000, start_position: [320, 640], end_position: [100, 100]
+  end
+end
+```
+
+Full documentation is available at https://rubydoc.info/gems/osb/index.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nanachi-code/osb-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osb
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Dinh Vu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-21 00:00:00.000000000 Z
+date: 2023-08-23 00:00:00.000000000 Z
 dependencies: []
 description: A simple framework for building osu! storyboard.
 email: dinhvu2509@gmail.com
@@ -16,6 +16,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
+- README.md
 - lib/osb.rb
 - lib/osb/animation.rb
 - lib/osb/assert.rb