sscharter 0.5.1 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cf8712de608bd077ecf7de07876ffeeda198252406ed21039e8877e4ef3b0a2
-  data.tar.gz: 25ee7a29c99c52c5bccf381cf876ef1b392e09ad654f3aae5765ddf8c4e32a44
+  metadata.gz: 10b5abf2310eeeec8d15d4e26b0bb052057af5a7ec1f8831775fce9c1c824a3e
+  data.tar.gz: edab85fb7449400947f30c182aa4c6be2ce1ba1e968a19a921fdabee4a406ba9
 SHA512:
-  metadata.gz: 05d2ddfa497d740bdda3e6011baa155bb9836d6e64d5448557db89a6dc7ff9aefcc47a251c1e6bc171ede0fa4c85898b7a5c1949c403b7d602b51aba6896beca
-  data.tar.gz: 5c54bfc3a2b9ccefc1f8f08085f98ed9abd13bf938b19e60c08967e503483999a8f02447a4a17a976b825ba1dc048c814107740078072eecba6e22790f96f42c
+  metadata.gz: 31f6c6ff5a7fa1eb08af770131617d32dac68d639b63f0d5ac0f6795c0eeaed1b420d206b1c042d7f8e9975c0dc5911b88c595f668765b99e222d010ad4822da
+  data.tar.gz: 5da054dfbf70f06d23eb9b13cccd1efd454f455e9a1fc53c709f959c354acfb2f8ec38b5f6dab164a6cc42e4cfa37612d4836342ef3f9fc2e46e52f786ec2ca3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sscharter (0.5.1)
+    sscharter (0.5.4)
       filewatcher (~> 2.0)
       launchy (~> 2.5)
       rubyzip (~> 2.3)
@@ -10,16 +10,16 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.5)
+    addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
     filewatcher (2.1.0)
       module_methods (~> 0.1.0)
     launchy (2.5.2)
       addressable (~> 2.8)
-    minitest (5.20.0)
+    minitest (5.22.3)
     module_methods (0.1.0)
-    public_suffix (5.0.3)
-    rake (13.0.6)
+    public_suffix (5.0.4)
+    rake (13.1.0)
     rubyzip (2.3.2)
     webrick (1.8.1)
 
@@ -36,4 +36,4 @@ DEPENDENCIES
   webrick (~> 1.8)
 
 BUNDLED WITH
-   2.4.13
+   2.5.4

data/lib/sscharter/version.rb

@@ -2,6 +2,6 @@
 
 module Sunniesnow
 	class Charter
-		VERSION = "0.5.1"
+		VERSION = "0.5.4"
 	end
 end

data/lib/sscharter.rb

@@ -275,7 +275,7 @@ class Sunniesnow::Charter
 		hard: '#e75e74',
 		master: '#8c68f3',
 		special: '#f156ee'
-	}
+	}.freeze
 
 	DIRECTIONS = {
 		right: 0.0,
@@ -287,6 +287,19 @@ class Sunniesnow::Charter
 		down: -Math::PI / 2,
 		down_right: -Math::PI / 4
 	}
+	{
+		right: %i[r],
+		up_right: %i[ur ru],
+		up: %i[u],
+		up_left: %i[ul lu],
+		left: %i[l],
+		down_left: %i[dl ld],
+		down: %i[d],
+		down_right: %i[dr rd]
+	}.each do |direction_name, aliases|
+		aliases.each { DIRECTIONS[_1] = DIRECTIONS[direction_name] }
+	end
+	DIRECTIONS.freeze
 
 	singleton_class.attr_reader :charts
 	@charts = {}
@@ -307,6 +320,7 @@ class Sunniesnow::Charter
 		@difficulty_name = ''
 		@difficulty_color = '#000000'
 		@difficulty = ''
+		@difficulty_sup = ''
 		@title = ''
 		@artist = ''
 		@charter = ''

data/tutorial/tutorial.md

@@ -163,6 +163,7 @@ charter 'Your name'
 difficulty_name 'Master'
 difficulty_color '#8c68f3'
 difficulty '12'
+difficulty_sup '+' # optional
 
 offset 0
 bpm 120
