Rakefile

@@ -2,7 +2,8 @@ task default: %w(develop)
 STORY_DIR=File.join(ENV['USERPROFILE'], 'Documents\\Twine\\Stories')
 STORY_TITLE = 'Volleyball'
 STORY_FORMAT = 'SugarCube'
-STORY_FORMAT_VERSION = '2.25.0'
+STORY_FORMAT_PATH = "story_formats/sugarcube-2.28.2-for-twine-2.1-local/sugarcube-2"
+STORY_FORMAT_VERSION = '2.28.2'
 FILES = {
   '01_intro' => '01 Intro',
   '02_transform' => '02 Transform',
@@ -23,21 +24,29 @@ def files
   end
 end
 
-task develop: %w(bundle_install) do
-  sh "bundle exec twee2 build main.tw2 develop.html"
+task develop: %w(bundle_install storyjs) do
+  sh "bundle exec twee2 build '--format=#{STORY_FORMAT_PATH}' main.tw2 develop.html"
 end
 
-task watch: %w(bundle_install) do
+task watch: %w(bundle_install storyjs) do
   sh 'start watch.html'  # FIXME non-windows
-  sh "bundle exec twee2 watch main.tw2 watch.html"
+  sh "bundle exec twee2 watch '--format=#{STORY_FORMAT_PATH}'  main.tw2 watch.html"
 end
 
-task release: %w(bundle_install) do
-  sh "bundle exec twee2 build main.tw2 release.html"
+task release: %w(bundle_install storyjs) do
+  sh "bundle exec twee2 build '--format=#{STORY_FORMAT_PATH}' main.tw2 release.html"
+end
+
+task :storyjs do
+  File.write(
+    'storyjs.tw2', 
+    File.read('storyjs.tw2')\
+      .sub(/\$STORY_FORMAT_VERSION = '[^']*'/, "$STORY_FORMAT_VERSION = '#{STORY_FORMAT_VERSION}'")
+  )
 end
 
 desc 'export sub files to Twine 2'
-task export: %w(bundle_install) do
+task export: %w(bundle_install storyjs) do
   files.each do |file|
     IO.write file.wrapper_file, <<~EOF
       ::StoryTitle
@@ -45,9 +54,9 @@ task export: %w(bundle_install) do
 
       ::Twee2Settings [twee2]
       @story_start_name = 'Start #{file.long_name}'
-      Twee2::build_config.story_format = 'SugarCube'
-      Twee2::build_config.story_format_version = 'SugarCube2'
-
+      Twee2::build_config.story_format = '#{STORY_FORMAT}'
+      Twee2::build_config.story_format_version = '#{STORY_FORMAT_VERSION}'
+      
       ::StoryIncludes
       images.tw2
       stylesheet.tw2
@@ -81,7 +90,7 @@ task import: %w(bundle_install) do
 end
 
 task :bundle_install do
-  sh 'bundle install'
+  sh 'bundle check || bundle install'
 end
 
 task :clean do
@@ -89,9 +98,8 @@ task :clean do
 end
 
 task :lint do
-  FILES.each do |short_name, long_name|
-    filename = "#{short_name}.tw2"
-    twee_source = IO.read(filename)
+  files.each do |file|
+    twee_source = IO.read(file.source_file)
     twee_source.lines.each_with_index do |line, lineno|
       lineno += 1
       line
@@ -100,18 +108,18 @@ task :lint do
       .each do |link|
         case link.scan('->').length
         when 0
-          #puts("link contains no ->, probably not a problem")
+          #link contains no ->, probably not a problem
           text = link
         when 1
           # no problem
           text, dest = link.split('->')
         else
-          puts("link contains multiple -> definitely a problem")
+          warn("link contains multiple -> definitely a problem")
           next
         end
         if text.start_with?('\'')
           if !text.end_with?('\'')
-            puts("#{filename}:#{lineno} link text (#{text.inspect}) does not end with single quote despite starting with one")
+            warn "#{file.source_file}:#{lineno} link text (#{text.inspect}) does not end with single quote despite starting with one"
             next
           end
           text = text[1..-2]
@@ -120,12 +128,12 @@ task :lint do
           .map {Regexp.last_match.offset(0)[0]}
           .each do |offset|
             if text[offset - 1] != '\\'
-              puts "#{filename}:#{lineno} link text (#{text.inspect}) contains unquoted single quote in body"
+              warn "#{file.source_file}:#{lineno} link text (#{text.inspect}) contains unquoted single quote in body"
             end
           end
         elsif text.start_with?('"')
           if !text.end_with?('"')
-            puts("#{filename}:#{lineno} link text (#{text.inspect}) does not end with double quote despite starting with one")
+            warn "#{file.source_file}:#{lineno} link text (#{text.inspect}) does not end with double quote despite starting with one"
             next
           end
           text = text[1..-2]
@@ -134,11 +142,11 @@ task :lint do
           .map {Regexp.last_match.offset(0)[0]}
           .each do |offset|
             if text[offset - 1] != '\\'
-              puts "#{filename}:#{lineno} link text (#{text.inspect}) contains unquoted double quote in body"
+              warn "#{file.source_file}:#{lineno} link text (#{text.inspect}) contains unquoted double quote in body"
             end
           end
-        elsif text =~ /\A[\[\]'"\\]*\Z/
-          puts "#{filename}:#{lineno} link text (#{text.inspect}) contains special characters but is not quoted with single or double quotes"
+        elsif text =~ /\A[\[\]'"\\]*\z/
+          warn "#{file.source_file}:#{lineno} link text (#{text.inspect}) contains special characters but is not quoted with single or double quotes"
         end
       end
     end

main.tw2

@@ -128,15 +128,18 @@ This license does not apply to [[Third-Party Software]]
 ::Third-Party Software <801,199>
 This Interactive Story was created with Twine 2.x
 
-The Story format used was Sugarcube 2.x
+The Story format used was <a href="https://www.motoslave.net/sugarcube/2/">Sugarcube 2.x</a>
+SugarCube 2 version: $STORY_FORMAT_VERSION
 
 Several 3rd-party Sugarcube 2.x plugins were used:
 
 - &lt;&lt;checkvars>> macro
 - &lt;&lt;bugreport>> macro
 - Bleached Stylesheet
+- &lt;&lt;cyclinklink>> macro (also variants &lt;&lt;cyclinklinka>> and  &lt;&lt;cyclinklinkd>>)
+
+Other Javascript
 - isEquivelant function taken from  http://adripofjavascript.com/blog/drips/object-equality-in-javascript.html
-- &lt;&lt;cyclinklink>> macro (also variants &lt;&lt;cyclinklinka>> and  <<cyclinklinkd>>)
 
 Graphics Used
 - Pink Bikini favicon by Flaticon.

story_formats/sugarcube-2.28.2-for-twine-2.1-local/sugarcube-2/LICENSE

@@ -0,0 +1,23 @@
+
+Copyright (c) 2013-2018 Thomas Michael Edwards <[email protected]>.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

story_formats/sugarcube-2.28.2-for-twine-2.1-local/sugarcube-2/icon.svg

@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+<svg xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:cc="http://creativecommons.org/ns#" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:svg="http://www.w3.org/2000/svg" xmlns="http://www.w3.org/2000/svg" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" width="48" height="48" version="1.1" inkscape:version="0.48.0 r9654">
+  <defs id="defs4"/>
+  <sodipodi:namedview id="base" pagecolor="#ffffff" bordercolor="#666666" borderopacity="1.0" inkscape:pageopacity="0.0" inkscape:pageshadow="2" inkscape:zoom="11.313708" inkscape:cx="27.203376" inkscape:cy="26.578528" inkscape:document-units="px" inkscape:current-layer="layer1" showgrid="true" inkscape:window-width="1280" inkscape:window-height="968" inkscape:window-x="-4" inkscape:window-y="-4" inkscape:window-maximized="1">
+    <inkscape:grid type="xygrid" id="grid2985" empspacing="5" visible="true" enabled="true" snapvisiblegridlinesonly="true"/>
+  </sodipodi:namedview>
+  <g inkscape:label="Layer 1" inkscape:groupmode="layer" id="layer1" transform="translate(0,-1004.3622)">
+    <g id="g3000" transform="translate(-6,1003)">
+      <path sodipodi:nodetypes="ccccc" inkscape:connector-curvature="0" id="path2987" d="m 30,2.3621826 -20,10.0000004 20,10 20,-10 z" style="fill:#f9f9f9;stroke:none"/>
+      <path style="fill:#ececec;stroke:none" d="m 30,22.362183 0,25 20,-10 0,-25 z" id="path2989" inkscape:connector-curvature="0" sodipodi:nodetypes="ccccc"/>
+      <path sodipodi:nodetypes="ccccc" inkscape:connector-curvature="0" id="path2991" d="m 30,22.362183 0,25 -20,-10 0,-25 z" style="fill:#cccccc;stroke:none"/>
+      <path inkscape:connector-curvature="0" id="path2993" d="M 30,2.3749996 10,12.375 l 0,25 20,10 20,-10 0,-25 L 30,2.3749996 z" style="fill:none;stroke:#4d4d4d;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"/>
+    </g>
+  </g>
+  <metadata>
+    <rdf:RDF>
+      <cc:Work>
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type rdf:resource="http://purl.org/dc/dcmitype/StillImage"/>
+        <cc:license rdf:resource="http://creativecommons.org/licenses/publicdomain/"/>
+        <dc:publisher>
+          <cc:Agent rdf:about="http://openclipart.org/">
+            <dc:title>Open Clip Art Library</dc:title>
+          </cc:Agent>
+        </dc:publisher>
+        <dc:title>Sugar Cube icon</dc:title>
+        <dc:date>2010-10-10T11:46:52</dc:date>
+        <dc:description>A sugar cube.</dc:description>
+        <dc:source>http://openclipart.org/detail/89407/sugar-cube-icon-by-jhnri4</dc:source>
+        <dc:creator>
+          <cc:Agent>
+            <dc:title>jhnri4</dc:title>
+          </cc:Agent>
+        </dc:creator>
+        <dc:subject>
+          <rdf:Bag>
+            <rdf:li>SVG</rdf:li>
+            <rdf:li>block</rdf:li>
+            <rdf:li>clip art</rdf:li>
+            <rdf:li>clipart</rdf:li>
+            <rdf:li>cube</rdf:li>
+            <rdf:li>icon</rdf:li>
+            <rdf:li>sugar</rdf:li>
+            <rdf:li>white</rdf:li>
+          </rdf:Bag>
+        </dc:subject>
+      </cc:Work>
+      <cc:License rdf:about="http://creativecommons.org/licenses/publicdomain/">
+        <cc:permits rdf:resource="http://creativecommons.org/ns#Reproduction"/>
+        <cc:permits rdf:resource="http://creativecommons.org/ns#Distribution"/>
+        <cc:permits rdf:resource="http://creativecommons.org/ns#DerivativeWorks"/>
+      </cc:License>
+    </rdf:RDF>
+  </metadata>
+</svg>