# The VVunderlore Toolkit Plugin The toolkit plugin is, at it's core, an updater for the toolkit. It allows me to make changes and improvements to the files and templates and stuff and, when it's ready, all you have to do is push a button in the plugin and it will update your toolkit to the newest version! >[!danger] >So far I haven't tested these updates to a wide audience. Please bear with me while I get this to work. I'm new here! I am not a programmer. I am not a github power user. So things take me a few extra steps to get to 100% or even 95%. Thanks for sticking with me! ## Installation Installing the toolkit is very simple: - Go to "Community Plugins" in a fresh vault's settings - Enable community plugins and click "Browse". Search for VVunderlore - Install the plugin and then enable it. At this point, the plugin is there but the toolkit isn't. Choose your ruleset from the dropdown and click "install". >[!example]+ Toolkit Installer >![[Screenshot 2025-07-29 at 12.02.12 AM.png]] **It is highly recommended you install the toolkit in a fresh, blank vault with nothing in it** and then migrate your existing content. It will just make things foolproof. The toolkit is built to never delete files, but I don't want that to happen just in case. If you happen to have any files in your vault that have the same name as one from the Toolkit, your file will be overwritten. #### Rulesets: This is the game your vault will function on. All the templates and forms will pull information from the ruleset and specific to the file structure of the compendium (which is what choosing a ruleset snags for you). **You do not technically need a ruleset.** If you're just using the toolkit for writing (which I hope to add more support more in the future), maybe you don't need the compendium. But if you plan to do any player management or game-running in the toolkit, it sure will help and also make things work at all! #### Reference: This is an optional part of the installation. It will create a "compendium" of that ruleset in *Resources>Rulesets>[rulesetname]* so that you can still look at that if you want to. Great if you want to pull some CoC or some PF2e into your D&D game. #### Custom Install: This feature is just in case you only want part of the toolkit. It's sort of for advanced users. #### Skip the Install: Maybe you've already installed the toolkit previously and you like where it's at. Maybe, god forbid, you're seeing the install screen even though you already clicked install. The option at the bottom allows you to circumvent the installing process altogether and go straight to the settings. #### Plugins: The toolkit should automatically install, activate, and configure all the necessary community plugins to run correctly. If not, please see the [[Plugins]] page to learn about what you need (and a tiny bit how it works). ## Toolkit Settings Below you'll find an explanation of all the features of the plugin. >[!example]+ Toolkit Settings ![[Screenshot 2025-07-29 at 12.30.49 AM.png]] #### Toolkit Updater: The plugin should automatically check the source of the toolkit against your version of it to see if theres an update. This happens on vault load and settings load. You can also just manually check if you want. Here, you can also view the changelog for the Toolkit itself (not the plugin). #### Fix Your Vault: >[!example]- Fix it up. ![[Screenshot 2025-07-29 at 12.30.17 AM.png]] Let's say you mess up a template and don't know how to fix it or you, for some reason, delete the Omninomicon. This will allow you to force an "update" AKA ping the source and see what's different. You can uncheck anything you don't want to update. ##### Re-parse Game Sets: This toggle means that, on force update, the plugin will re-run the compendium scraper that ran at install in case, again, you deleted stuff or changed it accidentally. *Note: the normal version updater will not update the compendium files. It will be (eventually) very rare that I touch the code that runs those scrapers or that the source material will be updated, so regular updates won't be needed.* #### Vault Backups: >[!example]- Backups ![[Screenshot 2025-07-29 at 12.31.15 AM.png]] A no-brainer. This allows you to make and set regular backups of your entire vault, including the compendium. Backups before updates is toggled on by default. #### Custom File Management: >[!example]+ Custom File Management ![[Screenshot 2025-07-29 at 12.32.09 AM.png]] This is where you can tell the updater what to touch and what to ignore. ##### Skip Toolkit Items This allows you to select individual toolkit files that you don't want to be overwritten at update. Say you added stuff to the spellbook or modified your templates. Adding them to this list will mean that the updater ignores those files. ##### Remap Path Files Your vault is your own. However, if you move the templates to a different folder, the updater will just create new ones. In this section, you can tell the plugin where you moved those files so that, when an update comes, it knows where to look. ***Note: If you move files but don't want them updated, add them to the Skip Toolkit Items list so that new files aren't created in the original location.*** ### File Highlights >[!example]- File Highlights >![[Screenshot 2025-07-29 at 12.33.18 AM.png]] This is meant to help you distinguish between your own files and the toolkit files so that you don't make mistakes by editing the wrong files and/or you can just find your own stuff quicker. Not sure my colors are any good. But you can choose your own! *Note: I have no idea how this will interact with any themes you may install, so better to turn it off if you choose to do that.* ### Remove Demo Files: The Toolkit comes with several pre-built characters and an adventure and stuff. Clicking this button will just remove all that chaff, giving you a true blank slate to build your dreams upon.