Home

Welcome to Kozmadeus Wiki!

Kozmadeus is a modular 3D model importer for Spiral Knights (Clyde). A direct successor of Bootshuze and Bootshuze-GUI completely revamping the design and codebase, as well as adding numerous QOL improvements along with new options.

This wiki will attempt to explain as much as possible about the inner workings and structures of the program, in case any info is missing the wiki will be updated regularly.

Currently, Kozmadeus is capable of processing:

• Geometry Data
• Texture Mappings
• Armatures
• Animations (WIP)

It relies on .xml templates that can be imported within Tudey scene viewer (SpiralView).

General Program Structure

Below a usage flowchart:

graph TD
A(User Interface: CLI/GUI) -- Pass Filenames, options --> B[main.py]
B -- Iterate over filenames and pass a single filename --> D{Module Choice}
D -- ".obj" --> E[Wavefront Module]
D -- ".dae" --> F[Collada Module]
E  -- return model data--> G{Data export in main.py}
F -- return model data --> G
G -- write to .xml template --> H(ExportXML)
G -- CLI nofile option --> I[return raw data]
I --> J(CLI stdout file contents output)

Loading

Seemingly, Kozmadeus utilizes a simple, linear flow, although its technical structure varies greatly. Simplicity of usage paired with utility is the final goal of the development.

Below the program hierarchy:

graph TD
A(GUI) --> C(main)
B(CLI) --> C
C --> D[modules]
C --> E[components]
C --> F[assets]
C --> G[templates]

Loading

• GUI/CLI layer: User interfaces
• main: Processing filenames, processing and calling modules, initiating logging, sending data for export
• modules: Scripts for extracting data out of specified 3D model formats
• components: Various general-purpose scripts used by user interfaces or main
• assets: Non-script files necessary for the program to function (mostly)
• templates: XML Clyde model file templates used for file export