Caves of Qud Wiki:Qud Blueprint Explorer: Difference between revisions

Jump to navigation Jump to search

Caves of Qud Wiki:Qud Blueprint Explorer (view source)

Revision as of 22:08, 10 April 2022

2,100 bytes removed ,  22:08, 10 April 2022
Added this page to Category: Caves of Qud Wiki
(Created page with "Qud Blueprint Explorer (QBE) is a [https://en.m.wikipedia.org/wiki/Python_%28programming_language%29 python] application that is able to read a player's ObjectBlueprints.xml a...")
 
(Added this page to Category: Caves of Qud Wiki)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Qud Blueprint Explorer (QBE) is a [https://en.m.wikipedia.org/wiki/Python_%28programming_language%29 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.
[[File:QBE_Screenshot.png|right|360px]]
'''Qud Blueprint Explorer''' (QBE) is an open source [https://en.m.wikipedia.org/wiki/Python_%28programming_language%29 Python] application that is able to read from an installation of [[Caves of Qud]] (mostly the file <code>ObjectBlueprints.xml</code>) and generate articles for this wiki, including uploading the pages and tile images. Tiles are automatically colorized to fit the [[Style Guide]]. It is currently under active development and is used to populate this wiki with any changes after the game is updated.


It can be found here: ([https://github.com/syntaxaire/qud-wiki link])
If you want to see how it works by reading the source code, or help with development, the GitHub repository can be found [https://github.com/TrashMonks/qud-wiki here].


==Installation==
==Bug reporting and troubleshooting==
Taken from ReadMe.md:
If you find any problems with the pages QBE is creating, please file an issue on the GitHub repository, or ping any member of the 'Trash monks' group on the [https://discordapp.com/invite/cavesofqud official Caves of Qud discord].


Check first in the "Releases" tab on GitHub for a recent Windows executable.
[[Category:Caves of Qud Wiki]]
If you prefer to run the newest Python source, follow these instructions:
 
*Clone the git repository
*Download [https://www.dropbox.com/s/g8coebnzoqfema9/CavesofQudTileModdingToolkit.zip?dl=0 CavesofQudTileModdingToolkit.zip] and extract it into the project directory. This provides tile images.
*Install Python 3.7 from [https://python.org/ Python.org] and select the installer option to add it to your PATH.
*In your terminal, <code>cd</code> to your copy of the repository and run these commands:
<syntaxhighlight lang="git">
pip install pipenv
pipenv sync
pipenv run app
</syntaxhighlight>
 
If you intend to work on the source yourself, replace <code>pipenv sync</code> with <code>pipenv sync --dev</code> to install additional development dependencies.
 
==Documentation==
 
* <code>qud_object.py</code> defines a QudObject that the XML gets parsed into. Has attributes and inheritance trees and everything. Also defines <code>qindex</code>, which is a dict to get QudObjects from names quickly.
* <code>qud_object_tree.py</code> is a script that parses all the XML from the xmlpath into QudObjects, so you can then use <code>qindex</code> to grab parts of it, etc.
* <code>qud_object_test.py</code> is just a script to test some of the inheritance and specification properties of the QudObjects.
* <code>qud_explorer.py</code>, is code for the explorer GUI. Run <code>qud_explorer.py</code> from the command line to launch the GUI.
* <code>qud_explorer_window.ui</code>, and <code>qud_explorer_window.py</code> are user interface files auto-generated from the graphical Qt Designer app and the Qt UIC compiler, respectively.
* <code>config.py</code> and <code>config.yml</code> are config files, blah blah blah.
* <code>Pipfile</code> and <code>Pipfile.lock</code> are control files for the [https://docs.pipenv.org/en/latest/ pipenv] dependency manager. To start working on the project, first install <code>pipenv</code> to your system interpreter using pip install pipenv, then <code>cd</code> over to this project folder and run <code>pipenv sync --dev</code>. 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 [https://discordapp.com/invite/cavesofqud official Caves of Qud discord] or leave a comment on our [[User_talk:Syntaxaire|Talk]] [[User talk:Teamtoto|pages]].
Cadex
312

edits

Retrieved from "https://wiki.cavesofqud.com/wiki/Special:MobileDiff/33787...74355"

Navigation menu