tweego

Tweego

Tweego is a free (gratis and libre) command line compiler for Twine/Twee story formats, written in Go.

See Tweego's documentation for information on how to set it up and use it.

If you believe that you've found a bug in Tweego or simply wish to make a suggestion, you may do so by creating a new issue. Tweego also has a work log that may be of interest.

INSTALLATION

You may either download one of the precompiled binaries from Tweego's website, which are available in both 32- and 64-bit versions for multiple operating systems, or build Tweego from source—see BUILDING FROM SOURCE below.

BUILDING FROM SOURCE

If you want to build Tweego from scratch, rather than grabbing one of the precompiled binaries off of its website, then these instructions are for you.

Tweego is written in the Go programming language, so you'll need to install it, if you don't already have it. Additionally, to retrieve Go packages—like Tweego and its dependencies—from source control repositories, you'll need to install Git.

1. Download and install the Go programming language (https://golang.org/) ← Get version ≥v1.13
2. Download and install the Git source control management tool (https://git-scm.com/)

Once all the tooling is installed and set up, the next step is to fetch the Tweego source code. Open a shell to wherever you wish to store the code and run the following command to clone the repository:

git clone https://github.com/pec017/tweego.git

Next, change to the directory that the previous command created:

cd tweego

There are two major branches within the repository:

• master: The stable release branch
• develop: The main development branch

Be sure to switch to the branch you wish to work on by issuing the appropriate git checkout command.

Once you're on the correct branch, fetch Tweego's dependencies:

go get

You should now have Tweego and all its dependencies downloaded, so you may compile and install it to your GOPATH by running the following command:

go install

Assuming that completed with no errors, your compiled Tweego binary should be in your GOPATH's bin directory. To run Tweego you'll need to either have added your GOPATH bin to your PATH environment variable—this was likely done for you automatically during the installation of Go—or copy the binary to an existing directory within your PATH.

Alternatively. If you just want to compile Tweego, so that you can manually copy the binary to wherever you wish, use the following command instead:

go build

Assuming that completed with no errors, your compiled Tweego binary should be in the current directory—likely named either tweego or tweego.exe depending on your OS.

Finally, see Tweego's documentation for information on how to set it up and use it.