47 |
161 |
162 |
163 |
--------------------------------------------------------------------------------
/web/build/escape-from-earth.tw2:
--------------------------------------------------------------------------------
1 | ::StoryTitle
2 | Escape from Earth
3 |
4 | ::Start
5 | There are only hours left before the asteroid hits and, if the news is to be believed, all life on Earth is extinguished. The spaceship is fuelled-up and [[ready to go->Ready]], but after all the rush of the last few weeks, you don't feel like you've had a chance to say goodbye to the planet that's been your home your entire life. [[Your father->Father]] glances over to check that you're heading into the vessel as he shepherds [[the family dog->Dog]]'s out of the hangar door. Behind the barriers, [[your sister->Sister]] gives a sad wave, clutching a photo in her hand.
6 |
7 | ::Ready
8 | You've still got a few seconds before you absolutely have to [[get on board->Board]], if you'd like to go and [[help your father->Father]], say goodbye to [[the family dog->Dog]], or check up on [[your sister->Sister]], who you're having to leave behind.
9 |
10 | ::Board
11 | No, you decide, the time for goodbyes has passed. After your weeks of preparation for the journey through space you don't feel the need to tie yourself to Earth any more-strongly than you have to: it's already hard enough to let go. One at a time, you climb the steps into the rocket ship and find your seat. You close the blind that cover your tiny circular window and take a deep breath. Letting go isn't easy, but there's no reason you should make it harder for yourself.
12 |
13 | **THE END**
14 |
15 | ::Father
16 | You run to help your father with the dog, trying in vain to keep your mind occupied by anything but the evacuation. Wordlessly, you walk together to the door and hand over the dog's lead to the armed guard there. For a moment, you feel bad about leaving him with a stranger, but in six hours it won't matter anyway. Looking out through the hangar door, you feel a momentary pang of jealousy for those left behind: they get to [[watch one final sunrise together->Sunrise]]... meanwhile, you and the other "lucky" ten-thousand survivors will be [[in orbit->Orbit]], weightless but still weighed-down by your grief over the billions of deaths below.
17 |
18 | ::Sunrise
19 | It's an impulsive moment and you might not live to regret it, but right now, it's the right choice: as the guard is distracted by the dog, you duck under the barrier and run out into the cold night. Minutes later, you hear the deafening boom of the rocket lifting off, and you know that you're among those left on Earth. You find your sister and your mother and exchange hugs. Then, in quiet contemplation, you sit and watch your final sunrise as the first meteor fragments graze the sky.
20 |
21 | **THE END**
22 |
23 | ::Orbit
24 | Who is making the greater sacrifice, you wonder? Those billions who will die here on Earth, today, or the ten thousand evacuees who are to make their way to the Martian colony? But it's about more than sacrifice: it's about duty. Your age, gender, and health made you eligible for the lottery; your father was chosen for his expertise as a scientist. Now you owe it to your species and to those you leave behind to continue humankind's legacy. The rocket blasts off, and you look back through the window to see the lights of the planet below, artificially-lit for the last time.
25 |
26 | **THE END**
27 |
28 | ::Dog
29 | The old family dog's been your faithful friend for years, and it feels wrong to leave without saying goodbye. You almost envy him that he doesn't know what's coming for him and all of the humans that will be left behind. Suddenly, you're [[overcome with emotion->Emotion]]: everything you'd pushed down inside you since you heard the news that you'd won the evacuation lottery, last month, comes welling to the surface. Your father wraps his arms around your shoulders and gives you [[a squeeze of support->Support]], bringing your focus back to what must be done.
30 |
31 | ::Emotion
32 | It's no use trying to hide it any longer. You can't hold back the tears. Each wave of grief is followed by a wave of guilt: why should it be you that survives when so many others face almost-certain death? And then, once again, grief at the loss of everything you know and love. Your legs buckle, and the dog tries to comfort you, but he doesn't understand. It's your father who eventually helps you to your feet and back towards the rocket ship. You can't bring yourself to look back as you climb the steps, using all of your emotional energy just to make it onto the craft. You'll never recover from this suffering, you're sure of it.
33 |
34 | **THE END**
35 |
36 | ::Support
37 | "Goodbye, boy," you say, scratching the dog behind the ears. He looks up at you with concern in his eyes, sensing your discomfort, and you try to make your voice as reassuring as possible. What does it say about you, you wonder, that your last words on Earth were to an animal? Later, in the shuttle, you'll lose the last of your emotional reserves and break down: but for now, you need to be strong. You are the face of hope for the future of the human race, and it's time to take your place on Mars.
38 |
39 | **THE END**
40 |
41 | ::Sister
42 | In violation of the rules you were told as you entered the hangar, you turn and sprint across to your sister at the barriers. Reaching over the fence and with tears in your eyes, you give her one last hug. You try [[not to think->Hold On]] about the fact that this time, when you let go, you'll be letting go forever. She clutches you tight, and you can feel [[the photo->Photo]] in her hand scrape against the back of your neck.
43 |
44 | ::Hold On
45 | You're still locked in an embrace when the armed guard comes and separates you. You know that you shouldn't have, but you couldn't have left without saying that one last goodbye. You're shepherded swiftly onto the spaceship, and you're disappointed to disover that your window doesn't look in the direction of the crowd. You'd had this romantic idea that you'd be able to look back on your sister as you took off, but it wasn't to be. The rockets ingnite, and you take a deep breath. Here begins the first chapter of your new life, and ends the last chapter of your old one.
46 |
47 | **THE END**
48 |
49 | ::Photo
50 | "I wanted you to take this," your sister says, thrusting the photo into your hands. You recognise the photo: you took it at arms-reach to capture the pair of you, sitting out on the grass under a starry sky while, in the background, your father shows off a telescope to a group of onlookers. You stuff it into your pocket before the security guard arrives to shepherd you back towards the rocket ship. Weeks later, you'll frame it in your new home on Mars, and it will come to represent everything that you left behind in order to be there. But right now, all you want is one final hug before takeoff.
51 |
52 | **THE END**
53 |
--------------------------------------------------------------------------------
/web/source/escape-from-earth.tw2:
--------------------------------------------------------------------------------
1 | ::StoryTitle
2 | Escape from Earth
3 |
4 | ::Start
5 | There are only hours left before the asteroid hits and, if the news is to be believed, all life on Earth is extinguished. The spaceship is fuelled-up and [[ready to go->Ready]], but after all the rush of the last few weeks, you don't feel like you've had a chance to say goodbye to the planet that's been your home your entire life. [[Your father->Father]] glances over to check that you're heading into the vessel as he shepherds [[the family dog->Dog]]'s out of the hangar door. Behind the barriers, [[your sister->Sister]] gives a sad wave, clutching a photo in her hand.
6 |
7 | ::Ready
8 | You've still got a few seconds before you absolutely have to [[get on board->Board]], if you'd like to go and [[help your father->Father]], say goodbye to [[the family dog->Dog]], or check up on [[your sister->Sister]], who you're having to leave behind.
9 |
10 | ::Board
11 | No, you decide, the time for goodbyes has passed. After your weeks of preparation for the journey through space you don't feel the need to tie yourself to Earth any more-strongly than you have to: it's already hard enough to let go. One at a time, you climb the steps into the rocket ship and find your seat. You close the blind that cover your tiny circular window and take a deep breath. Letting go isn't easy, but there's no reason you should make it harder for yourself.
12 |
13 | **THE END**
14 |
15 | ::Father
16 | You run to help your father with the dog, trying in vain to keep your mind occupied by anything but the evacuation. Wordlessly, you walk together to the door and hand over the dog's lead to the armed guard there. For a moment, you feel bad about leaving him with a stranger, but in six hours it won't matter anyway. Looking out through the hangar door, you feel a momentary pang of jealousy for those left behind: they get to [[watch one final sunrise together->Sunrise]]... meanwhile, you and the other "lucky" ten-thousand survivors will be [[in orbit->Orbit]], weightless but still weighed-down by your grief over the billions of deaths below.
17 |
18 | ::Sunrise
19 | It's an impulsive moment and you might not live to regret it, but right now, it's the right choice: as the guard is distracted by the dog, you duck under the barrier and run out into the cold night. Minutes later, you hear the deafening boom of the rocket lifting off, and you know that you're among those left on Earth. You find your sister and your mother and exchange hugs. Then, in quiet contemplation, you sit and watch your final sunrise as the first meteor fragments graze the sky.
20 |
21 | **THE END**
22 |
23 | ::Orbit
24 | Who is making the greater sacrifice, you wonder? Those billions who will die here on Earth, today, or the ten thousand evacuees who are to make their way to the Martian colony? But it's about more than sacrifice: it's about duty. Your age, gender, and health made you eligible for the lottery; your father was chosen for his expertise as a scientist. Now you owe it to your species and to those you leave behind to continue humankind's legacy. The rocket blasts off, and you look back through the window to see the lights of the planet below, artificially-lit for the last time.
25 |
26 | **THE END**
27 |
28 | ::Dog
29 | The old family dog's been your faithful friend for years, and it feels wrong to leave without saying goodbye. You almost envy him that he doesn't know what's coming for him and all of the humans that will be left behind. Suddenly, you're [[overcome with emotion->Emotion]]: everything you'd pushed down inside you since you heard the news that you'd won the evacuation lottery, last month, comes welling to the surface. Your father wraps his arms around your shoulders and gives you [[a squeeze of support->Support]], bringing your focus back to what must be done.
30 |
31 | ::Emotion
32 | It's no use trying to hide it any longer. You can't hold back the tears. Each wave of grief is followed by a wave of guilt: why should it be you that survives when so many others face almost-certain death? And then, once again, grief at the loss of everything you know and love. Your legs buckle, and the dog tries to comfort you, but he doesn't understand. It's your father who eventually helps you to your feet and back towards the rocket ship. You can't bring yourself to look back as you climb the steps, using all of your emotional energy just to make it onto the craft. You'll never recover from this suffering, you're sure of it.
33 |
34 | **THE END**
35 |
36 | ::Support
37 | "Goodbye, boy," you say, scratching the dog behind the ears. He looks up at you with concern in his eyes, sensing your discomfort, and you try to make your voice as reassuring as possible. What does it say about you, you wonder, that your last words on Earth were to an animal? Later, in the shuttle, you'll lose the last of your emotional reserves and break down: but for now, you need to be strong. You are the face of hope for the future of the human race, and it's time to take your place on Mars.
38 |
39 | **THE END**
40 |
41 | ::Sister
42 | In violation of the rules you were told as you entered the hangar, you turn and sprint across to your sister at the barriers. Reaching over the fence and with tears in your eyes, you give her one last hug. You try [[not to think->Hold On]] about the fact that this time, when you let go, you'll be letting go forever. She clutches you tight, and you can feel [[the photo->Photo]] in her hand scrape against the back of your neck.
43 |
44 | ::Hold On
45 | You're still locked in an embrace when the armed guard comes and separates you. You know that you shouldn't have, but you couldn't have left without saying that one last goodbye. You're shepherded swiftly onto the spaceship, and you're disappointed to disover that your window doesn't look in the direction of the crowd. You'd had this romantic idea that you'd be able to look back on your sister as you took off, but it wasn't to be. The rockets ingnite, and you take a deep breath. Here begins the first chapter of your new life, and ends the last chapter of your old one.
46 |
47 | **THE END**
48 |
49 | ::Photo
50 | "I wanted you to take this," your sister says, thrusting the photo into your hands. You recognise the photo: you took it at arms-reach to capture the pair of you, sitting out on the grass under a starry sky while, in the background, your father shows off a telescope to a group of onlookers. You stuff it into your pocket before the security guard arrives to shepherd you back towards the rocket ship. Weeks later, you'll frame it in your new home on Mars, and it will come to represent everything that you left behind in order to be there. But right now, all you want is one final hug before takeoff.
51 |
52 | **THE END**
53 |
--------------------------------------------------------------------------------
/lib/twee2/story_file.rb:
--------------------------------------------------------------------------------
1 | require 'rubygems'
2 | require 'haml'
3 | require 'coffee_script'
4 | require 'sass'
5 | require 'builder'
6 |
7 | module Twee2
8 | class StoryFileNotFoundException < Exception; end
9 |
10 | class StoryFile
11 | attr_accessor :passages
12 | attr_reader :child_story_files
13 |
14 | HAML_OPTIONS = {
15 | remove_whitespace: true
16 | }
17 | Tilt::CoffeeScriptTemplate.default_bare = true # bare mode for HAML :coffeescript blocks
18 | COFFEESCRIPT_OPTIONS = {
19 | bare: true
20 | }
21 |
22 | # Loads the StoryFile with the given name
23 | def initialize(filename)
24 | raise(StoryFileNotFoundException) if !File::exists?(filename)
25 | @passages, current_passage = {}, nil
26 | @child_story_files = []
27 |
28 | # Load file into memory to begin with
29 | lines = File::read(filename).split(/\r?\n/)
30 | # First pass - go through and perform 'includes'
31 | i, in_story_includes_section = 0, false
32 | while i < lines.length
33 | line = lines[i]
34 | if line =~ /^:: *StoryIncludes */
35 | in_story_includes_section = true
36 | elsif line =~ /^::(?!@)/
37 | in_story_includes_section = false
38 | elsif in_story_includes_section && (line.strip != '')
39 | child_file = line.strip
40 | # include a file here because we're in the StoryIncludes section
41 | if File::exists?(child_file)
42 | lines.push(*File::read(child_file).split(/\r?\n/)) # add it on to the end
43 | child_story_files.push(child_file)
44 | else
45 | puts "WARNING: tried to include file '#{line.strip}' via StoryIncludes but file was not found."
46 | end
47 | elsif line =~ /^( *)::@include (.*)$/
48 | # include a file here because an @include directive was spotted
49 | prefix, filename = $1, $2.strip
50 | if File::exists?(filename)
51 | lines[i,1] = File::read(filename).split(/\r?\n/).map{|l|"#{prefix}#{l}"} # insert in-place, with prefix of appropriate amount of whitespace
52 | i-=1 # process this line again, in case of ::@include nesting
53 | else
54 | puts "WARNING: tried to ::@include file '#{filename}' but file was not found."
55 | end
56 | end
57 | i+=1
58 | end
59 | # Second pass - parse the file
60 | lines.each do |line|
61 | if line =~ /^:: *([^\[]*?) *(\[(.*?)\])? *(<(.*?)>)? *$/
62 | @passages[current_passage = $1.strip] = { tags: ($3 || '').split(' '), position: $5, content: '', exclude_from_output: false, pid: nil}
63 | elsif current_passage
64 | @passages[current_passage][:content] << "#{line}\n"
65 | end
66 | end
67 | @passages.each_key{|k| @passages[k][:content].strip!} # Strip excessive trailing whitespace
68 | # Run each passage through a preprocessor, if required
69 | run_preprocessors
70 | # Extract 'special' passages and mark them as not being included in output
71 | story_css, pid, @story_js, @story_start_pid, @story_start_name = '', 0, '', nil, 'Start'
72 | @passages.each_key do |k|
73 | if k == 'StoryTitle'
74 | Twee2::build_config.story_name = @passages[k][:content]
75 | @passages[k][:exclude_from_output] = true
76 | elsif k == 'StoryIncludes'
77 | @passages[k][:exclude_from_output] = true # includes should already have been handled above
78 | elsif @passages[k][:tags].include? 'stylesheet'
79 | story_css << "#{@passages[k][:content]}\n"
80 | @passages[k][:exclude_from_output] = true
81 | elsif @passages[k][:tags].include? 'script'
82 | @story_js << "#{@passages[k][:content]}\n"
83 | @passages[k][:exclude_from_output] = true
84 | elsif @passages[k][:tags].include? 'twee2'
85 | eval @passages[k][:content]
86 | @passages[k][:exclude_from_output] = true
87 | else
88 | @passages[k][:pid] = (pid += 1)
89 | end
90 | end
91 | @story_start_pid = (@passages[@story_start_name] || {pid: 1})[:pid]
92 | # Generate XML in Twine 2 format
93 | @story_data = Builder::XmlMarkup.new
94 | # TODO: what is tw-storydata's "options" attribute for?
95 | @story_data.tag!('tw-storydata', {
96 | name: Twee2::build_config.story_name,
97 | startnode: @story_start_pid,
98 | creator: 'Twee2',
99 | 'creator-version' => Twee2::VERSION,
100 | ifid: Twee2::build_config.story_ifid,
101 | format: '{{STORY_FORMAT}}',
102 | options: ''
103 | }) do
104 | @story_data.style(story_css, role: 'stylesheet', id: 'twine-user-stylesheet', type: 'text/twine-css')
105 | @story_data.script('{{STORY_JS}}', role: 'script', id: 'twine-user-script', type: 'text/twine-javascript')
106 | @passages.each do |k,v|
107 | unless v[:exclude_from_output]
108 | @story_data.tag!('tw-passagedata', { pid: v[:pid], name: k, tags: v[:tags].join(' '), position: v[:position] }, v[:content])
109 | end
110 | end
111 | end
112 | end
113 |
114 | # Returns the rendered XML that represents this story
115 | def xmldata
116 | data = @story_data.target!
117 | data.gsub('{{STORY_JS}}', @story_js)
118 | end
119 |
120 | # Runs HAML, Coffeescript etc. preprocessors across each applicable passage
121 | def run_preprocessors
122 | @passages.each_key do |k|
123 | # HAML
124 | if @passages[k][:tags].include? 'haml'
125 | @passages[k][:content] = Haml::Engine.new(@passages[k][:content], HAML_OPTIONS).render
126 | @passages[k][:tags].delete 'haml'
127 | end
128 | # Coffeescript
129 | if @passages[k][:tags].include? 'coffee'
130 | @passages[k][:content] = CoffeeScript.compile(@passages[k][:content], COFFEESCRIPT_OPTIONS)
131 | @passages[k][:tags].delete 'coffee'
132 | end
133 | # SASS / SCSS
134 | if @passages[k][:tags].include? 'sass'
135 | @passages[k][:content] = Sass::Engine.new(@passages[k][:content], :syntax => :sass).render
136 | end
137 | if @passages[k][:tags].include? 'scss'
138 | @passages[k][:content] = Sass::Engine.new(@passages[k][:content], :syntax => :scss).render
139 | end
140 | end
141 | end
142 | end
143 | end
144 |
--------------------------------------------------------------------------------
/web/source/index.html.haml:
--------------------------------------------------------------------------------
1 | ---
2 | title: Interactive Fiction for Power Users
3 | ---
4 |
5 | .page-header
6 | .row.jumbotron
7 | .col-sm-8.col-xs-12
8 | %h1 Twee2
9 | .lead
10 | Interactive Fiction for Power Users, powered by
11 | %a{href: 'http://twinery.org'} Twine
12 | %ul.list-inline{style: 'line-height: 4em;'}
13 | %li
14 | %a.btn.btn-primary.btn-lg{role: 'button', href: 'install.html'}
15 | %span.glyphicon.glyphicon-cloud-download{aria: { hidden: true }}
16 | Install Twee2
17 | %li
18 | %a.btn.btn-default.btn-lg{role: 'button', href: 'tutorial.html'}
19 | %span.glyphicon.glyphicon-time{aria: { hidden: true }}
20 | 2-minute tutorial
21 | %li
22 | %a.btn.btn-default.btn-lg{role: 'button', href: 'documentation.html'}
23 | %span.glyphicon.glyphicon-book{aria: { hidden: true }}
24 | Documentation
25 | %li
26 | %a.btn.btn-default.btn-lg{role: 'button', href: 'https://github.com/Dan-Q/twee2'}
27 | %span.glyphicon.glyphicon-link{aria: { hidden: true }}
28 | Source
29 | .col-sm-4.hidden-xs
30 | %img.img-responsive{src: 'images/twee2-logo.png', alt: 'Twee2 Logo'}
31 |
32 | .row
33 | .col-sm-12
34 | %h2 What is Twee2?
35 | %p
36 | Twee2 is a system for writing web-based interactive fiction in the
37 | %a{href: 'https://en.wikipedia.org/wiki/Choose_Your_Own_Adventure', title: 'Wikipedia article: Choose Your Own Adventure'} "Choose Your Own Adventure"
38 | style (but it can do a lot more than that, too). It's built on top of
39 | = succeed ',' do
40 | %a{href: 'http://twinery.org', title: 'Twine'} Twine
41 | but instead of Twine's graphical editing system Twee2 works with your favourite text editor and
42 | tools, making it more-suitable for power users, advanced Twine authors, and those with a programming background.
43 |
44 | %h2 What does it look like?
45 |
46 | .row
47 | .col-md-6
48 | .panel.panel-primary
49 | .panel-heading Code
50 | .panel-body
51 | %pre
52 | :preserve
53 | ::StoryTitle
54 | Choosing Your Own CYOA
55 |
56 | ::Start
57 | ### Choose Your Own CYOA
58 | #### A demonstrative adventure
59 |
60 | You sit at your computer and contemplate how you're going to
61 | write your next HTML adventure game. You wrote your last one
62 | [using Twine->Twine], but you've heard good things about
63 | [Twee2], as well.
64 |
65 | ::Twine
66 | You decide to stick with what you know and use Twine. That's
67 | fine: it's a great system and it's easy to use, especially
68 | for beginners. Maybe next time you'll be ready to try Twee2!
69 |
70 | **THE END**
71 |
72 | [Play again?->Start]
73 |
74 | ::Twee2
75 | You decide to write your latest adventure using Twee2. You
76 | find that you're able to use all of the things you're
77 | familiar with from Twine, but you also get to use your
78 | favourite text editor, break up your work into multiple
79 | files, mark up content using modern languages, and preview
80 | in a separate browser while you work.
81 |
82 | **THE END**
83 |
84 | [Play again?->Start]
85 |
86 | .col-md-6
87 | .panel.panel-primary
88 | .panel-heading Output
89 | .panel-body
90 | .embed-responsive.embed-responsive-4by3
91 | %iframe.embed-responsive-item{src: 'eg1.html'}
92 |
93 | .row
94 | .col-sm-12
95 | %h2 How does it compare to Twine?
96 | %p
97 | Twee2 and Twine 2 produce
98 | %em the same
99 | output. They differ only in how you, the author, work to produce that output:
100 |
101 | %table.table.table-bordered
102 | %thead
103 | %tr
104 | %th.warning
105 | Feature
106 | %th
107 | Twine 2
108 | %th.success
109 | Twee2
110 | %tbody
111 | %tr
112 | %th.warning.text-right Editor
113 | %td Web-based "drag-and-drop" editor
114 | %td.success Your favourite text editor
115 | %tr
116 | %th.warning.text-right Story formats supported
117 | %td Harlowe, Paperthin, Snowman, SugarCube, and any custom ones you add
118 | %td.success Harlowe, Paperthin, Snowman, SugarCube, and any custom ones you add
119 | %tr
120 | %th.warning.text-right Files saved to...
121 | %td Twine 2's own store (can be exported elsewhere)
122 | %td.success Wherever you like
123 | %tr
124 | %th.warning.text-right Inputs
125 | %td Twine 2 files
126 | %td.success Twee2 files, Twee files, Twine 2 files (except on Windows)
127 | %tr
128 | %th.warning.text-right Outputs
129 | %td Twine 2 web pages
130 | %td.success Twine 2 web pages
131 | %tr
132 | %th.warning.text-right Supported formatting languages
133 | %td Markdown
134 | %td.success Markdown, HAML
135 | %tr
136 | %th.warning.text-right Supported additional languages
137 | %td CSS, Javascript
138 | %td.success CSS, Javascript, SASS/SCSS, Coffeescript
139 | %tr
140 | %th.warning.text-right Simultaneous working
141 | %td No
142 | %td.success Yes, using includes and/or source control
143 | %tr
144 | %th.warning.text-right Source control support
145 | %td No/barely
146 | %td.success Yes, use your favourite source control
147 | %tr
148 | %th.warning.text-right Can split work into multiple files
149 | %td No
150 | %td.success Yes
151 | %tr
152 | %th.warning.text-right Regeneration-on-save
153 | %td No
154 | %td.success Yes, with 'watch' command
155 |
156 | %ul
157 | %li
158 | Twine is better for people new to writing interactive fiction and to programming
159 | in general, or those who prefer a visual interface.
160 | %li
161 | Twee2 is better for people experienced in writing interactive fiction and/or other
162 | kinds of programming, or who prefer a text interface.
163 |
164 | .row
165 | .col-md-8.col-md-offset-2
166 | .well
167 | %h3 Get started!
168 | %ul.list-inline{style: 'line-height: 4em;'}
169 | %li
170 | %a.btn.btn-primary.btn-lg{role: 'button', href: 'install.html'}
171 | %span.glyphicon.glyphicon-cloud-download{aria: { hidden: true }}
172 | Install Twee2
173 | %li
174 | %a.btn.btn-default.btn-lg{role: 'button', href: 'tutorial.html'}
175 | %span.glyphicon.glyphicon-time{aria: { hidden: true }}
176 | 2-minute tutorial
177 | %li
178 | %a.btn.btn-default.btn-lg{role: 'button', href: 'documentation.html'}
179 | %span.glyphicon.glyphicon-book{aria: { hidden: true }}
180 | Documentation
181 | %li
182 | %a.btn.btn-default.btn-lg{role: 'button', href: 'https://github.com/Dan-Q/twee2'}
183 | %span.glyphicon.glyphicon-link{aria: { hidden: true }}
184 | Source
185 |
--------------------------------------------------------------------------------
/storyFormats/Paperthin/icon.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/web/build/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
48 |
63 |
49 |
62 | Installing Twee2
50 |Prerequisites
51 |52 | Twee2 requires 53 | Ruby 54 | version 2.0 or higher. You can check whether Ruby is installed and what version it is 55 | by opening up a command prompt or terminal and running: 56 |
57 |ruby -v58 |
59 | If you don't have Ruby installed, there are several ways to easily install it. Here are some quick ways: 60 |
61 |
64 |
100 |
65 |
75 |
66 |
74 | Windows
67 |68 | Download RubyInstaller 69 |
70 |71 | Note that the 'decompile' feature, which turns Twine 2 story files into Twee2 source code, is not supported on Windows. 72 |
73 |
76 |
87 |
77 |
86 | MacOS
78 |79 | MacOS comes with Ruby, but it's usually out-of-date. 80 | 81 | Install a modern version 82 | 83 | using RVM. 84 |
85 |
88 |
99 |
89 |
98 | Linux
90 |91 | Many Linux distributions have packages for Ruby, but it's often out-of-date. 92 | Install 93 | RVM 94 | and use it to get Ruby 2.1.6 by running: 95 |
96 |gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3
\curl -sSL https://get.rvm.io | bash -s stable --ruby=2.1.6
rvm use 2.1.6 --default
97 |
101 |
119 |
102 |
118 | Installing Twee2
103 |104 | To install Twee2, open a command prompt or terminal and type: 105 |
106 |gem install twee2107 |
108 | You can check that it's installed correctly by running: 109 |
110 |twee2111 |
112 | Now you're ready to dive into the 113 | two-minute tutorial 114 | or the 115 | full documentation. 116 |
117 |
120 |
135 |
160 |
121 |
127 | Uninstalling Twee2
122 |123 | If you ever want to uninstall Twee2, simply run: 124 |
125 |gem uninstall twee2126 |
128 |
134 | Source code
129 |130 | Twee2 is open-source, which means you can read and change its code for yourself. 131 | Get the code on GitHub. 132 |
133 |
47 |
272 |
273 |
274 |
--------------------------------------------------------------------------------
/web/build/tutorial.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
48 |
87 |
49 |
86 |
50 |
82 |
85 | Twee2
51 |
52 | Interactive Fiction for Power Users, powered by
53 | Twine
54 |
55 | -
56 |
- 57 | 58 | 59 | Install Twee2 60 | 61 | 62 |
- 63 | 64 | 65 | 2-minute tutorial 66 | 67 | 68 |
- 69 | 70 | 71 | Documentation 72 | 73 | 74 |
- 75 | 76 | 77 | Source 78 | 79 | 80 |
84 |
88 |
101 |
89 |
100 | What is Twee2?
90 |91 | Twee2 is a system for writing web-based interactive fiction in the 92 | "Choose Your Own Adventure" 93 | style (but it can do a lot more than that, too). It's built on top of 94 | Twine, 95 | but instead of Twine's graphical editing system Twee2 works with your favourite text editor and 96 | tools, making it more-suitable for power users, advanced Twine authors, and those with a programming background. 97 |
98 |What does it look like?
99 |
102 |
121 |
103 |
110 |
104 |
109 | Code
105 |
106 |
108 | ::StoryTitle Choosing Your Own CYOA ::Start ### Choose Your Own CYOA #### A demonstrative adventure You sit at your computer and contemplate how you're going to write your next HTML adventure game. You wrote your last one [using Twine->Twine], but you've heard good things about [Twee2], as well. ::Twine You decide to stick with what you know and use Twine. That's fine: it's a great system and it's easy to use, especially for beginners. Maybe next time you'll be ready to try Twee2! **THE END** [Play again?->Start] ::Twee2 You decide to write your latest adventure using Twee2. You find that you're able to use all of the things you're familiar with from Twine, but you also get to use your favourite text editor, break up your work into multiple files, mark up content using modern languages, and preview in a separate browser while you work. **THE END** [Play again?->Start]107 |
111 |
120 |
112 |
119 | Output
113 |
114 |
117 |
118 |
122 |
213 |
123 |
130 |
131 |
201 |
212 | How does it compare to Twine?
124 |125 | Twee2 and Twine 2 produce 126 | the same 127 | output. They differ only in how you, the author, work to produce that output: 128 |
129 || 133 | Feature 134 | | 135 |136 | Twine 2 137 | | 138 |139 | Twee2 140 | | 141 |
|---|---|---|
| Editor | 146 |Web-based "drag-and-drop" editor | 147 |Your favourite text editor | 148 |
| Story formats supported | 151 |Harlowe, Paperthin, Snowman, SugarCube, and any custom ones you add | 152 |Harlowe, Paperthin, Snowman, SugarCube, and any custom ones you add | 153 |
| Files saved to... | 156 |Twine 2's own store (can be exported elsewhere) | 157 |Wherever you like | 158 |
| Inputs | 161 |Twine 2 files | 162 |Twee2 files, Twee files, Twine 2 files (except on Windows) | 163 |
| Outputs | 166 |Twine 2 web pages | 167 |Twine 2 web pages | 168 |
| Supported formatting languages | 171 |Markdown | 172 |Markdown, HAML | 173 |
| Supported additional languages | 176 |CSS, Javascript | 177 |CSS, Javascript, SASS/SCSS, Coffeescript | 178 |
| Simultaneous working | 181 |No | 182 |Yes, using includes and/or source control | 183 |
| Source control support | 186 |No/barely | 187 |Yes, use your favourite source control | 188 |
| Can split work into multiple files | 191 |No | 192 |Yes | 193 |
| Regeneration-on-save | 196 |No | 197 |Yes, with 'watch' command | 198 |
-
202 |
- 203 | Twine is better for people new to writing interactive fiction and to programming 204 | in general, or those who prefer a visual interface. 205 | 206 |
- 207 | Twee2 is better for people experienced in writing interactive fiction and/or other 208 | kinds of programming, or who prefer a text interface. 209 | 210 |
214 |
246 |
271 |
215 |
245 |
216 |
244 | Get started!
217 |-
218 |
- 219 | 220 | 221 | Install Twee2 222 | 223 | 224 |
- 225 | 226 | 227 | 2-minute tutorial 228 | 229 | 230 |
- 231 | 232 | 233 | Documentation 234 | 235 | 236 |
- 237 | 238 | 239 | Source 240 | 241 | 242 |
47 |
201 |
202 |
203 |
--------------------------------------------------------------------------------
/web/source/documentation.html.haml:
--------------------------------------------------------------------------------
1 | ---
2 | title: Full documentation
3 | ---
4 |
5 | .row
6 | .col-sm-3.col-sm-push-9
7 | %h2 Index
8 | %ul
9 | %li
10 | %a{href: '#relationship-to-twine'} Relationship to Twine
11 | %li
12 | %a{href: '#writing-code'} Writing and compiling code
13 | %li
14 | %a{href: '#story-formats'} Understanding story formats
15 | %li
16 | %a{href: '#twee2-syntax'} Twee2 syntax
17 | %ul
18 | %li
19 | %a{href: '#twee2-syntax-passages'} Passages
20 | %li
21 | %a{href: '#twee2-syntax-content'} Content
22 | %li
23 | %a{href: '#twee2-syntax-special-passages'} Special passages
24 | %li
25 | %a{href: '#includes'} Splitting your code into multiple files
26 | %li
27 | %a{href: '#build-config'} Setting build configuration options
28 | %li
29 | %a{href: '#decompiler'} Decompiling Twine 2 stories
30 |
31 | .col-sm-9.col-sm-pull-3
32 | %h1 Full documentation
33 |
34 | %h2#relationship-to-twine Relationship to Twine
35 | %p
36 | Twee2 is built on top of
37 | = succeed ',' do
38 | %a{href: 'http://twinery.org/'} Twine 2
39 | minus the graphical user interface. As a result, virtually all of the
40 | %a{href: 'http://twinery.org/wiki/twine2:guide'} documentation about Twine 2
41 | (and specifically the documentation about the
42 | = succeed ')' do
43 | %a{href: 'http://twinery.org/wiki/twine2:how_to_choose_a_story_format'} different story formats
44 | is relevant to Twee2, too.
45 | Because Twee2 is inspired by Twee, its documentation is also a valuable resource: however note that
46 | you can't use Twee 'macros' in Twee2.
47 |
48 | %h2#writing-code Writing and compiling code
49 | %p
50 | Write Twee2 code using your favourite text editor. Syntax highlighting is available via
51 | %a{href: 'https://github.com/monospaced/sublime-twee'} this Sublime Text plugin
52 | for Twee. By convention, Twee2 source files have the
53 | %code .tw2
54 | extension.
55 | %p
56 | Compile Twee2 files using the
57 | %code twee2
58 | command-line tool. There are two important modes of operation:
59 | %ul
60 | %li
61 | %code twee2 build input.tw2 output.html
62 | produces output.html based on the code in input.tw2
63 | %li
64 | %code twee2 watch input.tw2 output.html
65 | does the same thing, but
66 | %em watches
67 | input.tw2 for changes, automatically recompiling whenever it is updated (note that it's not
68 | smart enough to understand when
69 | %a{href: '#includes'} 'included'
70 | files have been changed, though).
71 | %p
72 | Because Twee2 source files are just plain text files, they're well-suited to use with
73 | source control systems: you could, for example, use
74 | %a{href: 'https://github.com/'} Github
75 | to share your code or to collaborate with other authors, even working on the same file.
76 |
77 | %h2#story-formats Understanding story formats
78 | %p
79 | Twee2 comes with built-in support for all of the same story formats that Twine 2 does:
80 | %ul
81 | %li
82 | %a{href: 'http://twine2.neocities.org/'} Harlowe
83 | \- the default format, which includes a simplified scripting format
84 | %li
85 | %a{href: 'https://bitbucket.org/klembot/snowman-2'} Snowman
86 | \- a minimal format that uses Underscore.js templates and jQuery to provide programmers with a powerful toolset
87 | %li
88 | %a{href: 'http://www.motoslave.net/sugarcube/'} SugarCube
89 | \- a TiddlyWiki-powered format that comes with support for multiple save 'slots' and a Twine 1/Twee 'macro'-like scripting syntax
90 | %li
91 | Paperthin - used when you select "View Proofing Copy" in Twine 2, this minimal skeleton isn't really an output format as it is a proofing tool
92 | %p
93 | If you've having difficulty choosing between them, there's
94 | %a{href: 'http://twinery.org/wiki/twine2:how_to_choose_a_story_format'} a summary of the differences
95 | in the Twine 2 documentation.
96 | %p
97 | To specify which format to use during compilation, use the optional
98 | %code --format
99 | parameter. E.g. you might type
100 | = succeed '.' do
101 | %code twee2 build input.tw2 output.html --format=Snowman
102 | You can get a list of the formats that Twee2 natively understands by running
103 | = succeed '.' do
104 | %code twee2 formats
105 | %p
106 | It's possible to use any story format, e.g. if you've downloaded or written your own, by specifying the path
107 | to the story format's directory (the one containing the format.js file) in your
108 | %code --format
109 | parameter. For example, you might run
110 | = succeed '.' do
111 | %code twee2 build input.tw2 output.html --format=./MyFormat
112 | %p
113 | Rather than setting the format on the command-line, it's possible to specify it within your source code
114 | itself, using
115 | %a{href: '#build-config'} build configuration
116 | options.
117 |
118 | %h2#twee2-syntax Twee2 syntax
119 | %p
120 | Twee2 uses a syntax that's heavily inspired-by but not 100% compatible with Twee:
121 |
122 | %h3#twee2-syntax-passages Passages
123 | %p
124 | Each block of text in Twee2 exists in a
125 | = succeed '.' do
126 | %em passage
127 | Each passage begins with a title, which is prefixed by two colons:
128 | %p
129 | %code ::My Passage Name
130 | %p
131 | Passage titles may only contain letters, numbers, basic punctuation, and spaces. Some authors prefer to avoid
132 | spaces in their passage titles. Passage titles are not case-sensitive: you don't have to use the same case when
133 | referring to a passage every time. Passages titles
134 | %em should
135 | be unique within a story: if they're not, only the last passage with a given title will be included in the story.
136 | %p
137 | Passage titles may optionally be suffixed by one or both of:
138 | %ul
139 | %li
140 | Any number of
141 | = succeed ',' do
142 | %em tags
143 | separated by spaced, inside a pair of square brackets. E.g:
144 | %br/
145 | %code ::My Passage Name [tagone tagtwo]
146 | %br/
147 | Tags can be used by code in your story (e.g. to send the player to a randomly-selected passage from a subset).
148 | = succeed ',' do
149 | %a{href: '#twee2-syntax-special-passages'} Some tags have special meanings
150 | as described below.
151 | %li
152 | A pair of coordinates, separated by a comma and enclosed within angle brackets. E.g.:
153 | %br/
154 | %code ::My Passage Name <123,456>
155 | %br/
156 | Coordinates have no meaning to Twee2, but they can be used to enhance compatability with Twine 2: Twine 2 uses
157 | these coordinates to decide where to show the passages in its WYSIWYG editor.
158 | %p
159 | If you include both tags and coordinates after a passage, the tags must come before the coordinates, e.g.:
160 | %p
161 | %code ::My Passage Name [tagone tagtwo] <123,456>
162 | %p
163 | Some passages and tags
164 | = succeed ',' do
165 | %a{href: '#twee2-syntax-special-passages'} have special meanings
166 | as described below
167 |
168 | %h3#twee2-syntax-content Content
169 | %p
170 | Each passage may contain any amount of content, most of which will be stuff that the player sees. Many
171 | story formats understand
172 | %em Markdown
173 | formatting in passages, which makes it possible to easily add formatting to your passages. Links to different
174 | passages are supported in any of the following syntaxes (where 'Dungeon' is the name of the passage they'll be
175 | transported if they click the link, and 'click here', where present, is the text that they'll see to click on):
176 | %ul
177 | %li
178 | %code [Dungeon]
179 | %li
180 | %code [click here->Dungeon]
181 | %li
182 | %code [Dungeon<-click here]
183 | %li
184 | %code [click here|Dungeon]
185 |
186 | %h2#twee2-syntax-special-passages Special passages
187 | %p
188 | Some passage names and tags have special meanings. These are:
189 |
190 | %h3 ::Start
191 | %p
192 | The
193 | %code ::Start
194 | passage will, by default, be used as the initial passage that your player sees when they start reading.
195 | You can override this using
196 | = succeed ',' do
197 | %a{href: '#build-config'} build configuration options
198 | but it's probably easier just to follow this convention.
199 |
200 | %h3 ::StorySubtitle, ::StoryAuthor, ::StoryMenu, and ::StorySettings
201 | %p
202 | These names were used for special passages in Twee 1. They're not used by Twee2, but to maintain compatability
203 | with Twee 1 they're ignored and you should avoid using them unless you're writing a story that needs to be
204 | capable of being compiled by both Twee 1 and Twee2.
205 |
206 | %h3 ::StoryIncludes
207 | %p
208 | Any
209 | %code ::StoryIncludes
210 | passages (you can have as many as you like, but you probably should avoid having more than one in any file in
211 | order to avoid confusion) are treated as lists of secondary Twee2 files to 'include' into your story. This is
212 | described in more detail below, under
213 | = succeed '.' do
214 | %a{href: '#includes'} splitting your code into multiple files
215 |
216 | %h3 [stylesheet]
217 | %p
218 | Any passages with the 'stylesheet' tag will not be included in your story, but their contents will be injected
219 | into the story's stylesheet. For example, you could write:
220 | %p
221 | %pre
222 | :preserve
223 | ::MyCoolStylesheet [stylesheet]
224 |
225 | body {
226 | background: #eee;
227 | }
228 |
229 | tw-passage tw-link {
230 | color: red;
231 | }
232 | %p
233 | It's also possible to use
234 | %a{href: 'http://sass-lang.com/'} SASS
235 | to enhance your stylesheet. Simply add the tag 'sass' or 'scss' to specify the dialect of SASS that you want
236 | to use, e.g.:
237 | %pre
238 | :preserve
239 | ::MyCoolStylesheet [scss stylesheet]
240 |
241 | body {
242 | background: #eee;
243 | }
244 |
245 | tw-passage {
246 | tw-link {
247 | color: red;
248 | }
249 | }
250 |
251 | %h3 [script]
252 | %p
253 | Any passages with the 'script' tag will not be included in your story, but their contents will be injected
254 | into the resulting web page as Javascript. For example, you could write:
255 | %p
256 | %pre
257 | :preserve
258 | ::SomeAwesomeCode [script]
259 |
260 | alert('This message will appear when the adventure starts!');
261 | %p
262 | It's also possible to use
263 | %a{href: 'http://coffeescript.org/'} Coffeescript
264 | to make your Javascript development more-beautiful. Simply add the tag 'coffee' to your script block:
265 | %pre
266 | :preserve
267 | ::SomeAwesomeCode [coffee script]
268 |
269 | alert 'This message will appear when the adventure starts!'
270 |
271 | %h3 [haml]
272 | %p
273 | Put the 'haml' tag into your regular passages in order to allow you to write
274 | %a{href: 'http://haml.info/'} HAML
275 | code into your passages. HAML is a sophisticated templating language for producing HTML output, and
276 | for some it might be preferable to writing plain old Markdown. This includes the ability to inject
277 | Javascript/CoffeeScript into particular passages. For example, you could write:
278 | %p
279 | %pre
280 | :preserve
281 | ::NicksBar [haml]
282 | %p
283 | Nick's Bar is exactly the kind of nightspot that helps you remember why you quit drinking.
284 | A depressed-looking barman pours another beer for an equally depressed-looking drunk, while
285 | over in the corner a street thug plays with a knife as he eyes you up. The floor is sticky
286 | and the air reeks of stale alcohol.
287 | %p
288 | %strong What would you like to do?
289 | %ul
290 | %li [Nick<-Talk to the bartender]
291 | %li [BarToilet<-Go to the bathroom]
292 | %li [BarSit<-Sit in a booth]
293 |
294 | :coffeescript
295 | $ ->
296 | alert "This message will appear when you reach Nick's Bar!"
297 |
298 | %h3 [twee2]
299 | %p
300 | Passages marked with the 'twee2' tag are not included in your story. However, any Ruby code in them
301 | will be executed when the passage is processed by the builder. This can be used to
302 | %a{href: '#build-config'} set build configuration options
303 | as described below.
304 |
305 | %h2#includes Splitting your code into multiple files
306 | %p
307 | A major benefit of Twee2 over Twine 2 is that it's possible to break apart your story into multiple
308 | files, which can be used to structure your work, to facilitate teamworking with or without source
309 | control, and to make 'reusable' components such as stylesheets and scripts which can then be injected
310 | into later stories. There are two ways to do this:
311 |
312 | %h3 Using ::StoryIncludes
313 | %p
314 | Insert a
315 | %code ::StoryIncludes
316 | passage into your file and list within it the names of the files to include. Each will be appended
317 | to the end of your story before compilation. For example, the following game skeleton includes the
318 | contents of four other files - the main file contains only the
319 | %code ::Start
320 | passage:
321 | %p
322 | %pre
323 | :preserve
324 | ::Start
325 | **Journey To The Centre Of The Earth**
326 |
327 | by Dan Q
328 |
329 | [Play]
330 |
331 | ::StoryIncludes
332 | first_section.tw2
333 | second_section.tw2
334 | stylesheet.tw2
335 | javascripts.tw2
336 |
337 | %h3 Using ::@include directives
338 | %p
339 | You can put an
340 | %code ::@include
341 | directive anywhere in your code to insert the contents of another file at that point.
342 | %code ::@include
343 | respects your current indentation level (e.g. when using HAML), so it's safe to use at any indentation
344 | 'depth'. For example, the following passages each include a separate file that contains a description
345 | of the house in the distance: that description is shared between the two passages, and updating the
346 | file updates the description in both.
347 | %p
348 | %pre
349 | :preserve
350 | ::Greenhouse [haml]
351 | %p
352 | Light shines brightly through the tall glass walls of the ornate wrought-iron greenhouse, and
353 | the plants are verdant and lively. The [Garden<-door] stands open and a cool breeze blows in.
354 | %p
355 | ::@include description-of-house.tw2
356 |
357 | ::Garden [haml]
358 | %p
359 | The garden winds around decorative trees betwen the [greenhouse] and the [Porch<-mansion].
360 | %p
361 | ::@include description-of-house.tw2
362 |
363 | %p
364 | Note that neither method of including code works recursively (i.e. you can't include a file that in
365 | turn includes another file), but this may be fixed in a future version.
366 |
367 | %h2#build-config Setting build configuration options
368 | %p
369 | Creating a passage with the 'twee2' tag can be used to run arbritrary Ruby code or to pass additional
370 | options to the Twee2 compiler. This expands the potential capability of Twee2 almost-limitlessly, but for now
371 | the only supported options are:
372 | %ul
373 | %li
374 | %strong
375 | %code
376 | = surround "Twee2::build_config.story_ifid = '", "'" do
377 | %em [your IFID]
378 | \- used to set the
379 | %a{href: 'http://www.ifwiki.org/index.php/IFID'} IFID of your story, to facilitate catologuing. If you
380 | don't include this directive, the compiler will suggest a random one to you every time you run it and
381 | explain how to add it: if you're going to publish your story publicly, you should add the line it
382 | suggests before you do so.
383 | %li
384 | %strong
385 | %code
386 | = surround "Twee2::build_config.story_format = '", "'" do
387 | %em [a story format]
388 | \- an alternative way of specifying the story format used by your story, rather than using the --format
389 | switch to the compiler. The syntax of format names and means of specifying externally-stored formats is
390 | identical to
391 | = succeed '.' do
392 | %a{href: '#story-formats'} using the --format switch
393 | %p
394 | For example:
395 | %p
396 | %pre
397 | :preserve
398 | ::Configuration [twee2]
399 | Twee2::build_config.story_ifid = '41AB7776-D198-40F5-BD54-0493D49DA58C'
400 | Twee2::build_config.story_format = 'Snowman'
401 |
402 | %h2#decompiler Decompiling Twine 2 stories
403 | %p
404 | It's possible to convert existing (compiled) Twee2/Twine 2 story files, in HTML format, back into
405 | Twee2 source files for further editing. This can be used to convert your Twine 2 projects into Twee2
406 | files or to easily examine the contents of somebody else's story. This feature does not work on Microsoft
407 | Windows. To use it, run:
408 | %p
409 | %code twee2 decompile input.html output.tw2
410 | %p
411 | The input HTML file can optionally be a full web URL.
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 2, June 1991
3 |
4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
48 |
58 |
49 |
57 | 2-minute tutorial
50 |51 | You can write your first piece of interactive fiction in just two minutes, after you've installed 52 | Twee2. Just follow the steps below. When you're ready to move on to more-complicated adventures, 53 | see the 54 | full documentation. 55 |
56 |
59 |
74 |
60 |
67 | 1. Install Twee2
61 |62 | If you haven't 63 | installed Twee2 64 | yet, do that first. 65 |
66 |
68 |
69 |
70 | Install Twee2
71 |
72 |
73 |
75 |
93 |
76 |
89 | 2. Open your text editor
77 |78 | You can write code in any text editor: your computer will almost-certainly already have one installed. 79 | On Windows, you can use Notepad. On MacOS, TextEdit is available (be sure to select "Make Plain Text" 80 | from the Format menu). On Linux, you might use GEdit, Kate, Emacs, Vim, Pico, or something else entirely. 81 |
82 |83 | If you have a favourite text editor, you can use that: personally, I like 84 | Sublime Text, 85 | which is available for a variety of platforms and supports 86 | source code highlighting for Twee2. 87 |
88 |
90 | 
91 |
92 |
91 |
94 |
165 |
95 |
161 | 3. Write some code
96 |97 | To begin with, copy-paste the code 98 | below 99 | on the right 100 | into your text editor (or 101 | download it here 102 | - you might need to right-click and select "Save as..."). 103 | Later, you can experiment with changing this file. 104 |
105 |
106 | Notice that the file is broken up into several
107 | passages,
108 | each of which is preceeded by a title - the titles each begin with two colons (::).
109 | Two of the passages in this code are special. The
110 | ::StoryTitle
111 | passage contains the name of our story and by convention it appears at or near the top
112 | of the file. The
113 | ::Start
114 | passage is
115 | usually
116 | the one that the player reads first, when they play your game.
117 |
119 | Save your file as
120 | escape-from-earth.tw2.
121 | You can use any file extension you like, but conventionally Twee2 files have a
122 | .tw2
123 | suffix to differentiate them from other types of files. If you're using Notepad for
124 | Windows, you might need to select "All files" from the "Save as Type" drop-down while
125 | saving, or else Windows will put
126 | .txt
127 | on the end of the filename.
128 |
130 | To compile your code, open a command prompt or terminal in the same directory as your code file, and run: 131 |
132 |133 |
twee2 build escape-from-earth.tw2 escape-from-earth.html134 | 135 |
136 | Twee2 will compile a HTML output file based on the code. Open this HTML file in your preferred web browser 137 | e.g. by double-clicking on it, and you can play your new story. Or 138 | play it online 139 | to discover what you might expect to see. 140 |
141 |142 | This short story is a very simple adventure. It might be easiest to describe in terms of a flowchart: 143 |
144 |
145 | 
146 |
148 | In each passage, the player may click a link to be taken to a different passage. Links appear in the code
149 | as some text, an arrow
150 | (->),
151 | and the name of the passage that the player will be taken to upon clicking it. So the code
152 | [[Read the book->Read Book]]
153 | would show the text "Read the book" to the player, and if they click it they'll be taken to the passage that
154 | begins with
155 | ::Read Book.
156 | You can use Markdown formatting to style your text. Note the asterisks around the words "THE END" in
157 | Escape from Earth:
158 | these make that text appear in bold.
159 |
162 |
164 | ::StoryTitle Escape from Earth ::Start There are only hours left before the asteroid hits and, if the news is to be believed, all life on Earth is extinguished. The spaceship is fuelled-up and [[ready to go->Ready]], but after all the rush of the last few weeks, you don't feel like you've had a chance to say goodbye to the planet that's been your home your entire life. [[Your father->Father]] glances over to check that you're heading into the vessel as he shepherds [[the family dog->Dog]]'s out of the hangar door. Behind the barriers, [[your sister->Sister]] gives a sad wave, clutching a photo in her hand. ::Ready You've still got a few seconds before you absolutely have to [[get on board->Board]], if you'd like to go and [[help your father->Father]], say goodbye to [[the family dog->Dog]], or check up on [[your sister->Sister]], who you're having to leave behind. ::Board No, you decide, the time for goodbyes has passed. After your weeks of preparation for the journey through space you don't feel the need to tie yourself to Earth any more-strongly than you have to: it's already hard enough to let go. One at a time, you climb the steps into the rocket ship and find your seat. You close the blind that cover your tiny circular window and take a deep breath. Letting go isn't easy, but there's no reason you should make it harder for yourself. **THE END** ::Father You run to help your father with the dog, trying in vain to keep your mind occupied by anything but the evacuation. Wordlessly, you walk together to the door and hand over the dog's lead to the armed guard there. For a moment, you feel bad about leaving him with a stranger, but in six hours it won't matter anyway. Looking out through the hangar door, you feel a momentary pang of jealousy for those left behind: they get to [[watch one final sunrise together->Sunrise]]... meanwhile, you and the other "lucky" ten-thousand survivors will be [[in orbit->Orbit]], weightless but still weighed-down by your grief over the billions of deaths below. ::Sunrise It's an impulsive moment and you might not live to regret it, but right now, it's the right choice: as the guard is distracted by the dog, you duck under the barrier and run out into the cold night. Minutes later, you hear the deafening boom of the rocket lifting off, and you know that you're among those left on Earth. You find your sister and your mother and exchange hugs. Then, in quiet contemplation, you sit and watch your final sunrise as the first meteor fragments graze the sky. **THE END** ::Orbit Who is making the greater sacrifice, you wonder? Those billions who will die here on Earth, today, or the ten thousand evacuees who are to make their way to the Martian colony? But it's about more than sacrifice: it's about duty. Your age, gender, and health made you eligible for the lottery; your father was chosen for his expertise as a scientist. Now you owe it to your species and to those you leave behind to continue humankind's legacy. The rocket blasts off, and you look back through the window to see the lights of the planet below, artificially-lit for the last time. **THE END** ::Dog The old family dog's been your faithful friend for years, and it feels wrong to leave without saying goodbye. You almost envy him that he doesn't know what's coming for him and all of the humans that will be left behind. Suddenly, you're [[overcome with emotion->Emotion]]: everything you'd pushed down inside you since you heard the news that you'd won the evacuation lottery, last month, comes welling to the surface. Your father wraps his arms around your shoulders and gives you [[a squeeze of support->Support]], bringing your focus back to what must be done. ::Emotion It's no use trying to hide it any longer. You can't hold back the tears. Each wave of grief is followed by a wave of guilt: why should it be you that survives when so many others face almost-certain death? And then, once again, grief at the loss of everything you know and love. Your legs buckle, and the dog tries to comfort you, but he doesn't understand. It's your father who eventually helps you to your feet and back towards the rocket ship. You can't bring yourself to look back as you climb the steps, using all of your emotional energy just to make it onto the craft. You'll never recover from this suffering, you're sure of it. **THE END** ::Support "Goodbye, boy," you say, scratching the dog behind the ears. He looks up at you with concern in his eyes, sensing your discomfort, and you try to make your voice as reassuring as possible. What does it say about you, you wonder, that your last words on Earth were to an animal? Later, in the shuttle, you'll lose the last of your emotional reserves and break down: but for now, you need to be strong. You are the face of hope for the future of the human race, and it's time to take your place on Mars. **THE END** ::Sister In violation of the rules you were told as you entered the hangar, you turn and sprint across to your sister at the barriers. Reaching over the fence and with tears in your eyes, you give her one last hug. You try [[not to think->Hold On]] about the fact that this time, when you let go, you'll be letting go forever. She clutches you tight, and you can feel [[the photo->Photo]] in her hand scrape against the back of your neck. ::Hold On You're still locked in an embrace when the armed guard comes and separates you. You know that you shouldn't have, but you couldn't have left without saying that one last goodbye. You're shepherded swiftly onto the spaceship, and you're disappointed to disover that your window doesn't look in the direction of the crowd. You'd had this romantic idea that you'd be able to look back on your sister as you took off, but it wasn't to be. The rockets ingnite, and you take a deep breath. Here begins the first chapter of your new life, and ends the last chapter of your old one. **THE END** ::Photo "I wanted you to take this," your sister says, thrusting the photo into your hands. You recognise the photo: you took it at arms-reach to capture the pair of you, sitting out on the grass under a starry sky while, in the background, your father shows off a telescope to a group of onlookers. You stuff it into your pocket before the security guard arrives to shepherd you back towards the rocket ship. Weeks later, you'll frame it in your new home on Mars, and it will come to represent everything that you left behind in order to be there. But right now, all you want is one final hug before takeoff. **THE END**163 |
166 |
175 |
200 |
167 |
174 | 4. Start playing!
168 |169 | You now know enough to start making simple 'choose your own adventure'-type stories with Twee2. 170 | For more-detailed information, see 171 | the full documentation. 172 |
173 |
47 |
445 |
446 |
447 |
--------------------------------------------------------------------------------
/web/build/javascripts/bootstrap.min.js:
--------------------------------------------------------------------------------
1 | /*!
2 | * Bootstrap v3.3.5 (http://getbootstrap.com)
3 | * Copyright 2011-2015 Twitter, Inc.
4 | * Licensed under the MIT license
5 | */
6 | if("undefined"==typeof jQuery)throw new Error("Bootstrap's JavaScript requires jQuery");+function(a){"use strict";var b=a.fn.jquery.split(" ")[0].split(".");if(b[0]<2&&b[1]<9||1==b[0]&&9==b[1]&&b[2]<1)throw new Error("Bootstrap's JavaScript requires jQuery version 1.9.1 or higher")}(jQuery),+function(a){"use strict";function b(){var a=document.createElement("bootstrap"),b={WebkitTransition:"webkitTransitionEnd",MozTransition:"transitionend",OTransition:"oTransitionEnd otransitionend",transition:"transitionend"};for(var c in b)if(void 0!==a.style[c])return{end:b[c]};return!1}a.fn.emulateTransitionEnd=function(b){var c=!1,d=this;a(this).one("bsTransitionEnd",function(){c=!0});var e=function(){c||a(d).trigger(a.support.transition.end)};return setTimeout(e,b),this},a(function(){a.support.transition=b(),a.support.transition&&(a.event.special.bsTransitionEnd={bindType:a.support.transition.end,delegateType:a.support.transition.end,handle:function(b){return a(b.target).is(this)?b.handleObj.handler.apply(this,arguments):void 0}})})}(jQuery),+function(a){"use strict";function b(b){return this.each(function(){var c=a(this),e=c.data("bs.alert");e||c.data("bs.alert",e=new d(this)),"string"==typeof b&&e[b].call(c)})}var c='[data-dismiss="alert"]',d=function(b){a(b).on("click",c,this.close)};d.VERSION="3.3.5",d.TRANSITION_DURATION=150,d.prototype.close=function(b){function c(){g.detach().trigger("closed.bs.alert").remove()}var e=a(this),f=e.attr("data-target");f||(f=e.attr("href"),f=f&&f.replace(/.*(?=#[^\s]*$)/,""));var g=a(f);b&&b.preventDefault(),g.length||(g=e.closest(".alert")),g.trigger(b=a.Event("close.bs.alert")),b.isDefaultPrevented()||(g.removeClass("in"),a.support.transition&&g.hasClass("fade")?g.one("bsTransitionEnd",c).emulateTransitionEnd(d.TRANSITION_DURATION):c())};var e=a.fn.alert;a.fn.alert=b,a.fn.alert.Constructor=d,a.fn.alert.noConflict=function(){return a.fn.alert=e,this},a(document).on("click.bs.alert.data-api",c,d.prototype.close)}(jQuery),+function(a){"use strict";function b(b){return this.each(function(){var d=a(this),e=d.data("bs.button"),f="object"==typeof b&&b;e||d.data("bs.button",e=new c(this,f)),"toggle"==b?e.toggle():b&&e.setState(b)})}var c=function(b,d){this.$element=a(b),this.options=a.extend({},c.DEFAULTS,d),this.isLoading=!1};c.VERSION="3.3.5",c.DEFAULTS={loadingText:"loading..."},c.prototype.setState=function(b){var c="disabled",d=this.$element,e=d.is("input")?"val":"html",f=d.data();b+="Text",null==f.resetText&&d.data("resetText",d[e]()),setTimeout(a.proxy(function(){d[e](null==f[b]?this.options[b]:f[b]),"loadingText"==b?(this.isLoading=!0,d.addClass(c).attr(c,c)):this.isLoading&&(this.isLoading=!1,d.removeClass(c).removeAttr(c))},this),0)},c.prototype.toggle=function(){var a=!0,b=this.$element.closest('[data-toggle="buttons"]');if(b.length){var c=this.$element.find("input");"radio"==c.prop("type")?(c.prop("checked")&&(a=!1),b.find(".active").removeClass("active"),this.$element.addClass("active")):"checkbox"==c.prop("type")&&(c.prop("checked")!==this.$element.hasClass("active")&&(a=!1),this.$element.toggleClass("active")),c.prop("checked",this.$element.hasClass("active")),a&&c.trigger("change")}else this.$element.attr("aria-pressed",!this.$element.hasClass("active")),this.$element.toggleClass("active")};var d=a.fn.button;a.fn.button=b,a.fn.button.Constructor=c,a.fn.button.noConflict=function(){return a.fn.button=d,this},a(document).on("click.bs.button.data-api",'[data-toggle^="button"]',function(c){var d=a(c.target);d.hasClass("btn")||(d=d.closest(".btn")),b.call(d,"toggle"),a(c.target).is('input[type="radio"]')||a(c.target).is('input[type="checkbox"]')||c.preventDefault()}).on("focus.bs.button.data-api blur.bs.button.data-api",'[data-toggle^="button"]',function(b){a(b.target).closest(".btn").toggleClass("focus",/^focus(in)?$/.test(b.type))})}(jQuery),+function(a){"use strict";function b(b){return this.each(function(){var d=a(this),e=d.data("bs.carousel"),f=a.extend({},c.DEFAULTS,d.data(),"object"==typeof b&&b),g="string"==typeof b?b:f.slide;e||d.data("bs.carousel",e=new c(this,f)),"number"==typeof b?e.to(b):g?e[g]():f.interval&&e.pause().cycle()})}var c=function(b,c){this.$element=a(b),this.$indicators=this.$element.find(".carousel-indicators"),this.options=c,this.paused=null,this.sliding=null,this.interval=null,this.$active=null,this.$items=null,this.options.keyboard&&this.$element.on("keydown.bs.carousel",a.proxy(this.keydown,this)),"hover"==this.options.pause&&!("ontouchstart"in document.documentElement)&&this.$element.on("mouseenter.bs.carousel",a.proxy(this.pause,this)).on("mouseleave.bs.carousel",a.proxy(this.cycle,this))};c.VERSION="3.3.5",c.TRANSITION_DURATION=600,c.DEFAULTS={interval:5e3,pause:"hover",wrap:!0,keyboard:!0},c.prototype.keydown=function(a){if(!/input|textarea/i.test(a.target.tagName)){switch(a.which){case 37:this.prev();break;case 39:this.next();break;default:return}a.preventDefault()}},c.prototype.cycle=function(b){return b||(this.paused=!1),this.interval&&clearInterval(this.interval),this.options.interval&&!this.paused&&(this.interval=setInterval(a.proxy(this.next,this),this.options.interval)),this},c.prototype.getItemIndex=function(a){return this.$items=a.parent().children(".item"),this.$items.index(a||this.$active)},c.prototype.getItemForDirection=function(a,b){var c=this.getItemIndex(b),d="prev"==a&&0===c||"next"==a&&c==this.$items.length-1;if(d&&!this.options.wrap)return b;var e="prev"==a?-1:1,f=(c+e)%this.$items.length;return this.$items.eq(f)},c.prototype.to=function(a){var b=this,c=this.getItemIndex(this.$active=this.$element.find(".item.active"));return a>this.$items.length-1||0>a?void 0:this.sliding?this.$element.one("slid.bs.carousel",function(){b.to(a)}):c==a?this.pause().cycle():this.slide(a>c?"next":"prev",this.$items.eq(a))},c.prototype.pause=function(b){return b||(this.paused=!0),this.$element.find(".next, .prev").length&&a.support.transition&&(this.$element.trigger(a.support.transition.end),this.cycle(!0)),this.interval=clearInterval(this.interval),this},c.prototype.next=function(){return this.sliding?void 0:this.slide("next")},c.prototype.prev=function(){return this.sliding?void 0:this.slide("prev")},c.prototype.slide=function(b,d){var e=this.$element.find(".item.active"),f=d||this.getItemForDirection(b,e),g=this.interval,h="next"==b?"left":"right",i=this;if(f.hasClass("active"))return this.sliding=!1;var j=f[0],k=a.Event("slide.bs.carousel",{relatedTarget:j,direction:h});if(this.$element.trigger(k),!k.isDefaultPrevented()){if(this.sliding=!0,g&&this.pause(),this.$indicators.length){this.$indicators.find(".active").removeClass("active");var l=a(this.$indicators.children()[this.getItemIndex(f)]);l&&l.addClass("active")}var m=a.Event("slid.bs.carousel",{relatedTarget:j,direction:h});return a.support.transition&&this.$element.hasClass("slide")?(f.addClass(b),f[0].offsetWidth,e.addClass(h),f.addClass(h),e.one("bsTransitionEnd",function(){f.removeClass([b,h].join(" ")).addClass("active"),e.removeClass(["active",h].join(" ")),i.sliding=!1,setTimeout(function(){i.$element.trigger(m)},0)}).emulateTransitionEnd(c.TRANSITION_DURATION)):(e.removeClass("active"),f.addClass("active"),this.sliding=!1,this.$element.trigger(m)),g&&this.cycle(),this}};var d=a.fn.carousel;a.fn.carousel=b,a.fn.carousel.Constructor=c,a.fn.carousel.noConflict=function(){return a.fn.carousel=d,this};var e=function(c){var d,e=a(this),f=a(e.attr("data-target")||(d=e.attr("href"))&&d.replace(/.*(?=#[^\s]+$)/,""));if(f.hasClass("carousel")){var g=a.extend({},f.data(),e.data()),h=e.attr("data-slide-to");h&&(g.interval=!1),b.call(f,g),h&&f.data("bs.carousel").to(h),c.preventDefault()}};a(document).on("click.bs.carousel.data-api","[data-slide]",e).on("click.bs.carousel.data-api","[data-slide-to]",e),a(window).on("load",function(){a('[data-ride="carousel"]').each(function(){var c=a(this);b.call(c,c.data())})})}(jQuery),+function(a){"use strict";function b(b){var c,d=b.attr("data-target")||(c=b.attr("href"))&&c.replace(/.*(?=#[^\s]+$)/,"");return a(d)}function c(b){return this.each(function(){var c=a(this),e=c.data("bs.collapse"),f=a.extend({},d.DEFAULTS,c.data(),"object"==typeof b&&b);!e&&f.toggle&&/show|hide/.test(b)&&(f.toggle=!1),e||c.data("bs.collapse",e=new d(this,f)),"string"==typeof b&&e[b]()})}var d=function(b,c){this.$element=a(b),this.options=a.extend({},d.DEFAULTS,c),this.$trigger=a('[data-toggle="collapse"][href="#'+b.id+'"],[data-toggle="collapse"][data-target="#'+b.id+'"]'),this.transitioning=null,this.options.parent?this.$parent=this.getParent():this.addAriaAndCollapsedClass(this.$element,this.$trigger),this.options.toggle&&this.toggle()};d.VERSION="3.3.5",d.TRANSITION_DURATION=350,d.DEFAULTS={toggle:!0},d.prototype.dimension=function(){var a=this.$element.hasClass("width");return a?"width":"height"},d.prototype.show=function(){if(!this.transitioning&&!this.$element.hasClass("in")){var b,e=this.$parent&&this.$parent.children(".panel").children(".in, .collapsing");if(!(e&&e.length&&(b=e.data("bs.collapse"),b&&b.transitioning))){var f=a.Event("show.bs.collapse");if(this.$element.trigger(f),!f.isDefaultPrevented()){e&&e.length&&(c.call(e,"hide"),b||e.data("bs.collapse",null));var g=this.dimension();this.$element.removeClass("collapse").addClass("collapsing")[g](0).attr("aria-expanded",!0),this.$trigger.removeClass("collapsed").attr("aria-expanded",!0),this.transitioning=1;var h=function(){this.$element.removeClass("collapsing").addClass("collapse in")[g](""),this.transitioning=0,this.$element.trigger("shown.bs.collapse")};if(!a.support.transition)return h.call(this);var i=a.camelCase(["scroll",g].join("-"));this.$element.one("bsTransitionEnd",a.proxy(h,this)).emulateTransitionEnd(d.TRANSITION_DURATION)[g](this.$element[0][i])}}}},d.prototype.hide=function(){if(!this.transitioning&&this.$element.hasClass("in")){var b=a.Event("hide.bs.collapse");if(this.$element.trigger(b),!b.isDefaultPrevented()){var c=this.dimension();this.$element[c](this.$element[c]())[0].offsetHeight,this.$element.addClass("collapsing").removeClass("collapse in").attr("aria-expanded",!1),this.$trigger.addClass("collapsed").attr("aria-expanded",!1),this.transitioning=1;var e=function(){this.transitioning=0,this.$element.removeClass("collapsing").addClass("collapse").trigger("hidden.bs.collapse")};return a.support.transition?void this.$element[c](0).one("bsTransitionEnd",a.proxy(e,this)).emulateTransitionEnd(d.TRANSITION_DURATION):e.call(this)}}},d.prototype.toggle=function(){this[this.$element.hasClass("in")?"hide":"show"]()},d.prototype.getParent=function(){return a(this.options.parent).find('[data-toggle="collapse"][data-parent="'+this.options.parent+'"]').each(a.proxy(function(c,d){var e=a(d);this.addAriaAndCollapsedClass(b(e),e)},this)).end()},d.prototype.addAriaAndCollapsedClass=function(a,b){var c=a.hasClass("in");a.attr("aria-expanded",c),b.toggleClass("collapsed",!c).attr("aria-expanded",c)};var e=a.fn.collapse;a.fn.collapse=c,a.fn.collapse.Constructor=d,a.fn.collapse.noConflict=function(){return a.fn.collapse=e,this},a(document).on("click.bs.collapse.data-api",'[data-toggle="collapse"]',function(d){var e=a(this);e.attr("data-target")||d.preventDefault();var f=b(e),g=f.data("bs.collapse"),h=g?"toggle":e.data();c.call(f,h)})}(jQuery),+function(a){"use strict";function b(b){var c=b.attr("data-target");c||(c=b.attr("href"),c=c&&/#[A-Za-z]/.test(c)&&c.replace(/.*(?=#[^\s]*$)/,""));var d=c&&a(c);return d&&d.length?d:b.parent()}function c(c){c&&3===c.which||(a(e).remove(),a(f).each(function(){var d=a(this),e=b(d),f={relatedTarget:this};e.hasClass("open")&&(c&&"click"==c.type&&/input|textarea/i.test(c.target.tagName)&&a.contains(e[0],c.target)||(e.trigger(c=a.Event("hide.bs.dropdown",f)),c.isDefaultPrevented()||(d.attr("aria-expanded","false"),e.removeClass("open").trigger("hidden.bs.dropdown",f))))}))}function d(b){return this.each(function(){var c=a(this),d=c.data("bs.dropdown");d||c.data("bs.dropdown",d=new g(this)),"string"==typeof b&&d[b].call(c)})}var e=".dropdown-backdrop",f='[data-toggle="dropdown"]',g=function(b){a(b).on("click.bs.dropdown",this.toggle)};g.VERSION="3.3.5",g.prototype.toggle=function(d){var e=a(this);if(!e.is(".disabled, :disabled")){var f=b(e),g=f.hasClass("open");if(c(),!g){"ontouchstart"in document.documentElement&&!f.closest(".navbar-nav").length&&a(document.createElement("div")).addClass("dropdown-backdrop").insertAfter(a(this)).on("click",c);var h={relatedTarget:this};if(f.trigger(d=a.Event("show.bs.dropdown",h)),d.isDefaultPrevented())return;e.trigger("focus").attr("aria-expanded","true"),f.toggleClass("open").trigger("shown.bs.dropdown",h)}return!1}},g.prototype.keydown=function(c){if(/(38|40|27|32)/.test(c.which)&&!/input|textarea/i.test(c.target.tagName)){var d=a(this);if(c.preventDefault(),c.stopPropagation(),!d.is(".disabled, :disabled")){var e=b(d),g=e.hasClass("open");if(!g&&27!=c.which||g&&27==c.which)return 27==c.which&&e.find(f).trigger("focus"),d.trigger("click");var h=" li:not(.disabled):visible a",i=e.find(".dropdown-menu"+h);if(i.length){var j=i.index(c.target);38==c.which&&j>0&&j--,40==c.which&&j
48 |
419 |
444 |
49 |
85 | Index
50 |-
51 |
- 52 | Relationship to Twine 53 | 54 |
- 55 | Writing and compiling code 56 | 57 |
- 58 | Understanding story formats 59 | 60 |
-
61 | Twee2 syntax
62 |
-
63 |
- 64 | Passages 65 | 66 |
- 67 | Content 68 | 69 |
- 70 | Special passages 71 | 72 |
74 | - 75 | Splitting your code into multiple files 76 | 77 |
- 78 | Setting build configuration options 79 | 80 |
- 81 | Decompiling Twine 2 stories 82 | 83 |
86 |
418 | Full documentation
87 |Relationship to Twine
88 |89 | Twee2 is built on top of 90 | Twine 2, 91 | minus the graphical user interface. As a result, virtually all of the 92 | documentation about Twine 2 93 | (and specifically the documentation about the 94 | different story formats) 95 | is relevant to Twee2, too. 96 | Because Twee2 is inspired by Twee, its documentation is also a valuable resource: however note that 97 | you can't use Twee 'macros' in Twee2. 98 |
99 |Writing and compiling code
100 |
101 | Write Twee2 code using your favourite text editor. Syntax highlighting is available via
102 | this Sublime Text plugin
103 | for Twee. By convention, Twee2 source files have the
104 | .tw2
105 | extension.
106 |
108 | Compile Twee2 files using the
109 | twee2
110 | command-line tool. There are two important modes of operation:
111 |
-
113 |
-
114 |
twee2 build input.tw2 output.html115 | produces output.html based on the code in input.tw2 116 |
117 | -
118 |
twee2 watch input.tw2 output.html119 | does the same thing, but 120 | watches 121 | input.tw2 for changes, automatically recompiling whenever it is updated (note that it's not 122 | smart enough to understand when 123 | 'included' 124 | files have been changed, though). 125 |
126 |
128 | Because Twee2 source files are just plain text files, they're well-suited to use with 129 | source control systems: you could, for example, use 130 | Github 131 | to share your code or to collaborate with other authors, even working on the same file. 132 |
133 |Understanding story formats
134 |135 | Twee2 comes with built-in support for all of the same story formats that Twine 2 does: 136 |
137 |-
138 |
- 139 | Harlowe 140 | - the default format, which includes a simplified scripting format 141 | 142 |
- 143 | Snowman 144 | - a minimal format that uses Underscore.js templates and jQuery to provide programmers with a powerful toolset 145 | 146 |
- 147 | SugarCube 148 | - a TiddlyWiki-powered format that comes with support for multiple save 'slots' and a Twine 1/Twee 'macro'-like scripting syntax 149 | 150 |
- 151 | Paperthin - used when you select "View Proofing Copy" in Twine 2, this minimal skeleton isn't really an output format as it is a proofing tool 152 | 153 |
155 | If you've having difficulty choosing between them, there's 156 | a summary of the differences 157 | in the Twine 2 documentation. 158 |
159 |
160 | To specify which format to use during compilation, use the optional
161 | --format
162 | parameter. E.g. you might type
163 | twee2 build input.tw2 output.html --format=Snowman.
164 | You can get a list of the formats that Twee2 natively understands by running
165 | twee2 formats.
166 |
168 | It's possible to use any story format, e.g. if you've downloaded or written your own, by specifying the path
169 | to the story format's directory (the one containing the format.js file) in your
170 | --format
171 | parameter. For example, you might run
172 | twee2 build input.tw2 output.html --format=./MyFormat.
173 |
175 | Rather than setting the format on the command-line, it's possible to specify it within your source code 176 | itself, using 177 | build configuration 178 | options. 179 |
180 |Twee2 syntax
181 |182 | Twee2 uses a syntax that's heavily inspired-by but not 100% compatible with Twee: 183 |
184 |Passages
185 |186 | Each block of text in Twee2 exists in a 187 | passage. 188 | Each passage begins with a title, which is prefixed by two colons: 189 |
190 |
191 | ::My Passage Name
192 |
194 | Passage titles may only contain letters, numbers, basic punctuation, and spaces. Some authors prefer to avoid 195 | spaces in their passage titles. Passage titles are not case-sensitive: you don't have to use the same case when 196 | referring to a passage every time. Passages titles 197 | should 198 | be unique within a story: if they're not, only the last passage with a given title will be included in the story. 199 |
200 |201 | Passage titles may optionally be suffixed by one or both of: 202 |
203 |-
204 |
-
205 | Any number of
206 | tags,
207 | separated by spaced, inside a pair of square brackets. E.g:
208 |
209 |::My Passage Name [tagone tagtwo]210 |
211 | Tags can be used by code in your story (e.g. to send the player to a randomly-selected passage from a subset). 212 | Some tags have special meanings, 213 | as described below. 214 |
215 | -
216 | A pair of coordinates, separated by a comma and enclosed within angle brackets. E.g.:
217 |
218 |::My Passage Name <123,456>219 |
220 | Coordinates have no meaning to Twee2, but they can be used to enhance compatability with Twine 2: Twine 2 uses 221 | these coordinates to decide where to show the passages in its WYSIWYG editor. 222 |
223 |
225 | If you include both tags and coordinates after a passage, the tags must come before the coordinates, e.g.: 226 |
227 |
228 | ::My Passage Name [tagone tagtwo] <123,456>
229 |
231 | Some passages and tags 232 | have special meanings, 233 | as described below 234 |
235 |Content
236 |237 | Each passage may contain any amount of content, most of which will be stuff that the player sees. Many 238 | story formats understand 239 | Markdown 240 | formatting in passages, which makes it possible to easily add formatting to your passages. Links to different 241 | passages are supported in any of the following syntaxes (where 'Dungeon' is the name of the passage they'll be 242 | transported if they click the link, and 'click here', where present, is the text that they'll see to click on): 243 |
244 |-
245 |
-
246 |
[Dungeon]247 |
248 | -
249 |
[click here->Dungeon]250 |
251 | -
252 |
[Dungeon<-click here]253 |
254 | -
255 |
[click here|Dungeon]256 |
257 |
Special passages
259 |260 | Some passage names and tags have special meanings. These are: 261 |
262 |::Start
263 |
264 | The
265 | ::Start
266 | passage will, by default, be used as the initial passage that your player sees when they start reading.
267 | You can override this using
268 | build configuration options,
269 | but it's probably easier just to follow this convention.
270 |
::StorySubtitle, ::StoryAuthor, ::StoryMenu, and ::StorySettings
272 |273 | These names were used for special passages in Twee 1. They're not used by Twee2, but to maintain compatability 274 | with Twee 1 they're ignored and you should avoid using them unless you're writing a story that needs to be 275 | capable of being compiled by both Twee 1 and Twee2. 276 |
277 |::StoryIncludes
278 |
279 | Any
280 | ::StoryIncludes
281 | passages (you can have as many as you like, but you probably should avoid having more than one in any file in
282 | order to avoid confusion) are treated as lists of secondary Twee2 files to 'include' into your story. This is
283 | described in more detail below, under
284 | splitting your code into multiple files.
285 |
[stylesheet]
287 |288 | Any passages with the 'stylesheet' tag will not be included in your story, but their contents will be injected 289 | into the story's stylesheet. For example, you could write: 290 |
291 |292 |
::MyCoolStylesheet [stylesheet]
body {
background: #eee;
}
tw-passage tw-link {
color: red;
}
293 |
294 | 295 | It's also possible to use 296 | SASS 297 | to enhance your stylesheet. Simply add the tag 'sass' or 'scss' to specify the dialect of SASS that you want 298 | to use, e.g.: 299 |
::MyCoolStylesheet [scss stylesheet]
body {
background: #eee;
}
tw-passage {
tw-link {
color: red;
}
}
300 |
301 | [script]
302 |303 | Any passages with the 'script' tag will not be included in your story, but their contents will be injected 304 | into the resulting web page as Javascript. For example, you could write: 305 |
306 |307 |
::SomeAwesomeCode [script]
alert('This message will appear when the adventure starts!');
308 |
309 | 310 | It's also possible to use 311 | Coffeescript 312 | to make your Javascript development more-beautiful. Simply add the tag 'coffee' to your script block: 313 |
::SomeAwesomeCode [coffee script] alert 'This message will appear when the adventure starts!'314 | 315 |
[haml]
316 |317 | Put the 'haml' tag into your regular passages in order to allow you to write 318 | HAML 319 | code into your passages. HAML is a sophisticated templating language for producing HTML output, and 320 | for some it might be preferable to writing plain old Markdown. This includes the ability to inject 321 | Javascript/CoffeeScript into particular passages. For example, you could write: 322 |
323 |324 |
::NicksBar [haml]
%p
Nick's Bar is exactly the kind of nightspot that helps you remember why you quit drinking.
A depressed-looking barman pours another beer for an equally depressed-looking drunk, while
over in the corner a street thug plays with a knife as he eyes you up. The floor is sticky
and the air reeks of stale alcohol.
%p
%strong What would you like to do?
%ul
%li [Nick<-Talk to the bartender]
%li [BarToilet<-Go to the bathroom]
%li [BarSit<-Sit in a booth]
:coffeescript
$ ->
alert "This message will appear when you reach Nick's Bar!"
325 |
326 | [twee2]
327 |328 | Passages marked with the 'twee2' tag are not included in your story. However, any Ruby code in them 329 | will be executed when the passage is processed by the builder. This can be used to 330 | set build configuration options 331 | as described below. 332 |
333 |Splitting your code into multiple files
334 |335 | A major benefit of Twee2 over Twine 2 is that it's possible to break apart your story into multiple 336 | files, which can be used to structure your work, to facilitate teamworking with or without source 337 | control, and to make 'reusable' components such as stylesheets and scripts which can then be injected 338 | into later stories. There are two ways to do this: 339 |
340 |Using ::StoryIncludes
341 |
342 | Insert a
343 | ::StoryIncludes
344 | passage into your file and list within it the names of the files to include. Each will be appended
345 | to the end of your story before compilation. For example, the following game skeleton includes the
346 | contents of four other files - the main file contains only the
347 | ::Start
348 | passage:
349 |
351 |
::Start **Journey To The Centre Of The Earth** by Dan Q [Play] ::StoryIncludes first_section.tw2 second_section.tw2 stylesheet.tw2 javascripts.tw2352 | 353 |
Using ::@include directives
354 |
355 | You can put an
356 | ::@include
357 | directive anywhere in your code to insert the contents of another file at that point.
358 | ::@include
359 | respects your current indentation level (e.g. when using HAML), so it's safe to use at any indentation
360 | 'depth'. For example, the following passages each include a separate file that contains a description
361 | of the house in the distance: that description is shared between the two passages, and updating the
362 | file updates the description in both.
363 |
365 |
::Greenhouse [haml] %p Light shines brightly through the tall glass walls of the ornate wrought-iron greenhouse, and the plants are verdant and lively. The [Garden<-door] stands open and a cool breeze blows in. %p ::@include description-of-house.tw2 ::Garden [haml] %p The garden winds around decorative trees betwen the [greenhouse] and the [Porch<-mansion]. %p ::@include description-of-house.tw2366 | 367 |
368 | Note that neither method of including code works recursively (i.e. you can't include a file that in 369 | turn includes another file), but this may be fixed in a future version. 370 |
371 |Setting build configuration options
372 |373 | Creating a passage with the 'twee2' tag can be used to run arbritrary Ruby code or to pass additional 374 | options to the Twee2 compiler. This expands the potential capability of Twee2 almost-limitlessly, but for now 375 | the only supported options are: 376 |
377 |-
378 |
-
379 |
380 |
Twee2::build_config.story_ifid = '[your IFID]'381 | 382 | - used to set the 383 | IFID of your story, to facilitate catologuing. If you 384 | don't include this directive, the compiler will suggest a random one to you every time you run it and 385 | explain how to add it: if you're going to publish your story publicly, you should add the line it 386 | suggests before you do so. 387 |
388 | -
389 |
390 |
Twee2::build_config.story_format = '[a story format]'391 | 392 | - an alternative way of specifying the story format used by your story, rather than using the --format 393 | switch to the compiler. The syntax of format names and means of specifying externally-stored formats is 394 | identical to 395 | using the --format switch. 396 |
397 |
399 | For example: 400 |
401 |402 |
::Configuration [twee2] Twee2::build_config.story_ifid = '41AB7776-D198-40F5-BD54-0493D49DA58C' Twee2::build_config.story_format = 'Snowman'403 | 404 |
Decompiling Twine 2 stories
405 |406 | It's possible to convert existing (compiled) Twee2/Twine 2 story files, in HTML format, back into 407 | Twee2 source files for further editing. This can be used to convert your Twine 2 projects into Twee2 408 | files or to easily examine the contents of somebody else's story. This feature does not work on Microsoft 409 | Windows. To use it, run: 410 |
411 |
412 | twee2 decompile input.html output.tw2
413 |
415 | The input HTML file can optionally be a full web URL. 416 |
417 |'}),c.prototype=a.extend({},a.fn.tooltip.Constructor.prototype),c.prototype.constructor=c,c.prototype.getDefaults=function(){return c.DEFAULTS},c.prototype.setContent=function(){var a=this.tip(),b=this.getTitle(),c=this.getContent();a.find(".popover-title")[this.options.html?"html":"text"](b),a.find(".popover-content").children().detach().end()[this.options.html?"string"==typeof c?"html":"append":"text"](c),a.removeClass("fade top bottom left right in"),a.find(".popover-title").html()||a.find(".popover-title").hide()},c.prototype.hasContent=function(){return this.getTitle()||this.getContent()},c.prototype.getContent=function(){var a=this.$element,b=this.options;return a.attr("data-content")||("function"==typeof b.content?b.content.call(a[0]):b.content)},c.prototype.arrow=function(){return this.$arrow=this.$arrow||this.tip().find(".arrow")};var d=a.fn.popover;a.fn.popover=b,a.fn.popover.Constructor=c,a.fn.popover.noConflict=function(){return a.fn.popover=d,this}}(jQuery),+function(a){"use strict";function b(c,d){this.$body=a(document.body),this.$scrollElement=a(a(c).is(document.body)?window:c),this.options=a.extend({},b.DEFAULTS,d),this.selector=(this.options.target||"")+" .nav li > a",this.offsets=[],this.targets=[],this.activeTarget=null,this.scrollHeight=0,this.$scrollElement.on("scroll.bs.scrollspy",a.proxy(this.process,this)),this.refresh(),this.process()}function c(c){return this.each(function(){var d=a(this),e=d.data("bs.scrollspy"),f="object"==typeof c&&c;e||d.data("bs.scrollspy",e=new b(this,f)),"string"==typeof c&&e[c]()})}b.VERSION="3.3.5",b.DEFAULTS={offset:10},b.prototype.getScrollHeight=function(){return this.$scrollElement[0].scrollHeight||Math.max(this.$body[0].scrollHeight,document.documentElement.scrollHeight)},b.prototype.refresh=function(){var b=this,c="offset",d=0;this.offsets=[],this.targets=[],this.scrollHeight=this.getScrollHeight(),a.isWindow(this.$scrollElement[0])||(c="position",d=this.$scrollElement.scrollTop()),this.$body.find(this.selector).map(function(){var b=a(this),e=b.data("target")||b.attr("href"),f=/^#./.test(e)&&a(e);return f&&f.length&&f.is(":visible")&&[[f[c]().top+d,e]]||null}).sort(function(a,b){return a[0]-b[0]}).each(function(){b.offsets.push(this[0]),b.targets.push(this[1])})},b.prototype.process=function(){var a,b=this.$scrollElement.scrollTop()+this.options.offset,c=this.getScrollHeight(),d=this.options.offset+c-this.$scrollElement.height(),e=this.offsets,f=this.targets,g=this.activeTarget;if(this.scrollHeight!=c&&this.refresh(),b>=d)return g!=(a=f[f.length-1])&&this.activate(a);if(g&&b