sscharter 0.9.0 → 0.10.1

data/lib/sscharter/charter/group.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+class Sunniesnow::Charter
+
+	# @note Internal API.
+	# @!parse
+	#   class GroupState < Data
+	#     # @return [Array<Symbol>]
+	#     attr_reader :tip_point_mode_stack
+	#     # @return [Array<Integer?>]
+	#     attr_reader :current_tip_point_stack
+	#     # @return [Array<Array<Event>>]
+	#     attr_reader :current_tip_point_group_stack
+	#     # @return [Integer]
+	#     attr_reader :current_duplicate
+	#     # @return [Array<TipPointStart?>]
+	#     attr_reader :tip_point_start_stack
+	#     # @return [Array<TipPointStart?>]
+	#     attr_reader :tip_point_start_to_add_stack
+	#     # @return [Array<Array<Event>>]
+	#     attr_reader :groups
+	#   end
+	GroupState = Sunniesnow::Utils::Data.define(
+		:tip_point_mode_stack, :current_tip_point_stack,
+		:current_tip_point_group_stack, :current_duplicate,
+		:tip_point_start_stack, :tip_point_start_to_add_stack, :groups
+	)
+
+	# @note Internal API.
+	# @!parse
+	#   class Bookmark < Data
+	#     # @return [BeatState]
+	#     attr_reader :beat_state
+	#     # @return [GroupState]
+	#     attr_reader :group_state
+	#   end
+	Bookmark = Sunniesnow::Utils::Data.define :beat_state, :group_state
+
+	# @note Internal API.
+	# @return [void]
+	def init_bookmarks
+		@bookmarks = {}
+		nil
+	end
+
+	# @note Internal API.
+	# @return [void]
+	def init_group_state
+		@tip_point_mode_stack = [:none]
+		@current_tip_point_stack = []
+		@current_tip_point_group_stack = []
+		@tip_point_peak = 0
+		@current_duplicate = 0
+		@tip_point_start_stack = [nil]
+		@tip_point_start_to_add_stack = [nil]
+		@groups = [@events]
+		nil
+	end
+
+	# @note Internal API.
+	# @return [GroupState]
+	def current_group_state
+		GroupState.new(
+			@tip_point_mode_stack.dup,
+			@current_tip_point_stack.dup,
+			@current_tip_point_group_stack.dup,
+			@current_duplicate,
+			@tip_point_start_stack.dup,
+			@tip_point_start_to_add_stack.dup,
+			@groups.dup
+		)
+	end
+
+	# @note Internal API.
+	# @param backup [GroupState]
+	# @return [void]
+	def restore_group_state backup
+		@tip_point_mode_stack = backup.tip_point_mode_stack
+		@current_tip_point_stack = backup.current_tip_point_stack
+		@current_tip_point_group_stack = backup.current_tip_point_group_stack
+		@current_duplicate = backup.current_duplicate
+		@tip_point_start_to_add_stack = backup.tip_point_start_to_add_stack
+		@groups = backup.groups
+		nil
+	end
+
+	# @!group DSL Methods
+
+	# @return [Array<Event>] the events created inside +block+.
+	# @yieldself [Charter] the same as +self+.
+	def group preserve_beat: true, &block
+		raise ArgumentError, 'no block given' unless block
+		@groups.push result = []
+		beat_backup = current_beat_state unless preserve_beat
+		instance_eval &block
+		restore_beat_state beat_backup unless preserve_beat
+		@groups.delete_if { result.equal? _1 }
+		result
+	end
+
+	# @param name [Object]
+	# @return [Object] +name+.
+	def mark name
+		@bookmarks[name] = Bookmark.new current_beat_state, current_group_state
+		name
+	end
+
+	# @return [Array<Event>]
+	# @yieldself [Charter] the same as +self+.
+	# @param name [Object] the name of the bookmark to jump to.
+	# @param goto_beat [Boolean]
+	# @param preserve_beat [Boolean]
+	# @param update_mark [Boolean]
+	def at name, goto_beat: true, preserve_beat: false, update_mark: false, &block
+		raise ArgumentError, 'no block given' unless block
+		raise ArgumentError, "unknown bookmark #{name}" unless bookmark = @bookmarks[name]
+		group_backup = current_group_state
+		beat_backup = current_beat_state unless preserve_beat
+		restore_group_state bookmark.group_state
+		restore_beat_state bookmark.beat_state if goto_beat
+		result = group &block
+		mark name if update_mark
+		restore_group_state group_backup
+		restore_beat_state beat_backup unless preserve_beat
+		result
+	end
+
+	# @!endgroup
+
+end

