README.md

TNoodle-docker

Run TNoodle locally in a container without the need of installing java on the host.

What is TNoodle

TNoodle is a software suite that contains the official WCA scramble program. It generates scrambles for competitions.

WCA Scramble Program

The official scramble program for the World Cube Association has been part of the TNoodle project since January 1, 2013. It will contain the sole official scramble program for the foreseeable future.

All WCA official competitions must always use the current version of the official scramble program. This is available from https://www.worldcubeassociation.org/regulations/scrambles/

Note that only the scramble program part of TNoodle is "official". Other TNoodle projects may be convenient for certain uses (including at official competitions), but do not have any official status.

"Scramble Program" vs. "Scrambler"

Officially, TNoodle-WCA is a scramble program, while a scrambler is a human. It is fine to refer to TNoodle as a "scrambler" colloquially, but please try to use the official convention wherever possible.

Installation

You can pull it from the Docker Hub via:

docker pull docker.io/gentlehoneylover/tnoodle:latest

Run it via Docker CLI or docker-compose (examples below). Make sure you have Docker Engine or Docker Desktop installed first.

The Web UI of TNoodle is available at http://localhost:2014.

Example Docker CLI command:

docker run -d \
  --name=tnoodle \
  --restart unless-stopped \
  -p 2014:2014 \
  docker.io/gentlehoneylover/tnoodle:latest

Example compose file:

version: "3"
services:
  tnoodle:
    container_name: tnoodle
    image: docker.io/gentlehoneylover/tnoodle:latest
    restart: unless-stopped
    ports:
      - 2014:2014

Ports

Port	What it is for
2014	Default port used by Web UI