diff --git a/README.md b/README.md index dce78ace..510c58f4 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ Request a Feature · Ask a Question + · + Join Our Discord
@@ -45,7 +47,9 @@ Untold Engine is built for developers and teams who: Creator & Lead Developer: https://www.haroldserrano.com -![untoldengine-image](/docs/images/engine-highlight-5.png) +[![untoldengine-image](/docs/images/engine-highlight-5.png)](https://vimeo.com/1176995991?fl=ip&fe=ec) + +Click to Play --- @@ -78,6 +82,13 @@ workflow, product experience, and customer-specific behavior. +## Requirements + +- macOS 26 or newer +- Swift 6 / Xcode 26 or newer +- Apple Silicon Mac +- Supported platforms: macOS, iOS, and visionOS + ## Try the Engine Right Now The best first step is to run the Starter Demo. It is intentionally small and @@ -164,22 +175,7 @@ Untold Engine is well-suited for: --- -# Commercial Use, Sponsored Features, and Support - -Untold Engine is open source under MPL-2.0 and can be used in commercial apps. -Paid commercial options are available for teams that need private engine -modifications, sponsored engine features, priority support, or custom terms. - -- **Sponsored open-source features** — fund roadmap-aligned engine work that is - released into the public MPL engine. -- **Commercial license** — keep private modifications to engine internals closed - under commercial terms. -- **Priority support / retainers** — get focused help with engine integration, - rendering issues, performance, and production use. - -See [COMMERCIAL.md](COMMERCIAL.md) for commercial licensing details. ---- # Engine API @@ -298,6 +294,23 @@ Full license: https://www.mozilla.org/MPL/2.0/ --- +# Commercial Use, Sponsored Features, and Support + +Untold Engine is open source under MPL-2.0 and can be used in commercial apps. +Paid commercial options are available for teams that need private engine +modifications, sponsored engine features, priority support, or custom terms. + +- **Sponsored open-source features** — fund roadmap-aligned engine work that is + released into the public MPL engine. +- **Commercial license** — keep private modifications to engine internals closed + under commercial terms. +- **Priority support / retainers** — get focused help with engine integration, + rendering issues, performance, and production use. + +See [COMMERCIAL.md](COMMERCIAL.md) for commercial licensing details. + +--- + # Trademark "Untold Engine" and the Untold Engine logo are trademarks of **Untold Engine Studios**. Forks may not use the name in a way that implies official endorsement. See [TRADEMARKS.md](TRADEMARKS.md). @@ -308,4 +321,3 @@ Full license: https://www.mozilla.org/MPL/2.0/ - [GitHub Discussions](https://github.com/untoldengine/UntoldEngine/discussions) — ideas and questions - [GitHub Issues](https://github.com/untoldengine/UntoldEngine/issues) — bugs and tasks -- [Discord](https://discord.gg/pSckCPFxj) — ask questions, share projects, and discuss engine development diff --git a/docs/API/UsingGaussianSystem.md b/docs/API/UsingGaussianSystem.md index 0ab4d40f..29f14ea9 100644 --- a/docs/API/UsingGaussianSystem.md +++ b/docs/API/UsingGaussianSystem.md @@ -11,6 +11,7 @@ Start by creating an entity that represents your Gaussian Splat object. ```swift let myEntity = createEntity() ``` + --- ### Step 2: Link a Gaussian Splat to the Entity diff --git a/docs/index.md b/docs/index.md index 90712d8b..bfba49de 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,18 +13,6 @@ Ask a Question
-
-
- -![Build Status](https://github.com/untoldengine/UntoldEngine/actions/workflows/ci-build-test.yml/badge.svg?style=flat-square) -[![Project license](https://img.shields.io/github/license/untoldengine/UntoldEngine.svg?style=flat-square)](https://github.com/untoldengine/UntoldEngine/blob/main/LICENSE) -[![Pull Requests welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://github.com/untoldengine/UntoldEngine/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) -![Version](https://img.shields.io/github/v/release/untoldengine/UntoldEngine?style=flat-square&label=version) -![Commits](https://img.shields.io/github/commit-activity/t/untoldengine/UntoldEngine?style=flat-square&label=commits) -![Last Commit](https://img.shields.io/github/last-commit/untoldengine/UntoldEngine?style=flat-square&label=last+commit) - -
- --- # Untold Engine