data/lib/sscharter/charter/metadata.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+class Sunniesnow::Charter
+
+	# Aliases for some colors that can be used with {#difficulty_color}.
+	COLORS = {
+		easy: '#3eb9fd',
+		normal: '#f19e56',
+		hard: '#e75e74',
+		master: '#8c68f3',
+		special: '#f156ee'
+	}.freeze
+
+	# @note Internal API.
+	# @return [void]
+	def init_chart_info
+		@difficulty_name = ''
+		@difficulty_color = '#000000'
+		@difficulty = ''
+		@difficulty_sup = ''
+		@title = ''
+		@artist = ''
+		@charter = ''
+		@events = []
+	end
+
+	# @!group DSL Methods
+
+	# Set the title of the music for the chart.
+	# This will be reflected in the return value of {#to_sunniesnow}.
+	# @see Sunniesnow::Chart#title
+	# @param title [String] the title of the music.
+	# @return [String] the title of the music, the same as the argument +title+.
+	# @raise [ArgumentError] if +title+ is not a String.
+	def title title
+		raise ArgumentError, 'title must be a string' unless title.is_a? String
+		@title = title
+	end
+
+	# Set the artist of the music for the chart.
+	# This will be reflected in the return value of {#to_sunniesnow}.
+	# @see Sunniesnow::Chart#artist
+	# @param artist [String] the artist of the music.
+	# @return [String] the artist of the music, the same as the argument +artist+.
+	# @raise [ArgumentError] if +artist+ is not a String.
+	def artist artist
+		raise ArgumentError, 'artist must be a string' unless artist.is_a? String
+		@artist = artist
+	end
+
+	# Set the name of the chart author for the chart.
+	# This will be reflected in the return value of {#to_sunniesnow}.
+	# @see Sunniesnow::Chart#charter
+	# @param charter [String] the name of the charter.
+	# @return [String] the name of the chart author, the same as the argument +charter+.
+	# @raise [ArgumentError] if +charter+ is not a String.
+	def charter charter
+		raise ArgumentError, 'charter must be a string' unless charter.is_a? String
+		@charter = charter
+	end
+
+	# Set the name of the difficulty for the chart.
+	# This will be reflected in the return value of {#to_sunniesnow}.
+	# @see Sunniesnow::Chart#difficulty_name
+	# @param difficulty_name [String] the name of the difficulty.
+	# @return [String] the name of the difficulty, the same as the argument +difficulty_name+.
+	# @raise [ArgumentError] if +difficulty_name+ is not a String.
+	def difficulty_name difficulty_name
+		raise ArgumentError, 'difficulty_name must be a string' unless difficulty_name.is_a? String
+		@difficulty_name = difficulty_name
+	end
+
+	# Set the color of the difficulty for the chart.
+	# This will be reflected in the return value of {#to_sunniesnow}.
+	#
+	# The argument +difficulty_color+ can be a color name (a key of {COLORS}),
+	# an RGB color in hexadecimal format (e.g. +'#8c68f3'+, +'#8CF'+),
+	# an RGB color in decimal format (e.g. +'rgb(140, 104, 243)'+),
+	# or an integer representing an RGB color (e.g. +0x8c68f3+).
+	# @see Sunniesnow::Chart#difficulty_color
+	# @param difficulty_color [Symbol, String, Integer] the color of the difficulty.
+	# @return [String] the color of the difficulty in hexadecimal format (e.g. +'#8c68f3'+).
+	# @raise [ArgumentError] if +difficulty_color+ is not a valid color format.
+	def difficulty_color difficulty_color
+		@difficulty_color = case difficulty_color
+		when Symbol
+			COLORS[difficulty_color]
+		when /^#[0-9a-fA-F]{6}$/
+			difficulty_color
+		when /^#[0-9a-fA-F]{3}$/
+			_, r, g, b = difficulty_color.chars
+			"##{r}#{r}#{g}#{g}#{b}#{b}"
+		when /^rgb\(\s*(\d+)\s*,\s*(\d+)\s*,\s*(\d+)\s*\)$/
+			r, g, b = $1, $2, $3
+			sprintf '#%02x%02x%02x', r.to_i, g.to_i, b.to_i
+		when Integer
+			sprintf '#%06x', difficulty_color % 0x1000000
+		else
+			raise ArgumentError, 'unknown format of difficulty_color'
+		end
+	end
+
+	# Set the difficulty level for the chart.
+	# This will be reflected in the return value of {#to_sunniesnow}.
+	#
+	# The argument +difficulty+ should be a string representing the difficulty level.
+	# Anything other than a string will be converted to a string using +to_s+.
+	# @see Sunniesnow::Chart#difficulty
+	# @param difficulty [String] the difficulty level.
+	# @return [String] the difficulty level (converted to a string).
+	def difficulty difficulty
+		@difficulty = difficulty.to_s
+	end
+
+	# Set the difficulty superscript for the chart.
+	# This will be reflected in the return value of {#to_sunniesnow}.
+	#
+	# The argument +difficulty_sup+ should be a string representing the difficulty superscript.
+	# Anything other than a string will be converted to a string using +to_s+.
+	# @see Sunniesnow::Chart#difficulty_sup
+	# @param difficulty_sup [String] the difficulty superscript.
+	# @return [String] the difficulty superscript (converted to a string).
+	def difficulty_sup difficulty_sup
+		@difficulty_sup = difficulty_sup.to_s
+	end
+
+	# @!endgroup
+
+end

