DOCUMENT INDEX
Search open-source documentation
Find repository setup, contribution, and deployment guides.
INDEX
Browse all documentation
47 / 47 ENTRIES
01Open Source DevelopmentGuide / Open Source DevelopmentRepository development guides for the engine, docs, examples, and hosting SDK.02Engine repositoryGuide / Engine sourceChoose a focused guide to engine repository.03IntroductionGuide / Engine sourceWhat Rustic Engine is, implemented features, and core technologies.04Building Rustic Engine from SourceGuide / Engine sourceClone, prepare, build, and run the engine from source.05ArchitectureGuide / Engine sourceEditor, runtime, rendering, physics, scripting, and asset ownership.06Project StructureGuide / Engine sourceNavigate the Rust workspace, applications, crates, and game project files.07Rendering SystemGuide / Engine sourceGraphics backends, automatic selection, diagnostics, and performance.08Scripting ArchitectureGuide / Engine sourceLanguage adapters, execution, script components, lifecycle, and reload.09Scene SystemGuide / Engine sourceScene loading, stable objects, components, versioned storage, and recovery.10Editor DevelopmentGuide / Engine sourceDevelop panels, project manager flows, workspaces, and debugging tools.11Building & PackagingGuide / Engine sourceBuild profiles, operating-system requirements, and Windows packaging.12Extending the EngineGuide / Engine sourceAdd functionality, modules, importers, scripting APIs, and custom tooling.13TroubleshootingGuide / Engine sourceDiagnose build failures, graphics initialization, and runtime problems.14ContributingGuide / Engine sourceEngine pull requests, coding standards, validation, and bug reports.15Languages and architectureGuide / Engine sourceLanguages and architecture for Engine repository.16PrerequisitesGuide / Engine sourcePrerequisites for Engine repository.17Fork, build, and run your own versionGuide / Engine sourceFork, build, and run your own version for Engine repository.18Good development starting pointsGuide / Engine sourceGood development starting points for Engine repository.19Main scripts and commandsGuide / Engine sourceMain scripts and commands for Engine repository.20Build a first gameplay behaviorGuide / Engine sourceBuild a first gameplay behavior for Engine repository.21Diagnose common setup failuresGuide / Engine sourceDiagnose common setup failures for Engine repository.22Docs repositoryGuide / DocsChoose a focused guide to docs repository.23Documentation OverviewGuide / DocsDocumentation structure, reading paths, source loading, and catalog search.24Local SetupGuide / DocsRun, build, check, and preview the documentation website locally.25Folder StructureGuide / DocsWhere engine guides, contributor pages, generated APIs, and site code belong.26Writing GuidelinesGuide / DocsSupported Markdown, terminology, accuracy, and reproducible examples.27Adding DocumentationGuide / DocsCreate pages and sections, register routes, and verify publication.28Editing Existing PagesGuide / DocsFind authoritative sources and correct outdated information and links.29Validation and engine syncGuide / DocsRun site/browser checks, validate script syntax and review engine API drift.30Code ExamplesGuide / DocsStandards for scripting API samples, setup, lifecycle, and expected results.31Documentation maintenanceGuide / DocsAuthoritative sources, synchronization, route checks and validation.32VersioningGuide / DocsMaintain compatibility notes and plan documentation for multiple engine versions.33TranslationsGuide / DocsPropose languages, review translations, and understand locale support needed.34ContributingGuide / DocsSubmit and review documentation changes with the required website checks.35Languages and frameworkGuide / DocsLanguages and framework for Docs repository.36PrerequisitesGuide / DocsPrerequisites for Docs repository.37Fork and run your own versionGuide / DocsFork and run your own version for Docs repository.38Source map and good starting pointsGuide / DocsSource map and good starting points for Docs repository.39Main scripts and workflowsGuide / DocsMain scripts and workflows for Docs repository.40Publish your own documentation siteGuide / DocsPublish your own documentation site for Docs repository.41Diagnose common setup failuresGuide / DocsDiagnose common setup failures for Docs repository.42Writing documentationGuide / DocsAdd guides, maintain API pages, and make content searchable.43Development & deploymentGuide / DocsChoose a focused guide to development & deployment.44Development and buildGuide / DocsDevelopment and build for Development & deployment.45Cloudflare Pages deploymentGuide / DocsCloudflare Pages deployment for Development & deployment.46Examples repositoryGuide / ExamplesPlanned sample projects; current contents, license and contribution guidance.47Hosting SDK repositoryGuide / Hosting SDKPlanned hosting integration SDK; current status and contribution guidance.