DreamShaderLang
Plugin reference

Start here

Start here

English · 简体中文

This directory is the English source for the DreamShader manual. Tutorials and reference pages live together by topic and can be read here on GitHub or in a local Markdown reader. The documentation site publishes these English sources and the reviewed Chinese translations maintained in this plugin.

Start here

  1. About DreamShader — the plugin, its modules and supported engines.
  2. Installation — install, enable and check the plugin.
  3. Your first material — author and find a generated material.
  4. Project layout — source roots, folders and files.
  5. Daily workflow — save, compile, regenerate and diagnose.

The compact getting-started reference remains available for a quick setup.

Topics

The complete reference index lists the individual technical reference pages.

Maintaining the manual

Edit the English Markdown in the relevant topic directory. Keep examples, identifiers and relative links usable in the plugin repository; website presentation belongs to the documentation site.

The site's docs-sync/config.json maps source paths to published page IDs. Moving a source file requires updating that mapping and incoming relative links, while retaining its page ID to keep existing URLs stable. English pages are generated from these sources; AI-generated Chinese updates are reviewed in a pull request before publication.

A release also updates the release notes page: it is written for readers of the manual — what changes for them, with links into the pages — and is not a copy of CHANGELOG.md, so neither file is generated from the other. Bump its Current release row and add the version's section when CHANGELOG.md gets one; pages that name the current release, such as Limitations, are reviewed at the same time.

The zh-CN/ tree mirrors English source paths. Beside it, zh-CN/.align/ records which English paragraph each Chinese paragraph was translated from, so when the English changes only the changed paragraphs are translated again. Correct a translation by editing the Chinese page directly; the next run keeps the edit. Website-only notes remain in the website repository.

Translations are made and checked with dreamdocs: dreamdocs status lists the stale and missing paragraphs, dreamdocs translate translates them, and dreamdocs check --plugin . is what CI runs. Its settings for this plugin are in dreamdocs.json.

On this page