data/lib/sscharter/charter/story_events.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'set'
+
+class Sunniesnow::Charter
+
+	using Sunniesnow::Utils
+
+	IMAGE_LAYER_ABOVE = %i[none background bg_pattern hud fx judgement_line bg_notes notes circles tip_points fx_front].freeze
+
+	IMAGE_LAYER_ABOVE_SET = IMAGE_LAYER_ABOVE.to_set.freeze
+
+	COORDINATE_SYSTEMS = %i[canvas chart].freeze
+
+	COORDINATE_SYSTEMS_SET = COORDINATE_SYSTEMS.to_set.freeze
+
+	# @!group DSL Methods
+
+	# Creates an image event.
+	# @param filename [String]
+	# @param x [Numeric]
+	# @param y [Numeric]
+	# @param duration_beats [Integer, Rational]
+	# @param width [Numeric]
+	# @param height [Numeric?]
+	# @param above [IMAGE_LAYER_ABOVE_SET?]
+	# @param coordinate_system [COORDINATE_SYSTEMS_SET?]
+	# @param mirrorable [Boolean?]
+	# @return [Event]
+	def image filename, x, y, duration_beats, width, height = nil, above: nil, coordinate_system: nil, mirrorable: nil
+		raise ArgumentError, 'filename must be a string' unless filename.is_a? String
+		raise ArgumentError, 'x and y must be numbers' unless x.is_a?(Numeric) && y.is_a?(Numeric)
+		raise ArgumentError, 'duration_beats must be a number' unless duration_beats.is_a? Numeric
+		raise ArgumentError, 'duration_beats must be non-negative' if duration_beats < 0
+		raise ArgumentError, 'width must be a number' unless width.is_a? Numeric
+		raise ArgumentError, 'height must be a number' if !height.nil? && !height.is_a?(Numeric)
+		raise ArgumentError, "unknown coordinate_system #{coordinate_system}" if !coordinate_system.nil? && !%i[chart screen].include?(coordinate_system)
+		warn 'Rational is recommended over Float for duration_beats' if duration_beats.is_a? Float
+		raise ArgumentError, "invalid above: #{above}" if !above.nil? && !IMAGE_LAYER_ABOVE_SET.include?(above)
+		raise ArgumentError, "invalid coordinate_system: #{coordinate_system}" if !coordinate_system.nil? && !COORDINATE_SYSTEMS_SET.include?(coordinate_system)
+		raise ArgumentError, "mirrorable must be a boolean" unless [nil, true, false].include? mirrorable
+		additional_properties = {}
+		additional_properties[:above] = above.snake_to_camel if above
+		additional_properties[:coordinate_system] = coordinate_system.snake_to_camel if coordinate_system
+		additional_properties[:mirrorable] = mirrorable unless mirrorable.nil?
+		additional_properties[:height] = height.to_f if height
+		event :image, duration_beats.to_r, filename: filename, x: x.to_f, y: y.to_f, width: width.to_f, **additional_properties
+	end
+
+	# TODO: other story events
+
+	# @!endgroup
+
+end

