Installing Twee2

Prerequisites

Twee2 requires Ruby version 2.0 or higher. You can check whether Ruby is installed and what version it is by opening up a command prompt or terminal and running:

ruby -v

If you don't have Ruby installed, there are several ways to easily install it. Here are some quick ways:

Windows

Download RubyInstaller

Note that the 'decompile' feature, which turns Twine 2 story files into Twee2 source code, is not supported on Windows.

MacOS

MacOS comes with Ruby, but it's usually out-of-date. Install a modern version using RVM.

Linux

Many Linux distributions have packages for Ruby, but it's often out-of-date. Install RVM and use it to get Ruby 2.1.6 by running:

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

Installing Twee2

To install Twee2, open a command prompt or terminal and type:

gem install twee2

You can check that it's installed correctly by running:

twee2

Now you're ready to dive into the two-minute tutorial or the full documentation.

Uninstalling Twee2

If you ever want to uninstall Twee2, simply run:

gem uninstall twee2

Source code

Twee2 is open-source, which means you can read and change its code for yourself. Get the code on GitHub.