tyrano_dsl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 17d34d336f11f2f6009bb3984e5a01cf72c43cb0
+  data.tar.gz: 63f2ce47b179e1d620389051014fbbb0a7eb8db6
+SHA512:
+  metadata.gz: ffe1a7e21309f9df76ebff536a5e5c9946c73199e44f4986e8cfb5aed0850e486476330c85134854f09a40e5ef005bc6d9253f5cb67dee94563f339c7b3e221c
+  data.tar.gz: 21bc3b5729e06fde892e7592153e89e49fa4fb1f86dfb4e5646729c80fe68c40334f25294ecb4aafa0fb3852890ccbe06ef96d37c64019cdc6181df06b0bf3e6

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+ - 2.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at code@archiloque.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tyrano_dsl.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Julien Kirch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,290 @@
+# TyranoDsl
+
+[![Build Status](https://travis-ci.org/archiloque/tyrano_dsl.svg?branch=master)](https://travis-ci.org/archiloque/tyrano_dsl)
+
+A DSL to write visual novels games in Ruby using [TyranoBuilder](http://tyranobuilder.com).
+
+TyranoBuilder is a good tool has many features like native web export but I don't like to click-heavy interface to write.
+
+The goal is to provide a simple syntax you can use directly or you can build upon.
+
+You create your TyranoBuilder project with the specific options and the library is used to modify the content without touching the other things.
+
+The project is a WIP: I add things as I need them, if you have any issue or need something please ask me.
+
+If you use it for a published VN, please tell me: it would make me happy and I'll add a link to it in this page.
+
+Example:
+
+```ruby
+declare_character 'Shinji', 
+    'default' => 'default_stance.jpg',
+    'angry' => 'angry.jpg'
+
+declare_background 'School', 'background/school.jpg'
+
+set_title_screen_background 'School'
+
+start_scene 'First scene'
+set_background 'School'
+show_character 'Shinji', 'default', 434, 128
+show_message_window
+display_text 'Shinji', 'Hello!'
+set_character_stance 'Shinji', 'angry'
+display_text nil, 'Do you want to go in the eva ?'
+ask_question [
+                 {
+                     'text' => 'Yes!',
+                     'left' => 200,
+                     'top' => 200,
+                     'scene' => 'Second scene'
+                 },
+                 {
+                     'text' => 'No!',
+                     'left' => 200,
+                     'top' => 300,
+                     'scene' => 'Third scene',
+                     'label' => 'a label'
+                 }
+             ]
+start_scene 'Second scene'
+```
+
+## How to use it
+
+- 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.
+
+`PATH_TO_YOUR_TYRANO_PROJECT` should look like `/Users/u/Library/Application\ Support/Steam/steamapps/common/TyranoBuilder/myproject/Test`
+
+If everything is OK it should update the files in your TyranoBuilder project.
+
+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.
+
+## Current vocabulary
+
+### Background
+
+#### `declare_background` Declare a background
+
+`declare_background(name, images_path)` 
+- `name` is a `String` representing the background's name
+- `images_path` is a `String` indicating the path to the background images
+
+```ruby
+declare_background 'School', 'background/school.jpg'
+```
+
+#### `set_background` Set the background
+
+`show_background(name)` 
+- `name` is a `String` representing the background's name
+
+```ruby
+set_background 'School'
+```
+
+### Characters
+
+#### `declare_character` Declare a character
+
+`declare_character(name, stances)`
+- `name` is a `String` representing the character's name
+- `stances` is a `Hash{String => String}` providing a list of stances with the path to their corresponding images
+
+```ruby
+declare_character 'Shinji', 
+    'default' => 'default_stance.jpg',
+    'angry' => 'angry.jpg'
+```
+
+#### `hide_character` Hide a character
+
+`hide_character(name)`
+- `name` is a `String` representing the character's name
+
+```ruby
+hide_character 'Shinji'
+```
+
+#### `set_character_stance` change the stance of a character
+
+`set_character_stance(name, stance)`
+- `name` is a `String` representing the character's name
+- `stance` is a `String` defining the stance name
+
+```ruby
+set_character_stance 'Shinji', 'angry'
+```
+
+#### `show_character` show a character
+
+`show_character(name, stance, left, top)`
+- `name` is a `String` representing the character's name
+- `stance` is a `String` defining the stance name
+- `left` is an `Integer` defining the left position
+- `top` is an `Integer` defining the top position
+
+```ruby
+show_character 'Shinji', 'default', 434, 128
+```
+
+### Content
+
+#### `ask_question` Ask a question
+
+`ask_question(possible_answers)`
+- `possible_answers` is a list of possible answers with the corresponding target
+  - `text` is a `String` representing the text of the answer
+  - `left` is an `Integer` defining the left position 
+  - `top` is an `Integer` defining the top position
+  - `scene` is a `String` indicating the name of the scene to jump if the answer is selected
+  - `label` (optional) is a `String` indicating the name of the label in the scene to jump if the answer is selected
+
+  
+```ruby
+ask_question [
+                 {
+                     'text' => 'Yes',
+                     'left' => 200,
+                     'top' => 200,
+                     'scene' => 'Second scene'
+                 },
+                 {
+                     'text' => 'No',
+                     'left' => 200,
+                     'top' => 300,
+                     'scene_name' => 'Third scene',
+                     'label_name' => 'a label'
+                 }
+             ]
+```
+
+### Jump & Labels
+
+#### `declare_label` Declare a label
+
+`declare_label(name)` 
+- `name` is a `String` representing the label's name
+
+```ruby
+declare_label 'my label'
+```
+
+#### `conditional_jump` Jump to somewhere if a condition is met
+
+`conditional_jump(variable, operator, value, scene, label)`
+- `variable` is a `String` indicating the name of the variable to be tested
+- `operator` is a `String` indicating the comparison operator to use: `<`, `==` (equal), `>`, `!=` (different)
+- `value` is a `String` or a `Float` indicating the thing to compare the variable to, it can be a numerical value or the name of another variable
+- `scene` is a `String` indicating the name of the scene to jump to
+- `label` (optional) is a `String` indicating the name of the label in the scene to jump to
+
+```ruby
+conditional_jump 'variable_1', '<', 10, 'Scene two'
+conditional_jump 'variable_1', '=', 'variable_2', 'Scene two', 'Label three'
+```
+
+#### `jump` Jump to somewhere
+
+`jump(scene, label)`
+- `scene` is a `String` indicating the name of the scene to jump to
+- `label` (optional) is a `String` indicating the name of the label in the scene to jump to
+
+```ruby
+jump 'Scene two'
+jump 'Scene two', 'Label three'
+```
+
+### Variables
+
+#### `declare_variable` Declare a variable
+
+`declare_variable(variable_name, initial_value)` 
+- `variable_name` is a `String` representing the variable name
+- `initial_value` is a `Float` representing the variable initial value
+
+```ruby
+declare_variable 'happiness', 25
+```
+
+#### `update_variable` Update a variable
+
+`update_variable(variable_name, operation, value)` 
+- `variable_name` is a `String` representing the variable name
+- `operator` is a `String` indicating the operation to apply
+  - `=` set the variable with the value
+  - `+=` add the value to the variable
+  - `-=` substract the value from the variable
+  - `*=` multiply the value with the variable
+  - `/=` divide the value with the variable
+  - `%=` set the variable with the reminder of the division with the value
+- `value` is a `String` or a `Float` indicating the thing to use as a value, it can be a numerical value or the name of another variable
+
+```ruby
+update_variable 'happiness', '=', 25
+update_variable 'happiness', '+', 'calmness'
+```
+
+### Misc
+
+#### `hide_message_window` Hide the message window
+
+`hide_message_window`
+
+```ruby
+hide_message_window
+```
+
+#### `include_file` Include a file
+
+`include_file(file_name)`
+- `name` is a `file_name` representing the file to include
+
+```ruby
+include_file('other_scene.rb')
+```
+
+#### `show_message_window` Show the message window
+
+`show_message_window`
+
+```ruby
+show_message_window
+```
+
+#### `start_scene` Start a new scene
+
+`start_scene(name)` 
+- `name` is a `String` representing the scene's name
+
+```ruby
+start_scene 'First scene'
+```
+
+## How the thing works
+
+The tool works like a two passes compiler:
+- the first pass validates the syntax, the entry point is in `parser.rb`
+- the second generate the content, the entry point is in `writer.rb`
+- the content is applied to disk
+
+## Links
+
+- http://tyranobuilder.com/tyranoscript-tags-reference/ : the TyranoScript tags references
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at 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.
+
+
+## License
+
+The code is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+desc 'Run tests'
+task :default => :test

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/tyrano_dsl.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+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'
+end
+tyrano_project_path = ARGV[0]
+dsl_file_path = ARGV[1]
+
+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)
+end