data/lib/sscharter/charter/tip_point.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+class Sunniesnow::Charter
+
+	# @note Internal API.
+	class TipPointStart
+
+		# @param relative [Boolean] whether the position at which a created tip point appears specified by the arguments +x+ and +y+
+		#   is relative to the first note it visits or absolute.
+		# @param x [Numeric] the x-coordinate of the position at which a created tip point appears, whether relative or absolute.
+		# @param y [Numeric] the y-coordinate of the position at which a created tip point appears, whether relative or absolute.
+		# @overload initialize x, y, relative_time, relative: true
+		#   @param relative_time [Numeric]
+		#   The time at which a created tip point appears is the time of the first note it visits minus +relative_time+.
+		# @overload initialize x, y, speed:, relative: true
+		#   @param speed [Numeric]
+		#   The time at which a created tip point appears is the time of the first note it visits minus
+		#   the distance between the note and the position where the tip point appears divided by +speed+.
+		# @overload initialize x, y, relative_beat:, relative: true
+		#   @param relative_beat [Rational, Integer]
+		#   The beat at which a created tip point appears is the beat of the first note it visits minus +relative_beat+.
+		# @overload initialize x, y, beat_speed:, relative: true
+		#   @param beat_speed [Numeric]
+		#   The beat at which a created tip point appears is the beat of the first note it visits minus
+		#   the distance between the note and the position where the tip point appears divided by +beat_speed+.
+		def initialize x, y, relative_time = nil, relative: true, speed: nil, relative_beat: nil, beat_speed: nil
+			@x = x
+			@y = y
+			@relative_time = relative_time
+			@relative = relative
+			@speed = speed
+			@relative_beat = relative_beat
+			@beat_speed = beat_speed
+			check
+		end
+
+		# Checks that the parameters passed to {#initialize} is one of the valid overloads.
+		# @return [void]
+		# @raise [ArgumentError] if checks fail.
+		def check
+			if !@x.is_a?(Numeric) || !@y.is_a?(Numeric)
+				raise ArgumentError, 'x and y must be numbers'
+			end
+			@x = @x.to_f
+			@y = @y.to_f
+			%i[@relative_time @speed @relative_beat @beat_speed].each do |key|
+				value = instance_variable_get key
+				next unless value
+				raise ArgumentError, "cannot specify both #@time_key and #{key}" if @time_key
+				@time_key = key
+			end
+			raise ArgumentError, "must specify one of relative_time, speed, relative_beat, beat_speed" unless @time_key
+		end
+
+		# @param start_event [Event]
+		# @return [Event]
+		def get_start_placeholder start_event
+			raise ArgumentError, "start_event is not tip-pointable" unless start_event.tip_pointable?
+			result = Event.new :placeholder, start_event.beat, start_event.bpm_changes
+			if @relative
+				result[:x] = start_event[:x] + @x
+				result[:y] = start_event[:y] + @y
+			else
+				result[:x] = @x
+				result[:y] = @y
+			end
+			case @time_key
+			when :@relative_time
+				raise ArgumentError, "relative_time must be a number" unless @relative_time.is_a? Numeric
+				raise ArgumentError, "relative_time must be non-negative" if @relative_time < 0
+				result.offset = -@relative_time.to_f
+			when :@speed
+				raise ArgumentError, "speed must be a number" unless @speed.is_a? Numeric
+				raise ArgumentError, "speed must be positive" if @speed <= 0
+				result.offset = -Math.hypot(result[:x] - start_event[:x], result[:y] - start_event[:y]) / @speed
+			when :@relative_beat
+				raise ArgumentError, "relative_beat must be a number" unless @relative_beat.is_a? Numeric
+				raise ArgumentError, "relative_beat must be non-negative" if @relative_beat < 0
+				warn "Rational is recommended over Float for relative_beat" if @relative_beat.is_a? Float
+				result.beat -= @relative_beat.to_r
+			when :@beat_speed
+				raise ArgumentError, "beat_speed must be a number" unless @beat_speed.is_a? Numeric
+				raise ArgumentError, "beat_speed must be positive" if @beat_speed <= 0
+				delta_beat = Math.hypot(result[:x] - start_event[:x], result[:y] - start_event[:y]) / @beat_speed
+				result.beat -= delta_beat.to_r # a little weird, but fine
+			end
+			result[:tip_point] = start_event[:tip_point]
+			result
+		end
+	end
+
+	# @note Internal API.
+	# @param start_event [Event]
+	# @return [void]
+	def push_tip_point_start start_event
+		start_event[:tip_point] = @current_tip_point_stack.last.to_s
+		tip_point_start = @tip_point_start_to_add_stack.last&.get_start_placeholder start_event
+		return unless tip_point_start
+		@groups.each do |group|
+			group.push tip_point_start
+			break if group.equal?(@current_tip_point_group_stack.last) && @tip_point_mode_stack.last != :drop
+		end
+		nil
+	end
+
+	# @note Internal API.
+	# @yieldself [Sunniesnow::Charter] the same as +self+.
+	def tip_point mode, *args, preserve_beat: true, **opts, &block
+		@tip_point_mode_stack.push mode
+		if mode == :none
+			@tip_point_start_stack.push nil
+			@tip_point_start_to_add_stack.push nil
+			@current_tip_point_stack.push nil
+		else
+			if args.empty? && opts.empty?
+				unless @tip_point_start_stack.last
+					raise ArgumentError, 'cannot omit tip point arguments at top level or inside tip_point_none'
+				end
+				@tip_point_start_stack.push @tip_point_start_stack.last.dup
+			else
+				@tip_point_start_stack.push TipPointStart.new *args, **opts
+			end
+			@tip_point_start_to_add_stack.push @tip_point_start_stack.last
+			@current_tip_point_stack.push nil
+		end
+		result = group preserve_beat: preserve_beat do
+			@current_tip_point_group_stack.push @groups.last
+			instance_eval &block
+		end
+		@tip_point_start_stack.pop
+		@tip_point_start_to_add_stack.pop
+		@tip_point_mode_stack.pop
+		@current_tip_point_stack.pop
+		@current_tip_point_group_stack.pop
+		result
+	end
+
+	# @!group DSL Methods
+
+	# @!parse
+	#   # @!macro [attach] tip_point_mode
+	#   #   @!method tip_point_$1 x, y, relative_time = nil, relative: true, speed: nil, relative_beat: nil, beat_speed: nil, preserve_beat: true, &block
+	#   #   $2
+	#   #   There are four overloads of this method for different ways to specify the time at which the tip point appears,
+	#   #   and there is another overload that totally omits the arguments for specifying
+	#   #   when and where the tip point appears and can only be used inside another tip point block.
+	#   #   This method is otherwise the same as {#group}.
+	#   #
+	#   #   If the methods {#tp_chain}, {#tp_drop}, and {#tp_none} are nested in +block+,
+	#   #   only the innermost one takes effect.
+	#   #   @example Nested tip points
+	#   #     offset 0.1; bpm 120
+	#   #     tp_chain 0, 100, 1 do
+	#   #       t 0, 0, 'A'; b 1 # tip point from above
+	#   #       tp_drop -100, 0, 1 do
+	#   #         t 25, 25, 'B'; b 1 # tip point from left
+	#   #         t 50, 25, 'C'; b 1 # tip point from left
+	#   #       end
+	#   #       tp_none do
+	#   #         t 75, 50, 'D'; b 1 # no tip point
+	#   #       end
+	#   #       t 100, 0, 'E'; b 1 # same tip point as note A
+	#   #     end
+	#   #   @param preserve_beat [Boolean] whether the {#current_beat} will be reset to the value before executing +block+ after it is executed.
+	#   #   @param relative [Boolean] whether the position at which a created tip point appears specified by the arguments +x+ and +y+
+	#   #     is relative to the first note it visits or absolute.
+	#   #   @param x [Numeric] the x-coordinate of the position at which a created tip point appears, whether relative or absolute.
+	#   #   @param y [Numeric] the y-coordinate of the position at which a created tip point appears, whether relative or absolute.
+	#   #   @return [Array<Event>] the events created inside +block+, similar to {#group}.
+	#   #   @raise [ArgumentError]
+	#   #   @yieldself [Charter] the same as +self+.
+	#   #   @overload tip_point_$1 x, y, relative_time, relative: true, preserve_beat: true, &block
+	#   #     @param relative_time [Numeric]
+	#   #     The time at which a created tip point appears is the time of the first note it visits minus +relative_time+.
+	#   #   @overload tip_point_$1 x, y, speed:, relative: true, preserve_beat: true, &block
+	#   #     @param speed [Numeric]
+	#   #     The time at which a created tip point appears is the time of the first note it visits minus
+	#   #     the distance between the note and the position where the tip point appears divided by +speed+.
+	#   #   @overload tip_point_$1 x, y, relative_beat:, relative: true, preserve_beat: true, &block
+	#   #     @param relative_beat [Rational, Integer]
+	#   #     The beat at which a created tip point appears is the beat of the first note it visits minus +relative_beat+.
+	#   #   @overload tip_point_$1 x, y, beat_speed:, relative: true, preserve_beat: true, &block
+	#   #     @param beat_speed [Numeric]
+	#   #     The beat at which a created tip point appears is the beat of the first note it visits minus
+	#   #     the distance between the note and the position where the tip point appears divided by +beat_speed+.
+	#   #   @overload tip_point_$1 preserve_beat: true, &block
+	#   #     This overload can only be used inside another tip point block,
+	#   #     and it creates a tip point with the same parameters as the one created by the outer block.
+	#   tip_point_mode :chain, 'Create a tip point to connect the notes created inside +block+.'
+	#   tip_point_mode :drop, 'A tip point is created for each note created inside +block+.'
+	#   alias tp_chain tip_point_chain
+	#   alias tp_drop tip_point_drop
+	#   alias tp_none tip_point_none
+	# @!method tip_point_none preserve_beat: true, &block
+	#   Notes created inside +block+ will not be visited by any tip point.
+	#   This method is otherwise the same as {#group}.
+	#   @yieldself [Charter] the same as +self+.
+	#   @return [Array<Event>] the events created inside +block+, similar to {#group}.
+	%i[chain drop none].each do |mode|
+		define_method "tip_point_#{mode}" do |*args, **opts, &block|
+			tip_point mode, *args, **opts, &block
+		end
+		alias_method "tp_#{mode}", "tip_point_#{mode}"
+	end
+
+	# @!endgroup
+
+end

