User Tools

Site Tools


entwine:combining_several_twine_stories_into_one

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
entwine:combining_several_twine_stories_into_one [2016/05/19 20:43]
klembot
entwine:combining_several_twine_stories_into_one [2016/05/19 22:16]
klembot
Line 5: Line 5:
 ==== Setup ==== ==== Setup ====
  
-After the [[setting_up_a_project|usual setup]], go to your project folder'​s top level in a terminal window. Then type:+After the [[setting_up_a_project|usual ​project ​setup]], go to your project folder'​s top level in a terminal window. Then type:
 <​code>​ <​code>​
 npm install --save grunt-contrib-copy grunt-contrib-watch npm install --save grunt-contrib-copy grunt-contrib-watch
 </​code>​ </​code>​
  
-You'll also need to download the story format you plan on using. Follow the appropriate link and save it from your browser to **src/format.js**:​+Then press Enter to have npm install these packages for you. 
 + 
 +You'll also need to download the story format you plan on using. Follow the appropriate link and save it from your browser to a file named **format.js** ​in your **src** folder:
  
   * [[https://​bitbucket.org/​klembot/​twinejs/​raw/​e473ee4d26cf5eac4b16f3a55ecc25c763a14092/​story-formats/​Harlowe/​format.js?​at=default|Harlowe]]   * [[https://​bitbucket.org/​klembot/​twinejs/​raw/​e473ee4d26cf5eac4b16f3a55ecc25c763a14092/​story-formats/​Harlowe/​format.js?​at=default|Harlowe]]
   * [[https://​bitbucket.org/​klembot/​twinejs/​raw/​e473ee4d26cf5eac4b16f3a55ecc25c763a14092/​story-formats/​SugarCube/​format.js?​at=default|SugarCube]]   * [[https://​bitbucket.org/​klembot/​twinejs/​raw/​e473ee4d26cf5eac4b16f3a55ecc25c763a14092/​story-formats/​SugarCube/​format.js?​at=default|SugarCube]]
-  * [[bitbucket.org/​klembot/​twinejs/​raw/​e473ee4d26cf5eac4b16f3a55ecc25c763a14092/​story-formats/​Snowman/​format.js?​at=default|Snowman]]+  * [[https://bitbucket.org/​klembot/​twinejs/​raw/​e473ee4d26cf5eac4b16f3a55ecc25c763a14092/​story-formats/​Snowman/​format.js?​at=default|Snowman]]
  
 ==== Gruntfile ==== ==== Gruntfile ====
Line 84: Line 86:
 </​code>​ </​code>​
  
-As noted in the Gruntfile, you'll need to change this to create+As noted in the Gruntfile, you'll need to edit the file names to match the stories you have in Twine. 
 + 
 +==== Using It ==== 
 + 
 +Type ''​grunt''​ and press Enter in your terminal window to build your story. It'll appear in your project'​s **dist** folder in a file named **my-story.html**,​ unless you changed that name in your Gruntfile. 
 + 
 +Typing ''​grunt watch''​ and pressing Enter in your terminal window will start Grunt watching your Twine stories for changes. As you edit in Twine, the files will be automatically copied to your **src** folder and the merged story will be rebuilt in **dist**. You can hide away the terminal window as you work. 
 + 
 +If you'd like the watch process to end, press Control-C in the terminal window. Windows will ask you if you're sure you want to quit this process; OS X and Linux will immediately quit it for you.
entwine/combining_several_twine_stories_into_one.txt · Last modified: 2017/10/09 20:39 (external edit)