tyrano_dsl 0.1.0

data/lib/tyrano_dsl/elements/background.rb

@@ -0,0 +1,31 @@
+require_relative 'elements_module'
+
+# A declared background
+class TyranoDsl::Elements::Background
+
+  # @return [String]
+  attr_reader :name
+  # @return [String]
+  attr_reader :image_path
+  # @return [String]
+  attr_reader :target_short_file_name
+  # @return [String]
+  attr_reader :target_long_file_name
+
+  BACKGROUND_DIRECTORY = File.join('data', 'bgimage')
+
+  # @param [String] name
+  # @param [String] image_path
+  # @param [Integer] index
+  def initialize(name, image_path, index)
+    @name = name
+    @image_path = image_path
+    @index = index
+    @target_short_file_name = "#{index}#{File.extname(image_path)}"
+    @target_long_file_name = File.join(
+        BACKGROUND_DIRECTORY,
+        @target_short_file_name
+    )
+  end
+
+end

data/lib/tyrano_dsl/elements/character.rb

@@ -0,0 +1,49 @@
+require_relative 'elements_module'
+require_relative 'stance'
+
+
+# A declared character
+class TyranoDsl::Elements::Character
+
+  CHARACTER_DIRECTORY = File.join('data', 'fgimage', 'chara')
+
+  # @return [String]
+  attr_reader :name
+  # @return [Index]
+  attr_reader :index
+  # @return [Hash{String => TyranoDsl::Elements::Stance}]
+  attr_reader :stances
+  # @return [TyranoDsl::Elements::Stance]
+  attr_reader :default_stance
+
+  # @param [String] name
+  # @param [String] declared_stances
+  # @param [Integer] index
+  def initialize(name, declared_stances, index)
+    @name = name
+    @stances = stances
+    @index = index
+    @stances = {}
+
+    @stances_target_long_files_names = {}
+    @stance_target_short_file_names = {}
+    declared_stances.each_pair do |stance_name, stance_file|
+      short_file_name = File.join(index.to_s,
+                                  "#{@stances.length}#{File.extname(stance_file)}")
+      long_file_name = File.join(
+          CHARACTER_DIRECTORY, short_file_name)
+      stance = TyranoDsl::Elements::Stance.new(
+          stance_name,
+          stance_file,
+          short_file_name,
+          long_file_name)
+      @stances[stance_name] = stance
+
+      if stance_name == :default
+        @default_stance = stance
+        @default_stance_target_short_file_name = short_file_name
+      end
+    end
+  end
+
+end

data/lib/tyrano_dsl/elements/elements_module.rb

@@ -0,0 +1,7 @@
+module TyranoDsl::Elements
+
+  module ElementsModule
+
+  end
+
+end

data/lib/tyrano_dsl/elements/jump_target.rb

@@ -0,0 +1,18 @@
+require_relative 'elements_module'
+
+# A declared jump target
+class TyranoDsl::Elements::JumpTarget
+
+  # @return [String]
+  attr_reader :scene
+  # @return [TyranoDsl::Elements::Label,nil]
+  attr_reader :label
+
+  # @param [String] scene
+  # @param [TyranoDsl::Elements::Label,nil] label
+  def initialize(scene, label)
+    @scene = scene
+    @label = label
+  end
+
+end

data/lib/tyrano_dsl/elements/label.rb

@@ -0,0 +1,19 @@
+require_relative 'elements_module'
+
+# A label
+
+class TyranoDsl::Elements::Label
+
+  # @return [String]
+  attr_reader :name
+  # @return [String]
+  attr_reader :target_name
+
+  # @param [String] name
+  # @param [String] target_name
+  def initialize(name, target_name)
+    @name = name
+    @target_name = target_name
+  end
+
+end

data/lib/tyrano_dsl/elements/scene.rb

@@ -0,0 +1,21 @@
+require_relative 'elements_module'
+
+# A declared scene
+class TyranoDsl::Elements::Scene
+
+  # @return [String]
+  attr_reader :name
+  # @return [String]
+  attr_reader :target_name
+  # @return [Array<String>]
+  attr_reader :labels
+
+  # @param [String] name
+  # @param [Integer] index
+  def initialize(name, index)
+    @name = name
+    @target_name = "scene#{index}"
+    @labels = []
+  end
+
+end

data/lib/tyrano_dsl/elements/stance.rb