data/lib/sscharter/charter.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+class Sunniesnow::Charter
+
+	# The project directory.
+	PROJECT_DIR = File.expand_path(ENV['SSCHARTER_PROJECT_DIR'] ||= Dir.pwd).freeze
+
+	# @!scope class
+	# A hash containing all the charts opened by {::open}.
+	# The keys are the names of the charts, and the values are the {Sunniesnow::Charter} objects.
+	# @return [Hash{String => Sunniesnow::Charter}]
+	singleton_class.attr_reader :charts
+	@charts = {}
+
+	# Create a new chart or open an existing chart for editing.
+	# The +name+ is used to check whether the chart already exists.
+	# If a new chart needs to be created, it is added to {.charts}.
+	#
+	# The given +block+ will be evaluated in the context of the chart
+	# (inside the block, +self+ is the same as the return value, a {Charter} instance).
+	# This method is intended to be called at the top level of a Ruby script
+	# to open a context for writing a Sunniesnow chart using the DSL.
+	#
+	# In the examples in the documentation of other methods,
+	# it is assumed that they are run inside a block passed to this method.
+	#
+	# @param name [String] the name of the chart.
+	# @return [Charter] the chart.
+	# @yieldself [Charter] the chart, the same as the return value.
+	# @example
+	#   Sunniesnow::Charter.open 'master' do
+	#     # write the chart here
+	#   end
+	def self.open name, &block
+		result = @charts[name] ||= new name
+		result.instance_eval &block if block
+		result
+	end
+
+	# Create a new chart.
+	# Usually you should use {.open} instead of this method.
+	# @param name [String] the name of the chart.
+	def initialize name
+		@name = name
+		init_chart_info
+		init_beat_state
+		init_group_state
+		init_bookmarks
+	end
+
+	# See {Sunniesnow::Chart#initialize} for the arguments.
+	# @return [Sunniesnow::Chart]
+	# @overload to_sunniesnow live_reload_port: 31108, production: false
+	def to_sunniesnow **opts
+		result = Sunniesnow::Chart.new **opts
+		result.title = @title
+		result.artist = @artist
+		result.charter = @charter
+		result.difficulty_name = @difficulty_name
+		result.difficulty_color = @difficulty_color
+		result.difficulty = @difficulty
+		result.difficulty_sup = @difficulty_sup
+		@events.each { result.events.push _1.to_sunniesnow }
+		result
+	end
+
+	# @return [String]
+	def output_json *args, **opts
+		to_sunniesnow(**opts).to_json *args
+	end
+
+	# @return [String]
+	def inspect
+		"#<Sunniesnow::Charter #@name>"
+	end
+
+end
+
+require_relative 'charter/metadata'
+require_relative 'charter/beat'
+require_relative 'charter/event'
+require_relative 'charter/group'
+require_relative 'charter/events_manip'
+require_relative 'charter/basic_events'
+require_relative 'charter/tip_point'
+require_relative 'charter/story_events'
+require_relative 'charter/check'