yoshida yoshida
Open the editor

Docs Start

Installation

On this page

All of these run the same core and produce the same pixels. Pick by what you want to do.

You want toUse
Try it, or design cards now and thenThe hosted editor, nothing to install
Work offline, or render from scriptsThe release zip
Host the editor for a team or a home labDocker
Try what comes nextThe dev preview
Change yoshida itselfBuilding from Source

The hosted editor

The editor is online at https://yoshida.xoyz.dev/editor/. Everything runs in your browser and your projects stay there; see Saving, Images and Privacy. A fork that publishes to GitHub Pages gets its own copy at https://<user>.github.io/<repo>/editor/ (CI and Deployment).

The release zip

Download the zip of the latest release and unpack it. It holds prebuilt programs for Linux (x86_64 and aarch64), macOS (Intel and Apple Silicon) and Windows (x86_64), the editor, these docs, the examples and the JSON Schemas. Nothing else needs to be installed.

SystemStart the editor
Linux./start.sh
macOSdouble-click start.command, or run ./start.sh in Terminal
Windowsdouble-click start.bat

Then open http://localhost:8080/editor/ (on macOS and Windows the start script opens it for you; the docs are at /docs/). For another port run ./start.sh 9000 (or start.bat 9000). The start scripts listen on 127.0.0.1 only, so only your own computer can reach the editor. To share it, see Server and Docker.

macOS programs are unsigned. start.sh clears the quarantine flag; if Gatekeeper still asks, right-click the file and choose Open once.

The command-line tool is in the folder for your system:

bin/x86_64-linux/yoshida check examples/poker
bin/x86_64-linux/yoshida render examples/poker --out out

The folders are x86_64-linux, aarch64-linux, x86_64-macos, aarch64-macos and x86_64-windows (yoshida.exe). Put the folder on your PATH to call it as yoshida. All options: Command Line.

Docker

docker build -t yoshida .
docker run -p 8080:8080 yoshida

Then open http://localhost:8080/editor/ (the landing page is at /, the docs at /docs/). docker compose up --build does the same with the repository's compose.yaml. Details and options: Server and Docker.

The dev preview

The dev branch, with what the next release will bring, is published beside the release site: the site at https://yoshida.xoyz.dev/dev/ and its editor at https://yoshida.xoyz.dev/dev/editor/. A red DEV stamp beside the logo marks it. It is newer than the latest release and not as well tested, so keep an exported project file of work you care about. How it is built: CI and Deployment.

↑↓ to moveEnter to openEsc to close