@@ -0,0 +1,26 @@
+require_relative 'elements_module'
+
+# A stance
+class TyranoDsl::Elements::Stance
+
+  # @return [String]
+  attr_reader :name
+  # @return [String]
+  attr_reader :original_file_name
+  # @return [String]
+  attr_reader :short_target_file_name
+  # @return [String]
+  attr_reader :long_target_file_name
+
+  # @param [String] name
+  # @param [String] original_file_name
+  # @param [String] short_target_file_name
+  # @param [String] long_target_file_name
+  def initialize(name, original_file_name, short_target_file_name, long_target_file_name)
+    @name = name
+    @original_file_name = original_file_name
+    @short_target_file_name = short_target_file_name
+    @long_target_file_name = long_target_file_name
+  end
+
+end

data/lib/tyrano_dsl/elements/title_screen.rb

@@ -0,0 +1,16 @@
+require_relative 'elements_module'
+
+# the title screen
+class TyranoDsl::Elements::TitleScreen
+
+  # @return [String]
+  attr_accessor :background
+  # @return [String]
+  attr_accessor :first_scene_name
+
+  def initialize
+    @background = nil
+    @first_scene_name = nil
+  end
+
+end

data/lib/tyrano_dsl/elements/variable.rb

@@ -0,0 +1,22 @@
+require_relative 'elements_module'
+
+# A label
+class TyranoDsl::Elements::Variable
+
+  # @return [String]
+  attr_reader :name
+  # @return [String]
+  attr_reader :target_name
+  # @return [Integer]
+  attr_reader :initial_value
+
+  # @param [String] name
+  # @param [String] target_name
+  # @param [String] initial_value
+  def initialize(name, target_name, initial_value)
+    @name = name
+    @target_name = target_name
+    @initial_value = initial_value
+  end
+
+end

data/lib/tyrano_dsl/elements/world.rb

@@ -0,0 +1,62 @@
+require_relative 'elements_module'
+require_relative 'label'
+require_relative 'title_screen'
+require_relative 'variable'
+
+# The game world
+class TyranoDsl::Elements::World
+
+  # @return [Hash{String => TyranoDsl::Elements::Background}]
+  attr_reader :backgrounds
+  # @return [Hash{String => TyranoDsl::Elements::Character}]
+  attr_reader :characters
+  # @return [Array<TyranoDsl::Elements::JumpTarget>]
+  attr_reader :jump_targets
+  # @return [Hash{String => TyranoDsl::Elements::Label}]
+  attr_reader :labels
+  # @return [Hash{String => TyranoDsl::Elements::Scene}]
+  attr_reader :scenes
+  # @return [TyranoDsl::Elements::TitleScreen]
+  attr_reader :title_screen
+  # @return [Hash{String => TyranoDsl::Elements::Variable}]
+  attr_reader :variables
+
+  def initialize
+    @characters = {}
+    @backgrounds = {}
+    @labels = {}
+    @jump_targets = []
+    @scenes = {}
+    @variables = {}
+    @title_screen = TyranoDsl::Elements::TitleScreen.new
+  end
+
+  # @return [void]
+  # @raise [TyranoDsl::TyranoException]
+  def validate
+    @jump_targets.each do |jump_target|
+      scene = @scenes[jump_target.scene]
+      unless scene
+        raise TyranoDsl::TyranoException, "Unknown scene [#{jump_target.scene}] declared in label"
+      end
+      jump_target_label = jump_target.label
+      if jump_target_label && (!scene.labels.include?(jump_target_label.name))
+        raise TyranoDsl::TyranoException, "Unknown label [#{jump_target_label.name}] declared in label"
+      end
+    end
+  end
+
+  # @param [String, nil] label_name
+  # @return [TyranoDsl::Elements::Label]
+  def label_value(label_name)
+    if @labels.key? label_name
+      @labels[label_name]
+    else
+      technical_name = label_name ? "label_#{@labels.length}" : nil
+      label = TyranoDsl::Elements::Label.new(label_name, technical_name)
+      @labels[label_name] = label
+      label
+    end
+  end
+
+end

data/lib/tyrano_dsl/elements_writers/background_writer.rb

@@ -0,0 +1,30 @@
+require_relative '../elements/background'
+require_relative '../file_actions/clear_directory'
+require_relative '../file_actions/file_copy'
+require_relative 'elements_writers_module'
+
+# Write a background
+class TyranoDsl::ElementsWriters::BackgroundWriter
+
+  include TyranoDsl::ElementsWriters::ElementsWritersModule
+
+  # @return [Array]
+  def init_actions
+    [
+        TyranoDsl::FileActions::ClearDirectory.new(TyranoDsl::Elements::Background::BACKGROUND_DIRECTORY)
+    ]
+  end
+
+  # @param [TyranoDsl::Elements::Background] background
+  # @return [Array]
+  def write(background)
+    log {"Writing background [#{background.name}]"}
+    [
+        TyranoDsl::FileActions::FileCopy.new(
+            background.image_path,
+            background.target_long_file_name
+        )
+    ]
+  end
+
+end

