Marteau 🔨

Marteau is the utilities package used to automate development and build tasks for Indexing Your Heart.

What does Marteau do?

• Markdown to Dialogue: Convert an appropriately-formatted Markdown file into Dialogic's JSON format or the Jenson file format.
• Easy Portrait Import: Import a series of portraits into a Dialogic character sheet.

Getting started

Install from Homebrew

Run the following commands to install Marteau through Homebrew:

brew tap Indexing-Your-Heart/homebrew-packages
brew install marteau

Running from source

After cloning the main repository, run the following to build and run Marteau from the command line:

swift build
swift run marteau

Build for distribution

To build Marteau for distribution, run the following command:

swift build -c release

The compiled executable will be available in .build/release

Command-line guide

Marteau contains several subcommands:

• dialogue <markdown-path> <output-timeline-path>: Convert a Markdown file into a compatible timeline. This does not account for background image changes, sound changes, or signal emissions. This tool is designed to create a quick-start timeline where details can be added later.
  • Optional: --characters <charpath>: A path to a list of JSON files that contain character definitions in Dialogic format.
  • Optional: --debug: Enables debug messaging. If the output format is 'jenson', a debugging JSON file is created.
  • Optional: --format <dialogic|jenson>: The output format to convert the dialogue to. Default is 'dialogic'.
• portraits <portraits-path>: Import portrait definitions into Dialogic by reading from the portraits directory.

Licensing

Marteau is a module contained in Indexing Your Heart and is licensed under the Cooperative Non-Violent Public License, v7 or later. You can read your rights in the provided LICENSE.md or at https://git.pixie.town/thufie/npl-builder/src/branch/main/cnpl.md.