[Wiki] Document the format for spell imports #6

New issue

Open

opened 2026-05-19 20:22:32 +02:00 by PhoenixPhantom · 0 comments

PhoenixPhantom commented

2026-05-19 20:22:32 +02:00

Owner

Spells can be imported using a JSON-based format. The following example uses many of the most useful parts for defining a set of custom spells, but this should definitely be expanded and explained in more detail:

!SPBV=2
{
    "oldId": null,
    "metadata": null,
    "extension": ["ch.phantomphoenix.spellbook.BookData", {
            "bookName": "My Custom Book",
            "spells": [
                {
                    "name": "Custom Spell",
                    "level": 0,
                    "school": "Evocation",
                    "castingTime": [
                        6
                    ],
                    "rangeFeet": 60,
                    "components": [
                        "Somatic"
                    ],
                    "durationSeconds": [
                        0
                    ],
                    "optionalLearners": [
                        ["ch.phantomphoenix.spellbook.PureClassRestriction", "Wizard"]
                    ],
                    "effectDescription": {
                        "generalEffect": "This cantrip has a great effect.",
                        "levelEffect": [
                            {
                                "first": -2,
                                "second": "The damage increases by 1d10 when you reach levels 5 (2d10), 11 (3d10), and 17 (4d10)."
                            }
                        ]
                    }
                }
            ],
            "classes": [],
            "subclasses": [],
            "modifiedLearners": [],
            "editions": [
                "e2024",
                "e5"
            ]
        }
    ]
}

Spells can be imported using a `JSON`-based format. The following example uses many of the most useful parts for defining a set of custom spells, but this should definitely be expanded and explained in more detail: ```json !SPBV=2 { "oldId": null, "metadata": null, "extension": ["ch.phantomphoenix.spellbook.BookData", { "bookName": "My Custom Book", "spells": [ { "name": "Custom Spell", "level": 0, "school": "Evocation", "castingTime": [ 6 ], "rangeFeet": 60, "components": [ "Somatic" ], "durationSeconds": [ 0 ], "optionalLearners": [ ["ch.phantomphoenix.spellbook.PureClassRestriction", "Wizard"] ], "effectDescription": { "generalEffect": "This cantrip has a great effect.", "levelEffect": [ { "first": -2, "second": "The damage increases by 1d10 when you reach levels 5 (2d10), 11 (3d10), and 17 (4d10)." } ] } } ], "classes": [], "subclasses": [], "modifiedLearners": [], "editions": [ "e2024", "e5" ] } ] } ```

PhoenixPhantom referenced this issue

2026-06-01 14:53:30 +02:00

[Wiki] Add a wiki or extend README #5

PhoenixPhantom added the

Kind/Documentation

Priority

Low

labels

2026-06-01 15:06:53 +02:00