Skip to content

About

Browser-based pen plotter controller: convert PDF, SVG, image and Office documents into safe G-code for an Anycubic i3 Mega S or any OctoPrint printer.

Topics

Resources

Stars

7 stars

Watchers

0 watching

Forks

Repository files navigation

GCodeScribe

Convert documents into pen-plotter G-code and control a plotter through the web UI.

Docker Compose

Copy the example environment file if you want to configure OctoPrint, serial output, ports, or optional AI image generation:

cp .env.example .env

Build and start the app:

docker compose up --build

The web UI is available at http://localhost:8000 by default. Set PLOTTER_HOST_PORT in .env to expose another host port.

To use the pre-built GHCR image instead of building locally:

docker compose -f compose.yml -f compose.prod.yml up -d

Local Development

Install dependencies:

make setup

Start the interactive development launcher:

make dev

For automation or a direct non-interactive start, use:

make dev-plain

Install a release

Download the .deb from the release page, then install and start the web application:

sudo apt install ./gcodescribe_0.5.1_amd64.deb
gcodescribe-web

Open http://localhost:8000. The package requires Python 3.12 and provides the CLI and web server. Use the Flatpak release asset for the GTK desktop application. RPM and AppImage packages are also attached to releases.

Features

  • Organize drawings into projects, nested folders and slides with project-specific calibration.
  • Import SVG, images, PDF, Office documents and native Xournal++ pen strokes; process imports in the background.
  • Design text and drawings, preview tool paths in 3D and generate pen-plotter G-code.
  • Create OSM map drawings with cached downloads and selectable stroke routing.
  • Control printers through OctoPrint or a serial connection, including pause/resume and configurable park and pen insertion positions.

See the 0.5.1 release notes for features, fixes and upgrade details.

Build installation packages

make deb

This builds in Docker and writes the .deb to the repository root. make rpm, make appimage and make packages build the other distribution formats.

About

Browser-based pen plotter controller: convert PDF, SVG, image and Office documents into safe G-code for an Anycubic i3 Mega S or any OctoPrint printer.

Topics

Resources

Stars

7 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages