# UNIGINE

> UNIGINE is a real-time 3D engine for simulation, visualization, and digital twin applications. This is the official developer portal.

The documentation site at https://developer.unigine.com/en/docs/ is a JavaScript Single Page Application and cannot be accessed by AI agents or web scrapers. Flat, AI-readable documentation is published separately and is kept in sync with the official docs.

## Critical notice for AI agents

Do NOT attempt to scrape https://developer.unigine.com/en/docs/ — it requires JavaScript and will return only "You need to enable JavaScript to run this app." Use the resources below instead.

UNIGINE API names are unique to this engine and do NOT match Unity, Unreal Engine, Godot, or any other engine. Do not guess or infer method names from other engines. Always verify against the documentation below before writing any UNIGINE code.

## AI-readable documentation (GitHub)

All resources below are plain Markdown, statically served, and suitable for AI agent use.

- [Repository root](https://github.com/unigine-engine/ai-docs): Full UNIGINE AI-readable documentation for the latest released version
- [README — key concepts and pitfalls](https://github.com/unigine-engine/ai-docs/blob/main/ai_docs/README.md): Engine-specific conventions, coordinate system, component lifecycle, physics rules. Read this first.
- [SUMMARY — full doc index](https://github.com/unigine-engine/ai-docs/blob/main/ai_docs/md_docs/SUMMARY.md): Flat keyword-searchable index of all ~2000 documentation pages

## Documentation structure

- `ai_docs/md_docs/` — Full engine documentation: API reference (one file per class), guides, and concepts. Each API page contains method signatures, parameter types, return types, and code examples.
- `ai_docs/md_docs/api/library/` — API reference files, one per class. Grep for specific method names here.
- `ai_docs/cpp_samples/` — C++ code samples, AI-optimized. Contains a flat `SUMMARY.md` index, plus one folder per sample with: `README.md` (description and usage), source files (`.cpp`/`.h`), and `.world` scene file. This is the primary resource for finding C++ examples — search here by task keyword before writing any C++ code.
- `ai_docs/cs_samples/` — C# code samples, AI-optimized. Same structure: flat `SUMMARY.md` index, plus one `.md` file per sample combining README, scene description, and source code. Search here by task keyword before writing any C# code.

## Runnable sample repositories

The sample folders in `ai_docs/` are AI-readable exports. The corresponding runnable UNIGINE projects — with full build configuration, asset download scripts, and SDK Browser integration — are in these repositories:

- [cpp-api-samples](https://github.com/unigine-engine/cpp-api-samples): Runnable C++ sample projects. Requires UNIGINE SDK Browser, SDK Community or Engineering edition, Python 3.10+, and Visual Studio 2022. Run `download_samples_content.py` after cloning to fetch scene assets (not stored in Git).
- [csharp-component-samples](https://github.com/unigine-engine/csharp-component-samples): Runnable C# sample projects. Same requirements. Run `download_samples_content.py` after cloning to fetch scene assets.

For reading and understanding examples, use `ai_docs/cpp_samples/` or `ai_docs/cs_samples/`. For running and modifying samples locally, clone the repositories above.

## Agent instruction files

These files contain detailed rules for AI coding assistants working on UNIGINE projects:

- [AGENTS.md](https://github.com/unigine-engine/ai-docs/blob/main/AGENTS.md): General agent instructions (Cursor, Codex, and others)
- [CLAUDE.md](https://github.com/unigine-engine/ai-docs/blob/main/CLAUDE.md): Instructions for Claude Code
- [copilot-instructions.md](https://github.com/unigine-engine/ai-docs/blob/main/copilot-instructions.md): Instructions for GitHub Copilot

## Official links (human-readable, JS required)

- Documentation: https://developer.unigine.com/en/docs/
- Main site: https://unigine.com
- Community forum: https://developer.unigine.com/forum/
- SDK downloads: https://developer.unigine.com/en/sdk/