data/lib/tyrano_dsl/elements_writers/character_writer.rb

@@ -0,0 +1,32 @@
+require_relative '../elements/character'
+require_relative '../file_actions/clear_directory'
+require_relative '../file_actions/file_copy'
+require_relative 'elements_writers_module'
+
+# Write a character
+class TyranoDsl::ElementsWriters::CharacterWriter
+
+  include TyranoDsl::ElementsWriters::ElementsWritersModule
+
+  # @return [Array]
+  def init_actions
+    [
+        TyranoDsl::FileActions::ClearDirectory.new(TyranoDsl::Elements::Character::CHARACTER_DIRECTORY)
+    ]
+  end
+
+  # @param [TyranoDsl::Elements::Character] character
+  # @return [Array]
+  def write(character)
+    log {"Writing character [#{character.name}]"}
+    result = []
+    character.stances.each_value do |stance|
+      result << TyranoDsl::FileActions::FileCopy.new(
+          stance.original_file_name,
+          stance.long_target_file_name
+      )
+    end
+    result
+  end
+
+end

data/lib/tyrano_dsl/elements_writers/characters_writer.rb

@@ -0,0 +1,43 @@
+require_relative '../file_actions/create_file'
+require_relative '../file_actions/json_patch'
+require_relative 'elements_writers_module'
+
+# Write things where all characters are implied
+class TyranoDsl::ElementsWriters::CharactersWriter
+
+  include TyranoDsl::ElementsWriters::ElementsWritersModule
+
+  # @param [TyranoDsl::Elements::World] world
+  # @return [Array]
+  def write(world)
+    log {'Writing characters'}
+    chara_define_content = ''
+    world.characters.values.collect do |character|
+      chara_define_content << "[chara_new name=\"#{character.name}\" jname=\"#{character.name}\" storage=\"chara\/#{character.default_stance.short_target_file_name}\"]\n"
+    end
+    chara_define_content << "\n"
+    chara_define_content << "[iscript]\n"
+    world.variables.values.collect do |variable|
+      chara_define_content << "f['#{variable.target_name}']=#{variable.initial_value};\n"
+    end
+    chara_define_content << "[endscript]\n"
+
+    builder_config_content = {}
+    world.characters.values.each do |character|
+      builder_config_content[character.name] = character.index
+    end
+
+    [
+        TyranoDsl::FileActions::CreateFile.new(
+            File.join('data', 'scenario', 'system', 'chara_define.ks'),
+            chara_define_content
+        ),
+        TyranoDsl::FileActions::JsonPatch.new(
+            'builder_config.json',
+            ['map_chara'],
+            builder_config_content
+        )
+    ]
+  end
+
+end

data/lib/tyrano_dsl/elements_writers/elements_writers_module.rb

@@ -0,0 +1,27 @@
+require 'logger'
+
+module TyranoDsl
+  module ElementsWriters
+
+    # Helpers to write writers
+    module ElementsWritersModule
+
+      protected
+
+      # @param [Array<String>] pathes
+      def preload_text(pathes)
+        pathes.collect {|a| "[preload storage=\"./#{a}\"]\n"}.join + '[return]'
+      end
+
+      def logger
+        @logger ||= Logger.new(STDOUT)
+      end
+
+      def log
+        logger.info(self.class) {yield}
+      end
+
+    end
+
+  end
+end

data/lib/tyrano_dsl/elements_writers/scene_writer.rb

@@ -0,0 +1,30 @@
+require_relative '../file_actions/create_file'
+require_relative 'elements_writers_module'
+
+# Write a scene
+class TyranoDsl::ElementsWriters::SceneWriter
+
+  include TyranoDsl::ElementsWriters::ElementsWritersModule
+
+  # @param [TyranoDsl::Elements::Scene] scene
+  # @param [Array<String>] scene_content
+  # @param [Array<String>] assets
+  # @return [Array]
+  def write(scene, scene_content, assets)
+    log {"Writing scene [#{scene.name}]"}
+    content_text_content = "[_tb_system_call storage=system/_#{scene.target_name}.ks]\n[cm]\n#{scene_content.join("\n")}\n"
+    preload_text_content = preload_text(assets.to_a)
+    [
+        TyranoDsl::FileActions::CreateFile.new(
+            File.join('data', 'scenario', "#{scene.target_name}.ks"),
+            content_text_content
+        ),
+        TyranoDsl::FileActions::CreateFile.new(
+            File.join('data', 'scenario', 'system', "_#{scene.target_name}.ks"),
+            preload_text_content
+        )
+
+    ]
+  end
+
+end