osb 1.1.0 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +3 -0
  3. data/README.md +64 -0
  4. metadata +4 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bfa8c9fd46a2c0c25b5ae9b9d88d1043e2f16a74b01ff0ae1f8f7561d448f7f0
4
- data.tar.gz: 44a5c46b92e37bdb8f8f5694e8da2b28dabecc77d27793d43b15238ddc97382c
3
+ metadata.gz: 9ac326d1ca7ffd249550ff8762b4b8f1f3a56aad69dd567a5f4146938ae9ca70
4
+ data.tar.gz: e832ae17332a76d259c2813da3d5f602945bf9017f00080539042d7225caa029
5
5
  SHA512:
6
- metadata.gz: 96064b59c3bbca5233109df31a39cf1867a1c598bfdb4f5583f992af578d43c9b4659c46f81ef8fcedd870e112aaa415bc27e88c290025700d8f7ea35a26e812
7
- data.tar.gz: 601067ee4dd65cd6781b0a8719e988b5ba4f7888760a9dc4069b1d5369bfe497358314cf97ed01b3be9aee48a6cca0368e9bd6d0b31e59b930be818ba8be920b
6
+ metadata.gz: 1620c4004ef265061b2060969b115d02c28d848dd9f99cf1f3ef9045d3a5ce809025266a1637dbf19c72201d9c56dd10f618af81a8fede0cfe7caf8fca53962f
7
+ data.tar.gz: af61c900d6ced4c4f19007a1b569e96fcd089f64e9f2f2a8503095746ad195c5334a0abd847ef98d8bc75558afb16f7bb874f9ad063b1213370d40ddc2962d7c
data/.yardopts ADDED
@@ -0,0 +1,3 @@
1
+ --no-private
2
+ -
3
+ README.md
data/README.md ADDED
@@ -0,0 +1,64 @@
1
+ # osb
2
+ A simple osu! storyboard framework written in Ruby.
3
+
4
+ ## Installation
5
+
6
+ Install with Gem:
7
+ ```sh
8
+ gem install osb
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ Create a storyboard container:
14
+ ```rb
15
+ require "osb"
16
+ include Osb
17
+ sb = Storyboard.new
18
+ ```
19
+
20
+ Create a static image:
21
+ ```rb
22
+ sp = Sprite.new(file_path: "test.png")
23
+ ```
24
+
25
+ Describe what it does:
26
+ ```rb
27
+ sp.fade(start_time: 1000, start_opacity: 1)
28
+ sp.move(start_time: 2000, start_position: [320, 640], end_position: [100, 100])
29
+ sp.scale(start_time: 100, end_time: 200, start_scale: 1, end_scale: 2)
30
+ ```
31
+
32
+ Add it to the container:
33
+ ```rb
34
+ sb << sp
35
+ ```
36
+
37
+ Generate your storyboard file:
38
+ ```rb
39
+ sb.generate("path/to/your_storyboard_file.osb")
40
+ ```
41
+
42
+ osb also supports DSL syntax.
43
+
44
+ ```rb
45
+ storyboard do
46
+ out_path "path/to/your_storyboard_file.osb"
47
+
48
+ sprite file_path: "test.png" do
49
+ fade start_time: 1000, start_opacity: 1
50
+
51
+ move start_time: 2000, start_position: [320, 640], end_position: [100, 100]
52
+ end
53
+ end
54
+ ```
55
+
56
+ Full documentation is available at https://rubydoc.info/gems/osb/index.
57
+
58
+ ## Contributing
59
+
60
+ Bug reports and pull requests are welcome on GitHub at https://github.com/nanachi-code/osb-ruby.
61
+
62
+ ## License
63
+
64
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: osb
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.0
4
+ version: 1.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Dinh Vu
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-08-21 00:00:00.000000000 Z
11
+ date: 2023-08-23 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description: A simple framework for building osu! storyboard.
14
14
  email: dinhvu2509@gmail.com
@@ -16,6 +16,8 @@ executables: []
16
16
  extensions: []
17
17
  extra_rdoc_files: []
18
18
  files:
19
+ - ".yardopts"
20
+ - README.md
19
21
  - lib/osb.rb
20
22
  - lib/osb/animation.rb
21
23
  - lib/osb/assert.rb