A digital DnD character sheet app

Spellbook

About

Spellbook is an application that allows users to keep track of their character's health, abilities, spells, spell slots, items and more in a simple and intuitive way. Spellbook can also be used as a simple searchable offline spell list for both 5e (2014) and 2024 spells.

Install Spellbook on your device

Consulting The Wiki

You can find the Wiki for Spellbook here. The wiki has examples and explanations on the more in-depth parts of Spellbook, such as how to do more complex searches, how to make the most of custom descriptions or how to create custom Books including spells, custom classes, subclasses and more.

Installation

For many targets, we provide recommended installation methods below, but you can always manually compile spellbook from source if the recommended methods either don't work for you or we don't yet provide a recommended method for your platform.

Android

For android, we recommend to use the .apk file from the newest release.

The Spellbook Beta is now also available in the Google Play Store to all members of the Spellbook Beta google group

Spellbook should work on any phone running Android 7.0 'Nougat' (released in May 2016) or higher. Older versions of android are not officially supported by Spellbook.

iOS

No official builds - can be compiled from source.

To build and run the development version of the iOS app, use the run configuration from the run widget in your IDE’s toolbar or open the /iosApp directory in Xcode and run it from there.

Windows

For windows, we recommend to use the .msi installer from the newest release. The installer has been tested on Windows 11 but should also work on Windows 10. Older versions may also work but are not officially supported by Spellbook.

MacOS

Warning

The packaging for macOS is still in an experimental state. As on other platforms, you can also build spellbook from source.

For macOS, we recommend using nix to install Spellbook. Install with nix

Linux

For Linux, we also recommend the use of nix to install Spellbook. Install with nix

Nix

Nix is a package manager that can be used on any Linux distribution and on macOS and provides reproducability for builds. This greatly simplifies the testing required and makes it feasible to provide up-to-date packages for these platforms.

Spellbook provides both a flake and standard package, though the flake generally easier to use and thus recommended.

To use the Spellbook flake, add the following to the inputs of your flake.nix:

   spellbook = {
       url = "git+https://git.phantomphoenix.ch/PhoenixPhantom/Spellbook?ref=refs/tags/1.1.4-Beta";
       inputs = {
          nixpkgs.follows = "nixpkgs";
       };
    };

Then add spellbook to the available packages with nixpkgs.overlays = [ spellbook.overlays.default ];. This enables you to install spellbook as you would install any other application using nix (i.e. by adding pkgs.spellbook to your packages)

A simple working configuration for x86_64-linux could look like

# flake.nix
{
  inputs = {
      nixpkgs.url = "github:nixos/nixpkgs/nixos-25.11";

      Spellbook = {
          url = "git+https://git.phantomphoenix.ch/PhoenixPhantom/Spellbook?ref=refs/tags/1.1.4-Beta";
          inputs = {
              nixpkgs.follows = "nixpkgs";
          };
      };
  };

  outputs = { 
     nixpkgs,
     Spellbook,
     ...
  }:
  let
    system = "x86_64-linux";
  in
  {
      packages."${system}".default = let
        pkgs = import nixpkgs {
            stdenv.hostPlatform.system = system;
            overlays = [
              Spellbook.overlays.default
            ];
        };
      in pkgs.symlinkJoin {
          name = "My nix packages";
          paths = [
            pkgs.spellbook 
          ];
      };
  };
}

This configuration can be run using nix profile install .# from the directory where the above flake.nix file is located.

Development version

Caution

Note that while the development version (master) has the newest features and bugfixes, it has not undergone any testing and as such may sometimes break completely (possibly destroying saved data). It is also not guaranteed that data modified with a development version can be understood by any other development version or release of Spellbook. While the data format used in older release versions will be supported by newer versions, we cannot guarantee this for development releases. DO NOT DO THIS UNLESS YOU ARE A DEVELOPER WORKING ON SPELLBOOK

The instructions above show how to use nix flakes to install the latest release of Spellbook. To use the latest development version, you can simply replace refs/tags/1.1.4-Beta with master wherever it occurs in the instructions.

Build from Source

Note

We recommend using jbr-21 as the jdk, but any java 21 development kit should do. However, other jdk releases (including newer ones) are not guaranteed to work without issues.

From the Command Line

For manual compilation, you should have Gradle and a jdk option installed (see the above note on the use of jbr-21). Then, in the folder you extracted source code from the newest release to, run (on macOS or Linux):

  ./gradlew :composeApp:run

or (on Windows):

  .\gradlew.bat :composeApp:run

to compile and run Spellbook.

Using an Editor

Instead of using the command line, you can also install Android Studio. You should be able to open the folder from the extracted release data with IDEA. You should then install the relevant plugins. Kotlin Multiplatform, Jetpack Compose and Gradle should usually be everything you need.

You can then choose the desired build config in the dropdown on the top right, next to the green play symbol (Run) and the green bug symbol (Debug). To run the app on your desktop, composeApp [jvm] should be fine.

Then navigate to IDE and Project Settings (the gear symbol somewhere to the right of the dropdown), choose Project Structure and then Project Settings/Project. There, click the SDK dropdown, choose Add SDK and select Download JDK. In the following popup, set Version to 21 and choose JetBrains Runtime as the vendor. Then click download and ensure the dropdown shows something like jbr-21.

You can now exit the settings and run Spellbook by clicking the green play symbol (Run).