tyrano_dsl 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17d34d336f11f2f6009bb3984e5a01cf72c43cb0
-  data.tar.gz: 63f2ce47b179e1d620389051014fbbb0a7eb8db6
+  metadata.gz: 46ba1fa3cb8f86ad6789542828c295000818759b
+  data.tar.gz: 7f9d780be122cb5e2580e5139a158ae43017fe71
 SHA512:
-  metadata.gz: ffe1a7e21309f9df76ebff536a5e5c9946c73199e44f4986e8cfb5aed0850e486476330c85134854f09a40e5ef005bc6d9253f5cb67dee94563f339c7b3e221c
-  data.tar.gz: 21bc3b5729e06fde892e7592153e89e49fa4fb1f86dfb4e5646729c80fe68c40334f25294ecb4aafa0fb3852890ccbe06ef96d37c64019cdc6181df06b0bf3e6
+  metadata.gz: ee6a884dd5ceaa547a373c23fd0c61f21eaa48343b3963fd76b387d9c6383d97ea533790f4d13cb1a7160cee849c92b6cd5bf6420cee1628062cc6d22e6150f3
+  data.tar.gz: 4fe270f441606aa4bcde69a3935eb5228fafe2662d8ebe39d402c7e01f17b46593573ef6b3116a7a779a40c40db45a3cd988f81c6997bdfdb43f2c574b765535

data/README.md

