Caves of Qud Wiki:Qud Blueprint Explorer

Qud Blueprint Explorer (QBE) is a python application that is able to read a player's ObjectBlueprints.xml and return either an Template:Item or Template:Character, with the option of uploading automatically through a bot. Tiles are also automatically colorized to fit the Style Guide. It is currently under active development.

It can be found here: (link)

Installation

Taken from ReadMe.md:

Check first in the "Releases" tab on GitHub for a recent Windows executable. If you prefer to run the newest Python source, follow these instructions:

• Clone the git repository
• Download CavesofQudTileModdingToolkit.zip and extract it into the project directory. This provides tile images.
• Install Python 3.7 from Python.org and select the installer option to add it to your PATH.
• In your terminal, cd to your copy of the repository and run these commands:

pip install pipenv
pipenv sync
pipenv run app

If you intend to work on the source yourself, replace pipenv sync with pipenv sync --dev to install additional development dependencies.

Documentation

• qud_object.py defines a QudObject that the XML gets parsed into. Has attributes and inheritance trees and everything. Also defines qindex, which is a dict to get QudObjects from names quickly.
• qud_object_tree.py is a script that parses all the XML from the xmlpath into QudObjects, so you can then use qindex to grab parts of it, etc.
• qud_object_test.py is just a script to test some of the inheritance and specification properties of the QudObjects.
• qud_explorer.py, is code for the explorer GUI. Run qud_explorer.py from the command line to launch the GUI.
• qud_explorer_window.ui, and qud_explorer_window.py are user interface files auto-generated from the graphical Qt Designer app and the Qt UIC compiler, respectively.
• config.py and config.yml are config files, blah blah blah.
• Pipfile and Pipfile.lock are control files for the pipenv dependency manager. To start working on the project, first install pipenv to your system interpreter using pip install pipenv, then cd over to this project folder and run pipenv sync --dev. This will create a virtual environment and install all dependencies including development packages (like pytest). If the dependencies change, this command will also update them automatically.

Bug Reporting and Troubleshooting

If there are any issues with QBE, be sure to ping syntaxaire or Dij on the official Caves of Qud discord or leave a comment on our Talk pages.