Skip to content

toolsstudio/shaderos-docs

Repository files navigation

ShaderOS — Shader Intelligence for Unity Projects

by Tools Studio · v1.0.0 · Unity 2021.3+ · Tools Studio Free License

Version Unity License


How to navigate this documentation

Getting started: InstallationQuick Start

Understanding a panel: Overview · Materials · Keywords · Variants

Interpreting results: Health Scores · Diagnostic Codes · Variant Estimates

Configuration: Project Settings

Hit a problem: Troubleshooting


What ShaderOS does

ShaderOS scans your Unity project's materials and shaders, scores each one for health, and surfaces what needs attention. One scan. No setup.

Material Audit Health score per material, broken shader detection, missing texture detection
SRP Batcher Compatibility flag per material with specific incompatibility reason
Keyword Budget Global usage against Unity's 256-keyword limit, duplicate detection
Shader Variants Pre-strip upper-bound estimates with risk classification
Build Optimization Shader compile time tracking with regression detection between builds

Contents

getting-started/
  installation.md          Install via Asset Store or git URL
  quick-start.md           First scan in two minutes

reference/
  settings.md              All Project Settings options documented
  tabs/
    overview.md            Health score, KPI tiles, critical issues, distribution
    materials.md           Per-material table, filters, row expansion
    keywords.md            Budget bar, duplicate chips, per-shader breakdown
    variants.md            Estimation, risk classification, strip candidates
  diagnostics/
    health-scores.md       Score computation and pipeline detection
    codes.md               TS.SO.V001–V005 — meaning, severity, resolution
    variant-estimates.md   What pre-strip estimates mean and how to use them
    srp-batcher.md         Analysis method and limitations

guides/
  material-health.md       Triaging a project with low health score
  keyword-budget.md        Reducing keyword usage before hitting the limit

troubleshooting.md         Common issues and resolutions

Free vs Pro

ShaderOS Pro is coming soon. Join announcements to be notified.

Free Pro
Materials per scan 100 Unlimited
Build history 10 builds Unlimited
Dependency graph Interactive
Variant stripping Count only Full recommendations
Migration engine BiRP → URP/HDRP
Rollback snapshots
CI/CD gates
Custom validation rules

Support

Support Server Questions and discussion
Bug Reports Reproducible issues
Announcements Releases and updates
Contact Direct support

Source: Source


Part of the Tools Studio ecosystem by Afterix.

About

ShaderOS official documentation repository — installation guides, workflow documentation, optimization references, troubleshooting resources, technical notes, and support material for the ShaderOS Unity shader intelligence platform.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors