Tweego, is a command line compiler for Twine/Twee story formats, written in Go. Now on Docker!

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

In order to run this container you'll need docker installed.

• Windows
• OS X
• Linux

Compatible with docker-compose v2 schemas.

version: "2.1"
services:
  tweego:
    image: tweedevs/tweego
    container_name: tweego
    environment: 
      # Optional: Default is index.html
      - TWEEGO_FILE=index.html
      # Optional: You can add any additional option https://www.motoslave.net/tweego/docs/#usage-options
      - TWEEGO_OPTIONS=-l --log-files
    volumes: 
      # All volumes are required. There are NO story formats included.
      - path_to_your_project_src:/input
      - path_to_where_you_want_the_file:/output
      - path_to_your_storyformats:/storyformats

#Linux
docker run -it -rm \
  -e TWEEGO_FILE=your_file_name.html \
  -v your_path_to_story_formats:/storyformats \
  -v your_path_to_the_twee_files:/input \
  -v your_path_to_the_where_you_want_the_result:/output \
  tweedevs/tweego # You can include options here to pass to tweego

# Windows Powershell
docker run -it -rm `
  -e TWEEGO_FILE=your_file_name.html `
  -v your_path_to_story_formats:/storyformats `
  -v your_path_to_the_twee_files:/input `
  -v your_path_to_the_where_you_want_the_result:/output `
  tweedevs/tweego # You can include options here to pass to tweego

Get a shell started in the container:

docker run -it -rm --entrypoint /bin/sh tweedevs/tweego

• TWEEGO_FILE - The you want applied to tweegos output file. Default is index.html
• TWEEGO_OPTIONS - Enables passing options to tweego. Deafult is blank.

• /storyformats - Story format location, to learn more the wiki or Twine Lab, format-catalog is a project that works on cataloguing them all.
• /input - where you have the source .twee/.tw files you want to compile.
• /output - where you want the file to saved to.

You may want to create volumes if you're devoloping locally to shorten the command:

#Linux
docker volume create --driver local \
  --opt type=none \
  --opt device=your_path_to_story_formats \
  --opt o=bind \
  storyformats
docker volume create --driver local \
  --opt type=none \
  --opt device=your_path_to_the_twee_files \
  --opt o=bind \
  input
docker volume create --driver local \
  --opt type=none \
  --opt device=your_path_to_the_where_you_want_the_result \
  --opt o=bind \
  output

# Windows Powershell
docker volume create --driver local `
  --opt type=none `
  --opt device=your_path_to_story_formats `
  --opt o=bind `
  storyformats
docker volume create --driver local `
  --opt type=none `
  --opt device=your_path_to_the_twee_files `
  --opt o=bind `
  input
docker volume create --driver local `
  --opt type=none `
  --opt device=your_path_to_the_where_you_want_the_result `
  --opt o=bind `
  output

• /bin/tweego - tweego executable location, if you are in shell you can call it as a command tweego

• GitHub

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

We use SemVer for versioning. For the versions available, see the tags on this repository.

• BDSMGeek - Initial work - BDSMGeek

See also the list of contributors who participated in this project.

This project is licensed under the Unlicense - see the LICENSE.md file for details.

• Thomas M. Edwards - Creater of Tweego and the story format Sugarcube.
• Chapel - Twine ethusiast with a knack for creating useful things for authors.
• Twine Games Discord - great place for all things Twine related.

TODO: automate this.