> [!column|flex no-title] >> [!menu-dark-red|ttl-c] [[Obsidian TTRPG Tutorials]] / [[Plugin Tutorials]] / [[TTRPG-Convert-CLI-JBANG]] > [!column|4 no-title] >> [!menu-green-1|ttl-c] [[Getting Started]] > >> [!menu-green-2|ttl-c] [[Plugin Tutorials]] > >> [!menu-green-3|ttl-c] [[Community Supported Games]] > >> [!menu-green-4|ttl-c] [[Obsidian TTRPG Tutorials/Templates/Templates\|Templates]] > [!column|3 no-title] >> [!patreon|ttl-c] [Patreon](https://www.patreon.com/JPlunkett) ([Starter Vault](https://www.patreon.com/posts/obsidian-patreon-96801399)) > >> [!discord|ttl-c] [Obsidian TTRPG Community Discord](https://discord.gg/CdM9UCJdwU) > >> [!discord|ttl-c] [Obsidian Official Discord](https://discord.gg/obsidianmd) > [!infobox] > # ttrpg-convert-cli > ![[TTRPG-Convert-CLI 5e-20240203092033415.webp|cover hsmall]] > > Links | > ---| > ⚙️[TTRPG Convert CLI - Github Site](https://github.com/ebullient/ttrpg-convert-cli) | > ⚙️[TTRPG Convert CLI UI - Github Site](https://github.com/Obsidian-TTRPG-Community/TTRPG_CLI_UI) | > 📄[Official Documentation](https://github.com/ebullient/ttrpg-convert-cli/blob/main/README.md)) | > 🗺️[Source Map](https://github.com/ebullient/ttrpg-convert-cli/blob/main/docs/sourceMap.md#source-name-mapping-for-5etools)) | > 🆘[Support](https://discord.com/channels/925322340995313686/1118630475313975367) 🐛[Raise Issue](https://github.com/ebullient/ttrpg-convert-cli/issues) | > 🍵[Support Ebulient with Coffee](https://www.buymeacoffee.com/ebullient) | > This is an alternative way to run the CLI process that works on other operating systems. - Linux - Mac (ARM) and MAC (Intel) - Windows (Older machines and ones where the normal process is failing) You can find official documentation for this process [HERE](https://github.com/ebullient/ttrpg-convert-cli/blob/main/docs/alternateRun.md#use-jbang) # Install JBANG Browse to: https://www.jbang.dev/documentation/jbang/latest/installation.html Follow the instructions there to complete the install. The way you do this will depend on the OS you are using. The way that worked for me: - Windows > Start > Windows Power Shell > Enter - Type the following: ``` iex "& { $(iwr -useb https://ps.jbang.dev) } app setup" ``` - Press enter and wait for the install process to complete. > [!attention]- Execution Policy Warning > You may see the following warning message. > ![[Pasted image 20251006133904.png]] > You can read more about this [HERE](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy?view=powershell-7.5). > > To proceed with the install you need to run the following command in Windows Power Shell. > ```Set-ExecutionPolicy RemoteSigned -scope CurrentUser ``` > This will allow us to run the JBANG installer. > After you have installed JBANG you can revert this change back to default by running: > ```Set-ExecutionPolicy Restricted -Scope CurrentUser ``` Here you can see I ran the command and received the the Execution Policy Warning. So I changed the policy and then re-ran the install command. ![[Pasted image 20251006134509.png]] Once it completes it will ask you to restart PowerShell to allow the changes to take effect. # Install the CLI Tool - Windows > Start > Windows Power Shell > Enter - Type the following: ``` jbang app install --name ttrpg-convert --force --fresh https://github.com/ebullient/ttrpg-convert-cli/releases/download/3.1.4/ttrpg-convert-cli-3.1.4-runner.jar ``` It will prompt you; asking if you trust the installation. Type 1 and press enter. ![[Pasted image 20251006134752.png]] You can now verify that the CLI tool is installed by typing this into your Windows Command window and press enter: - Windows > Start > CMD > Enter - Type the following: ``` ttrpg-convert --help ``` > [!warning]- Error - Compiled By More Recent Version of Java Runtime > When I tried to run the ttrpg tool I received the following error. > ![[Pasted image 20251006135951.png]] > If you get this too; you can solve it by typing the following into Windows Power Shell. > ```winget install EclipseAdoptium.Temurin.21.JDK``` > This will update your Java. Then you can try run the cli tool again. > ![[Pasted image 20251006140021.png]] If it works; it should look like this. ![[Pasted image 20251006140349.png]] You now have the installed and can proceed to set everything else up. Go back to the main tutorial and continue from: [[TTRPG-Convert-CLI 5e#Create A Home for TTRPG-Convert-CLI]] Come back here when you get to the [[TTRPG-Convert-CLI 5e#Run The CLI]] step. # Run The CLI The process for running the CLI method is slightly different as you are not running an executable. When running the command; do not include the `.exe` in the command. It should look like this. ttrpg-convert --index -o dm -c config.5e.easy.json 5etools-src/data Head back to [[TTRPG-Convert-CLI 5e#Run The CLI]] and complete the process per the tutorial there. # Support This application is not written or supported by Ebulient; the developer of the CLI tool. All support for this application should be directed to Josh P via the [Obsidian TTRPG Community Discord](https://discord.gg/CdM9UCJdwU)