@@ -1,6 +1,7 @@
 # TyranoDsl
 
 [![Build Status](https://travis-ci.org/archiloque/tyrano_dsl.svg?branch=master)](https://travis-ci.org/archiloque/tyrano_dsl)
+[![Gem Version](https://badge.fury.io/rb/tyrano_dsl.svg)](https://badge.fury.io/rb/tyrano_dsl)
 
 A DSL to write visual novels games in Ruby using [TyranoBuilder](http://tyranobuilder.com).
 
@@ -55,7 +56,7 @@ start_scene 'Second scene'
 - Install [TyranoBuilder](http://tyranobuilder.com)
 - Create a project in it
 - Install the gem
-- Execute `tyrano-dsl PATH_TO_YOUR_TYRANO_PROJECT PATH_TO_YOUR_RUBY_CODE.rb` in your project directory.
+- Execute `tyrano-dsl export-game PATH_TO_YOUR_TYRANO_PROJECT PATH_TO_YOUR_RUBY_CODE.rb` in your project directory.
 
 `PATH_TO_YOUR_TYRANO_PROJECT` should look like `/Users/u/Library/Application\ Support/Steam/steamapps/common/TyranoBuilder/myproject/Test`
 
@@ -65,10 +66,40 @@ You can then reopen the project in TyranoBuilder and see the changes.
 
 If there is an error it should be displayed and the message should help you to fix the problem.
 
+## Actions
+
+* `export-game` export the game to replace the current content of the Tyrano project
+* `export-text` print the text content of the game 
+
 ## Current vocabulary
 
+* [Background](#background)
+  * [`declare_background` Declare a background](#declare_background)
+  * [`set_background` Set the background](#set_background)
+* [Characters](#characters)
+  * [`declare_character` Declare a character](#declare_character)
+  * [`hide_character` Hide a character](#hide_character)
+  * [`set_character_stance` Change the stance of a character](#set_character_stance)
+  * [`show_character` Show a character](#show_character)
+* [Content](#content)
+  * [`ask_question` Ask a question](#ask_question)
+* [Jump & Labels](#jump-labels)
+  * [`declare_label` Declare a label](#declare_label)
+  * [`conditional_jump` Jump to somewhere if a condition is met](#conditional_jump)
+  * [`jump` Jump to somewhere](#jump)
+* [Variables](#variables)
+  * [`declare_variable` Declare a variable](#declare_variable)
+  * [`update_variable` Update a variable](#update_variable)
+* [Misc](#misc)
+  * [`hide_message_window` Hide the message window](#hide_message_window)
+  * [`include_file` Include a file](#include_file)
+  * [`show_message_window` Show the message window](#show_message_window)
+  * [`start_scene` Start a new scene](#start_scene)
+
+<a id="background"></a>
 ### Background
 
+<a id="declare_background"></a>
 #### `declare_background` Declare a background
 
 `declare_background(name, images_path)` 
@@ -79,6 +110,7 @@ If there is an error it should be displayed and the message should help you to f
 declare_background 'School', 'background/school.jpg'
 ```
 
+<a id="set_background"></a>
 #### `set_background` Set the background
 
 `show_background(name)` 
@@ -88,8 +120,10 @@ declare_background 'School', 'background/school.jpg'
 set_background 'School'
 ```
 
+<a id="characters"></a>
 ### Characters
 
+<a id="declare_character"></a>
 #### `declare_character` Declare a character
 
 `declare_character(name, stances)`
@@ -102,6 +136,7 @@ declare_character 'Shinji',
     'angry' => 'angry.jpg'
 ```
 
+<a id="hide_character"></a>
 #### `hide_character` Hide a character
 
 `hide_character(name)`
@@ -111,7 +146,8 @@ declare_character 'Shinji',
 hide_character 'Shinji'
 ```
 
-#### `set_character_stance` change the stance of a character
+<a id="set_character_stance"></a>
+#### `set_character_stance` Change the stance of a character
 
 `set_character_stance(name, stance)`
 - `name` is a `String` representing the character's name
@@ -121,7 +157,8 @@ hide_character 'Shinji'
 set_character_stance 'Shinji', 'angry'
 ```
 
-#### `show_character` show a character
+<a id="show_character"></a>
+#### `show_character` Show a character
 
 `show_character(name, stance, left, top)`
 - `name` is a `String` representing the character's name
@@ -133,8 +170,10 @@ set_character_stance 'Shinji', 'angry'
 show_character 'Shinji', 'default', 434, 128
 ```
 
+<a id="content"></a>
 ### Content
 
+<a id="ask_question"></a>
 #### `ask_question` Ask a question
 
 `ask_question(possible_answers)`
@@ -164,8 +203,10 @@ ask_question [
              ]
 ```
 
+<a id="jump-labels"></a>
 ### Jump & Labels
 
+<a id="declare_label"></a>
 #### `declare_label` Declare a label
 
 `declare_label(name)` 
@@ -175,6 +216,7 @@ ask_question [
 declare_label 'my label'
 ```
 
+<a id="conditional_jump"></a>
 #### `conditional_jump` Jump to somewhere if a condition is met
 
 `conditional_jump(variable, operator, value, scene, label)`
@@ -189,6 +231,7 @@ conditional_jump 'variable_1', '<', 10, 'Scene two'
 conditional_jump 'variable_1', '=', 'variable_2', 'Scene two', 'Label three'
 ```
 
+<a id="jump"></a>
 #### `jump` Jump to somewhere
 
 `jump(scene, label)`
@@ -200,8 +243,10 @@ jump 'Scene two'
 jump 'Scene two', 'Label three'
 ```
 
+<a id="variables"></a>
 ### Variables
 
+<a id="declare_variable"></a>
 #### `declare_variable` Declare a variable
 
 `declare_variable(variable_name, initial_value)` 
@@ -212,6 +257,7 @@ jump 'Scene two', 'Label three'
 declare_variable 'happiness', 25
 ```
 
+<a id="update_variable"></a>
 #### `update_variable` Update a variable
 
 `update_variable(variable_name, operation, value)` 
@@ -230,8 +276,10 @@ update_variable 'happiness', '=', 25
 update_variable 'happiness', '+', 'calmness'
 ```
 
+<a id="misc"></a>
 ### Misc
 
+<a id="hide_message_window"></a>
 #### `hide_message_window` Hide the message window
 
 `hide_message_window`
@@ -240,6 +288,7 @@ update_variable 'happiness', '+', 'calmness'
 hide_message_window
 ```
 
+<a id="include_file"></a>
 #### `include_file` Include a file
 
 `include_file(file_name)`
@@ -249,6 +298,7 @@ hide_message_window
 include_file('other_scene.rb')
 ```
 
+<a id="show_message_window"></a>
 #### `show_message_window` Show the message window
 
 `show_message_window`
@@ -257,6 +307,7 @@ include_file('other_scene.rb')
 show_message_window
 ```
 
+<a id="start_scene"></a>
 #### `start_scene` Start a new scene
 
 `start_scene(name)` 
@@ -275,11 +326,11 @@ The tool works like a two passes compiler:
 
 ## Links
 
-- http://tyranobuilder.com/tyranoscript-tags-reference/ : the TyranoScript tags references
+- [the TyranoScript tags references](http://tyranobuilder.com/tyranoscript-tags-reference/)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/archiloque/tyrano_dsl.
+Bug reports and pull requests are welcome on [GitHub](https://github.com/archiloque/tyrano_dsl).
 
 This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 

data/bin/tyrano_dsl.rb

@@ -2,20 +2,33 @@
 
 require 'bundler/setup'
 require 'json'
-require 'tyrano_dsl/main'
 require 'tyrano_dsl/tyrano_exception'
-if ARGV.length != 2
-  raise 'You need two arguments : the path to the tyrano project and the path to your DSL file'
+if ARGV.length != 3
+  raise 'You need three arguments : the verb to execute, the path to the tyrano project and the path to your DSL file'
 end
-tyrano_project_path = ARGV[0]
-dsl_file_path = ARGV[1]
+
+EXPORT_GAME_COMMAND = 'export-game'
+EXPORT_TEXT_COMMAND = 'export-text'
+
+verb = ARGV[0]
+unless [EXPORT_GAME_COMMAND, EXPORT_TEXT_COMMAND].include? verb
+  raise "Unknown verb [#{verb}, should be [#{EXPORT_GAME_COMMAND}] or [#{EXPORT_TEXT_COMMAND}]"
+end
+tyrano_project_path = ARGV[1]
+dsl_file_path = ARGV[2]
 
 builder_configuration_file = File.join(tyrano_project_path, 'builder_config.json')
 unless File.exists? builder_configuration_file
   raise "File not found [#{builder_configuration_file}]"
 end
 
-writing_context = TyranoDsl::Main.new.run(dsl_file_path)
-writing_context.file_actions.each do |file_action|
-  file_action.run(tyrano_project_path)
+if verb == EXPORT_GAME_COMMAND
+  require 'tyrano_dsl/export_game/main'
+  main = TyranoDsl::ExportGame::Main.new
+else
+  require 'tyrano_dsl/export_text/main'
+  main = TyranoDsl::ExportText::Main.new
 end
+
+result = main.run(dsl_file_path)
+main.apply(result, tyrano_project_path)

data/lib/tyrano_dsl/elements/background.rb

@@ -1,6 +1,6 @@
 require_relative 'elements_module'
 
-# A declared background
+# A background
 class TyranoDsl::Elements::Background
 
   # @return [String]

data/lib/tyrano_dsl/elements/character.rb

@@ -1,8 +1,7 @@
 require_relative 'elements_module'
 require_relative 'stance'
 
-
-# A declared character
+# A character
 class TyranoDsl::Elements::Character
 
   CHARACTER_DIRECTORY = File.join('data', 'fgimage', 'chara')

data/lib/tyrano_dsl/elements/jump_target.rb

@@ -1,6 +1,6 @@
 require_relative 'elements_module'
 
-# A declared jump target
+# A jump target
 class TyranoDsl::Elements::JumpTarget
 
   # @return [String]

data/lib/tyrano_dsl/elements/label.rb

@@ -1,7 +1,6 @@
 require_relative 'elements_module'
 
 # A label
-
 class TyranoDsl::Elements::Label
 
   # @return [String]

data/lib/tyrano_dsl/elements/scene.rb

@@ -1,6 +1,6 @@
 require_relative 'elements_module'
 
-# A declared scene
+# A  scene
 class TyranoDsl::Elements::Scene
 
   # @return [String]

data/lib/tyrano_dsl/elements/title_screen.rb

@@ -1,6 +1,6 @@
 require_relative 'elements_module'
 
-# the title screen
+# The title screen
 class TyranoDsl::Elements::TitleScreen
 
   # @return [String]

data/lib/tyrano_dsl/elements/variable.rb

@@ -1,6 +1,6 @@
 require_relative 'elements_module'
 
-# A label
+# A variable
 class TyranoDsl::Elements::Variable
 
   # @return [String]

data/lib/tyrano_dsl/{elements_writers → export_game/elements_writers}/background_writer.rb

@@ -1,17 +1,17 @@
-require_relative '../elements/background'
+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
+class TyranoDsl::ExportGame::ElementsWriters::BackgroundWriter
 
-  include TyranoDsl::ElementsWriters::ElementsWritersModule
+  include TyranoDsl::ExportGame::ElementsWriters::ElementsWritersModule
 
   # @return [Array]
   def init_actions
     [
-        TyranoDsl::FileActions::ClearDirectory.new(TyranoDsl::Elements::Background::BACKGROUND_DIRECTORY)
+        TyranoDsl::ExportGame::FileActions::ClearDirectory.new(TyranoDsl::Elements::Background::BACKGROUND_DIRECTORY)
     ]
   end
 
@@ -20,7 +20,7 @@ class TyranoDsl::ElementsWriters::BackgroundWriter
   def write(background)
     log {"Writing background [#{background.name}]"}
     [
-        TyranoDsl::FileActions::FileCopy.new(
+        TyranoDsl::ExportGame::FileActions::FileCopy.new(
             background.image_path,
             background.target_long_file_name
         )

data/lib/tyrano_dsl/{elements_writers → export_game/elements_writers}/character_writer.rb

@@ -1,17 +1,17 @@
-require_relative '../elements/character'
+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
+class TyranoDsl::ExportGame::ElementsWriters::CharacterWriter
 
-  include TyranoDsl::ElementsWriters::ElementsWritersModule
+  include TyranoDsl::ExportGame::ElementsWriters::ElementsWritersModule
 
   # @return [Array]
   def init_actions
     [
-        TyranoDsl::FileActions::ClearDirectory.new(TyranoDsl::Elements::Character::CHARACTER_DIRECTORY)
+        TyranoDsl::ExportGame::FileActions::ClearDirectory.new(TyranoDsl::Elements::Character::CHARACTER_DIRECTORY)
     ]
   end
 
@@ -21,7 +21,7 @@ class TyranoDsl::ElementsWriters::CharacterWriter
     log {"Writing character [#{character.name}]"}
     result = []
     character.stances.each_value do |stance|
-      result << TyranoDsl::FileActions::FileCopy.new(
+      result << TyranoDsl::ExportGame::FileActions::FileCopy.new(
           stance.original_file_name,
           stance.long_target_file_name
       )

data/lib/tyrano_dsl/{elements_writers → export_game/elements_writers}/characters_writer.rb

@@ -3,9 +3,9 @@ require_relative '../file_actions/json_patch'
 require_relative 'elements_writers_module'
 
 # Write things where all characters are implied
-class TyranoDsl::ElementsWriters::CharactersWriter
+class TyranoDsl::ExportGame::ElementsWriters::CharactersWriter
 
-  include TyranoDsl::ElementsWriters::ElementsWritersModule
+  include TyranoDsl::ExportGame::ElementsWriters::ElementsWritersModule
 
   # @param [TyranoDsl::Elements::World] world
   # @return [Array]
@@ -28,11 +28,11 @@ class TyranoDsl::ElementsWriters::CharactersWriter
     end
 
     [
-        TyranoDsl::FileActions::CreateFile.new(
+        TyranoDsl::ExportGame::FileActions::CreateFile.new(
             File.join('data', 'scenario', 'system', 'chara_define.ks'),
             chara_define_content
         ),
-        TyranoDsl::FileActions::JsonPatch.new(
+        TyranoDsl::ExportGame::FileActions::JsonPatch.new(
             'builder_config.json',
             ['map_chara'],
             builder_config_content

data/lib/tyrano_dsl/{elements_writers → export_game/elements_writers}/elements_writers_module.rb

@@ -1,6 +1,6 @@
 require 'logger'
 
-module TyranoDsl
+module TyranoDsl::ExportGame
   module ElementsWriters
 
     # Helpers to write writers

data/lib/tyrano_dsl/{elements_writers → export_game/elements_writers}/scene_writer.rb

@@ -2,9 +2,9 @@ require_relative '../file_actions/create_file'
 require_relative 'elements_writers_module'
 
 # Write a scene
-class TyranoDsl::ElementsWriters::SceneWriter
+class TyranoDsl::ExportGame::ElementsWriters::SceneWriter
 
-  include TyranoDsl::ElementsWriters::ElementsWritersModule
+  include TyranoDsl::ExportGame::ElementsWriters::ElementsWritersModule
 
   # @param [TyranoDsl::Elements::Scene] scene
   # @param [Array<String>] scene_content
@@ -15,11 +15,11 @@ class TyranoDsl::ElementsWriters::SceneWriter
     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(
+        TyranoDsl::ExportGame::FileActions::CreateFile.new(
             File.join('data', 'scenario', "#{scene.target_name}.ks"),
             content_text_content
         ),
-        TyranoDsl::FileActions::CreateFile.new(
+        TyranoDsl::ExportGame::FileActions::CreateFile.new(
             File.join('data', 'scenario', 'system', "_#{scene.target_name}.ks"),
             preload_text_content
         )

data/lib/tyrano_dsl/{elements_writers → export_game/elements_writers}/title_screen_writer.rb

@@ -2,9 +2,9 @@ require_relative '../file_actions/create_file'
 require_relative 'elements_writers_module'
 
 # Write the title screen
-class TyranoDsl::ElementsWriters::TitleScreenWriter
+class TyranoDsl::ExportGame::ElementsWriters::TitleScreenWriter
 
-  include TyranoDsl::ElementsWriters::ElementsWritersModule
+  include TyranoDsl::ExportGame::ElementsWriters::ElementsWritersModule
 
   # @param [TyranoDsl::Elements::World] world
   # @return [Array]
@@ -16,11 +16,11 @@ class TyranoDsl::ElementsWriters::TitleScreenWriter
     content_text_content = title_screen_content(background, first_scene)
     preload_text_content = preload_text([background.target_long_file_name])
     [
-        TyranoDsl::FileActions::CreateFile.new(
+        TyranoDsl::ExportGame::FileActions::CreateFile.new(
             File.join('data', 'scenario', "title_screen.ks"),
             content_text_content
         ),
-        TyranoDsl::FileActions::CreateFile.new(
+        TyranoDsl::ExportGame::FileActions::CreateFile.new(
             File.join('data', 'scenario', 'system', "_title_screen.ks"),
             preload_text_content
         )