@@ -220,6 +221,24 @@ If you need to change the port to 1314 for example, you need to run
 bundle exec sscharter serve 1314
 ```
 
+> [!TIP]
+> The default settings of Sunniesnow are tuned for gameplay instead of charting,
+> so you may want to change some settings to help you write the chart.
+> Here are some useful settings:
+>
+> - Enable [`autoplay`](https://sunniesnow.github.io/game/help.html#autoplay).
+> - Disable [`fullscreen-on-start`](https://sunniesnow.github.io/game/help.html#fullscreen-on-start).
+>   Fullscreen is good for gamplay but is disturbing for charting.
+> - Enable [`debug`](https://sunniesnow.github.io/game/help.html#debug),
+>   and you can see the current progress of the music, the judgement region of notes,
+>   the coordinates of where you click your mouse, etc.
+> - Use the option [`start`](https://sunniesnow.github.io/game/help.html#start)
+>   to start the music at a certain time.
+>   You can use the progress you got from debug mode UI to set it.
+> - Enable [`se-with-music`](https://sunniesnow.github.io/game/help.html#se-with-music)
+>   and set [`chart-offset`](https://sunniesnow.github.io/game/help.html#chart-offset) to zero.
+>   This will make sure the timing of sound effects is precise no matter how much latency your computer has.
+
 ## What does each line in `src/master.rb` mean?
 
 Now, you are ready to write the chart!
@@ -248,6 +267,7 @@ charter 'Your name'
 difficulty_name 'Master'
 difficulty_color '#8c68f3'
 difficulty '12'
+difficulty_sup '+' # optional
 ```
 
 These lines are the metadata of the chart.
@@ -503,13 +523,22 @@ Here is a list of all the note types you can use:
 | flick | `flick x, y, direction, text=""` | `f` |
 | background note | `bg_note x, y, duration_beats=0, text=""` | |
 
-Here are some notices:
+The duration of a background note can be zero, but that of a hold note cannot.
 
-- The direction of a flick note can be a number specifying the angle in **radians**
+The direction of a flick note can be a number specifying the angle in **radians**
 (zero is to the right, and increasing angle is counterclockwise),
-or it can be one of the following 8 symbols:
-`:right`, `:up_right`, `:up`, `:up_left`, `:left`, `:down_left`, `:down`, `:down_right`.
-- The duration of a background note can be zero, but that of a hold note cannot.
+or it can be one of the following symbols:
+
+| Symbol | Direction |
+|-|-|
+| `:right`, `:r` | $0$ |
+| `:up_right`, `:ur`, `:ru` | $\pi/4$ |
+| `:up`, `:u` | $\pi/2$ |
+| `:up_left`, `:ul`, `:lu` | $3\pi/4$ |
+| `:left`, `:l` | $\pi$ |
+| `:down_left`, `:dl`, `:ld` | $-3\pi/4$ |
+| `:down`, `:d` | $-\pi/2$ |
+| `:down_right`, `:dr`, `:rd` | $-\pi/4$ |
 
 > Here is another notice for those who are not familiar with Ruby.
 > In Ruby, the parentheses around the arguments of a method call can be omitted.
@@ -552,7 +581,7 @@ If you see something similar, congratulations!
 
 ### Background patterns
 
-There are totally 7 different kinds of background patterns:
+There are totally 8 different kinds of background patterns:
 
 | Pattern | Syntax |
 |-|-|
@@ -569,8 +598,9 @@ Most of them only has one optional argument, specifying the duration.
 The big text is different in that it needs an additional required argument,
 specifying the contents of the texts.
 
-The mathematical details about the shapes of these patterns are
-specified in [the documentation](https://sunniesnow.github.io/doc/chart.html).
+> [!NOTE]
+> The mathematical details about the shapes of these patterns are
+> specified in [the documentation](https://sunniesnow.github.io/doc/chart.html).
 
 You may now try adding a grid pattern to the chart:
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sscharter
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.4
 platform: ruby
 authors:
 - Ulysses Zhan
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-27 00:00:00.000000000 Z
+date: 2024-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -94,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-description: 
+description:
 email:
 - ulysseszhan@gmail.com
 executables:
@@ -120,7 +120,7 @@ licenses: []
 metadata:
   homepage_uri: https://github.com/sunniesnow/sscharter
   source_code_uri: https://github.com/sunniesnow/sscharter
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.22
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A Ruby DSL for writing Sunniesnow charts
 test_files: []