User Tools

Site Tools


entwine:guide

Differences

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

Link to this comparison view

Next revision
Previous revision
entwine:guide [2016/05/15 10:14]
klembot created
entwine:guide [2020/03/05 06:38] (current)
uzume [How-Tos] update link from bitbucket to github
Line 8: Line 8:
  
 Entwine is a command-line tool that integrates with [[http://​http://​gruntjs.com|Grunt]],​ which is a tool that automates repetitive tasks. If you don't have experience with Grunt or the command line, this can feel intimidating. It will take some setup work to use Entwine, but this document will guide you through it, and once you're done, your project will be able to build itself automatically as you make changes to its sources. That is, you'll be able to edit an image or change a passage and your project will automatically rebuild without you having to even choose Publish to File in Twine. For large projects, this tradeoff can be worth it. Entwine is a command-line tool that integrates with [[http://​http://​gruntjs.com|Grunt]],​ which is a tool that automates repetitive tasks. If you don't have experience with Grunt or the command line, this can feel intimidating. It will take some setup work to use Entwine, but this document will guide you through it, and once you're done, your project will be able to build itself automatically as you make changes to its sources. That is, you'll be able to edit an image or change a passage and your project will automatically rebuild without you having to even choose Publish to File in Twine. For large projects, this tradeoff can be worth it.
 +
 +==== First Things ====
 +
 +Please go through these sections in order. These cover the basics of using Grunt, and act as a foundation for later sections.
  
   * [[One-Time Setup]]\\ There are a few steps you'll need to complete the first time you use Entwine.   * [[One-Time Setup]]\\ There are a few steps you'll need to complete the first time you use Entwine.
   * [[Setting Up a Project]]\\ How to set up a project folder for use with Entwine.   * [[Setting Up a Project]]\\ How to set up a project folder for use with Entwine.
-  * [[A Simple Gruntfile]]\\ An introduction to how Grunt works.+  * [[Understanding Grunt]]\\ A primer on how Grunt works
 + 
 +==== How-Tos ==== 
 + 
 +Feel free to pick and choose from the sections below according to what seems relevant to your needs. These are written so that they can be read in any order.
  
 +  * [[Combining Several Twine Stories Into One]]\\ If you'd like to segment your story into individual Twine stories.
 +  * [[Incorporating External CSS and JavaScript]]\\ Placing this content into external files.
 +  * [[Working With Images, Video, and Sound]]\\ Marshalling these resources into a story.
 +  * [[Publishing A Twine Story As A Desktop App]]\\ Making a standalone application from your Twine story.
  
 <note tip> <note tip>
-This guide assumes you want to use Entwine with Grunt. If you're experienced with shell scripting, it's also possible to use Entwine on the command line by itself. To do this, follow the directions for installing Node below, then run ''​npm install -g twine-utils''​. After that completes, running ''​entwine %%--%%help''​ will acquaint you with the direct command-line interface, and the [[https://bitbucket.org/​klembot/​grunt-entwine/|Grunt Entwine task's documentation]] also provides more information as to what the options do.+This guide assumes you want to use Entwine with Grunt. If you're experienced with shell scripting, it's also possible to use Entwine on the command line by itself. To do this, follow the directions for installing Node in [[One-Time Setup]], then run ''​npm install -g twine-utils''​. After that completes, running ''​entwine %%--%%help''​ will acquaint you with the direct command-line interface, and the [[https://github.com/​klembot/​grunt-entwine|Grunt Entwine task's documentation]] also provides more information as to what the options do.
  
 There is no Entwine plugin for Gulp or Brunch, which are other popular task runners for Node, and no current plans to create them.  There is no Entwine plugin for Gulp or Brunch, which are other popular task runners for Node, and no current plans to create them. 
 </​note>​ </​note>​
entwine/guide.1463321659.txt.gz · Last modified: 2017/10/09 20:37 (external edit)