CadabraCraft
Documentation sections

Getting started

Updated

CadabraCraft is a desktop app for writing a book and turning it into an e-book (EPUB) or a print-ready PDF. Your book lives in a folder on your computer. There is no account, no server and no tracking. The only thing the app ever sends over the network is an optional check for a newer version when it starts (you can switch it off in Settings, General).

The welcome screen

The first time you open CadabraCraft it shows a welcome screen instead of the start screen: what the app can do, and that it is 100% supported by sponsors. Get started takes you to the start screen. Sponsor CadabraCraft opens the sponsorship page in your browser; nothing is sent from the app itself, and nothing in your book changes.

You see it once. To read it again, choose Help > Welcome to CadabraCraft…. Get started then brings you back to where you were.

Make or open a book

On the start screen choose:

  • New project to start a book. Give it a title and an author and choose a folder to keep it in. The app puts everything for the book in that folder.
  • Open folder to open a book you already made, for example one you copied from another computer.
  • Import… to start a book from a Word, Markdown or HTML file (see Importing).

Books you opened before appear under Recent projects. File > Open Recent lists them too.

The Library

View all books on Home (or File > Library…, or the command palette) opens the Library: every book the app knows about, not only the newest eight.

  • Covers or List. Books show their cover picture, or the title on a colour when there is none. Pick the layout with the Covers and List buttons.
  • Sort by last edited, title, author, most words or series order. Books with no author go last under Author; books you have not opened yet have no word count and go last under Most words.
  • Search matches the letters you type in order against the title, the author and the series, so tso finds "The Salt Orchard". The count under the title reads "3 of 12 books" while you search.
  • Group by series. Books whose Book details name a series sit together under its name, in reading order by their number, with a "Book 2" tag on each. Books with no series follow under "Not in a series". Switch grouping off to see one list.
  • Add a folder of books… looks in a folder you choose (and up to three folders inside it) for books and lists what it finds. It reads only each book's cadabra.json, so a book found this way shows no word count until you open it. A folder whose cadabra.json is damaged is skipped and counted in the message.
  • Remove (the x on a book) takes it off the list. It never touches the book's folder. If a book's folder was moved or deleted, opening it says "Folder not found"; remove it or move the folder back.

Your choices (sort, layout, grouping) are remembered. The list of known books and the cover thumbnails live in this app on this computer, not in your book folders.

Your book is a folder

A book is an ordinary folder. Inside it:

MyBook/
  cadabra.json     the book's title, author, language, chapter order and so on
  manuscript/      one file per chapter
  front-matter/    title page, copyright page, dedication...
  back-matter/     acknowledgments, about the author...
  assets/          your images and cover
  exports/         the EPUB, PDF, Markdown and outline files you make
  .cadabra/        the app's own safety copies and trash

Why this is good for you:

  • You own it. You can copy it, zip it, back it up or put it under version control like any other folder.
  • Nothing needs the app to read it. Chapters are plain, documented text files. The exact layout is in file-format.md.
  • It works with any sync service. See Using a cloud-synced folder.

The app never stores full paths on your computer inside the book, so moving the folder is safe. Move it with the app closed, then open it from the new place.

Edit this page on GitHub