Zum Inhalt springen
Medium 1 für Eintrag Just Doc It

Beschreibung

Just Doc It automates documentation for Unreal Engine materials.

As a senior technical artist on AAA productions, I had to spend too many hours each week catching up documentation. The cost for a fraction of a single hour paying a Technical Artist is more than the cost of this plugin. Save your studio time and money. Both of which can now be spent putting out your games.

At the studios I worked with, I saw docs fall out of date the moment features changed. Just Doc It fixes that: select Materials/Instances (or a folder) and with a click export a complete, Docusaurus ready set of pages:

  • a main index that lists materials

  • a per-material folder with its own index.md

  • subpages for every material instance

Parameters are grouped by their Parameter Group, sorted by each parameter’s Sort Priority, and written as ParamName (Type) | Value with on-asset descriptions shown as indented quotes.

Using this plugin will encourage proper commenting, naming, and sorting and in return offers an easy-to-follow overview of a material at a glance.

  • Material pages list default values

  • Instance pages list values found in the instance

  • Produce clean, navigable docs with a single click.

Documentation for Just Toon It, was partially generated using this plugin. Follow the link to view it: Materials Catalog | Krypsis Syndicate

Enthaltene Formate