Introduction

Welcome to the Core3D documentation!

Contents

• What is Core3D?
• Versioning
  • API
  • SDK

What is Core3D?

Core3D builds modern 3D design tools for the internet. These tools can be used as building blocks to craft your own product editing experiences, modernize your on-demand manufacturing pipeline, and more.

Versioning

Please review these versioning notes for the Core3D development tools.

API

The current major version of the API is v1, and minor versions will be available via the Core3D-Version header. Currently, there's only one minor version (alpha) — please expect minor changes until we converge on a more stable release.

SDK

The Core3D SDK is currently in an experimental (or alpha) status.

The core SDK package and its sub-packages (adapters, etc.) are versioned in lock-step with one another -- the package versions should be match within a project / installation i.e. if you have @core3d/sdk installed at v0.4.23, @core3d/ sdk-adapter-* should also be v0.4.23.

While the SDK versions are formatted as SemVer, we are not yet guaranteeing adherence to the SemVer spec. This means that breaking changes may appear in patch or minor version bumps, but they'll be notated in the CHANGELOG. We offer a couple of recommendations to combat any surprise issues for the time being:

1. Utilize TypeScript and static type checking when building applications with the SDK. It will help you identify any breaking changes before they go live.

2. Pin your installation to a specific patch version and upgrade them explicitly when you're ready. In package.json, use 0.4.23 instead of ^0.4.23 when setting up the dependencies.