> [!column|flex no-title] >> [!menu-dark-red|ttl-c] [[Obsidian TTRPG Tutorials]] / [[Plugin Tutorials]] / [[TTRPG-Convert-CLI-UI]] > [!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/8AF29UBUCa) > [!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) | > If you are looking for an easier way to run the [Obsidian TTRPG Convert CLI Tool](https://github.com/ebullient/ttrpg-convert-cli) then you have come to the right place! The Obsidian TTRPG Convert CLI UI is a Windows application designed to make it easier to run the CLI. It removes the need to manually use the command line interface replacing it with a simple application designed to get you up and running quickly and easily. > [!NOTE]- Example Screenshots > ![[Pasted image 20250316144131.png]] > ![[Pasted image 20250316144159.png]] > ![[Pasted image 20250316144208.png]] # Pre-Requisites - This application will only run on **Windows**! # Download Link Download the latest version from here: https://github.com/Obsidian-TTRPG-Community/TTRPG_CLI_UI/releases # Video Guide  # Step By Step Process > [!NOTE]- Tab 1: Setup Data > On this tab you will download the CLI took, pre-requisites and all the data that is used in the process. > Click through steps 1 to 7. > You can use the Update Data buttons to update the content. > The source Data and Templates are mandatory while Images and Homebrew are optional. > Once you have completed steps 1 to 7, click the Create Config File tab. > ![[Pasted image 20250316204226.png]] > [!NOTE]- Tab 2: Create Config File > On this tab you will create and save a config file that will be used by the tool. Config files tell the tool what content you want to include and how to configure the notes. > Only add content you own into the config file. Support the content creators and publishers that make the games we love. > Along the top is a series of boxes. This is where you add the content that you want the CLI tool to create. > TIP: Do not add everything you own for the sake of adding everything you own. Instead add what you need to run your campaign. > TIP: Not all content is equal. Homebrew for example is created by community members and not peer reviewed as thoroughly. Sometimes you will come across content that fails in the CLI tool. Best way to avoid this, is to remove the problematic content from your config file. > GOTCHA: Look out for empty lines in the source boxes that contain double quotations marks "". This usually happens when you have a , on the end of the bottom source code. The last (aka bottom) source code does not need a trailing ,. You can press DELETE in the source box to remove the "". > You can click the little cog symbols to see a list of content codes and which box they need to go in. > Now move down the list of options on the left configuring it per your requirements. You can learn more about the available options [HERE](https://github.com/ebullient/ttrpg-convert-cli/blob/main/docs/configuration.md) > Click Save Config once complete. > Once you have saved your config file, click the Run CLI tab. > ![[Pasted image 20250316204240.png]] > [!NOTE]- Tab 3: Run CLI > On this tab you will run the CLI. > Assuming you followed all steps on tabs 1 and 2, you only need to name your Output folder. You can call it anything. This is just the name of a folder that will be created with the output of the tool. > Click ==Run CLI==. > Follow the instructions on this page. You need to copy the content form the Output Folder into the mentioned folders within your vault. > Configure the plugins per the instructions provided. > ![[Pasted image 20250316205216.png]] # Frequently Asked Questions - **Does this support D&D 5e 2014?** Yes, check the source map for codes and categories. - **Does this support D&D 5e 2024?** Yes, check the source map for codes and categories. - **GOTCHA:** Look out for empty lines in the source boxes that contain double quotations marks "". This usually happens when you have a , on the end of the bottom source code. The last (aka bottom) source code does not need a trailing ,. You can press DELETE in the source box to remove the "". # 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)