|
|
@@ -2,45 +2,43 @@
|
|
|
<img src="build/Icons/glTF2Sharp.png" height=128 />
|
|
|
</p>
|
|
|
|
|
|
+
|
|
|
+
|
|
|
---
|
|
|
|
|
|
### Overview
|
|
|
|
|
|
-SharpGLTF is a NetStandard 2.0, .NET library designed to support
|
|
|
+__SharpGLTF__ is a 100% .NET Standard library designed to support
|
|
|
[Khronos Group glTF 2.0](https://github.com/KhronosGroup/glTF) file format.
|
|
|
|
|
|
-The aim of this framework is:
|
|
|
+The library is divided into two main packages:
|
|
|
|
|
|
-- To be able to create, manipulate, load and save glTF2 documents.
|
|
|
-- To provide a safe and easy to use high level API to produce 3D assets.
|
|
|
-
|
|
|
-The current status of the library is preview alpha, but, for some use cases it is already usable.
|
|
|
+- [__SharpGLTF.Core__](src/SharpGLTF.Core/README.md) provides read/write file support, and low level access to the glTF models.
|
|
|
+- [__SharpGLTF.Toolkit__](src/SharpGLTF.Toolkit/README.md) provides convenient utilities to help create, manipulate and evaluate glTF models.
|
|
|
|
|
|
#### Nuget Packages
|
|
|
|
|
|
-- [SharpGLTF.Core](https://www.nuget.org/packages/SharpGLTF.Core)
|
|
|
-- [SharpGLTF.Toolkit](https://www.nuget.org/packages/SharpGLTF.Toolkit)
|
|
|
+|Package|Version|
|
|
|
+|-|-|
|
|
|
+|[__SharpGLTF.Core__](https://www.nuget.org/packages/SharpGLTF.Core)||
|
|
|
+|[__SharpGLTF.Toolkit__](https://www.nuget.org/packages/SharpGLTF.Toolkit)||
|
|
|
+
|
|
|
+The library is still in preview status because the APIs are still subject to change from version to version,
|
|
|
+but most of the features are already completed and heavily tested, so I believe the code is mature enough
|
|
|
+to be used in production.
|
|
|
+
|
|
|
|
|
|
#### Quickstart
|
|
|
|
|
|
A simple example of loading a glTF file and saving it as GLB:
|
|
|
|
|
|
```c#
|
|
|
-var model = Schema2.ModelRoot.Load("model.gltf");
|
|
|
+var model = SharpGLTF.Schema2.ModelRoot.Load("model.gltf");
|
|
|
model.SaveGLB("model.glb");
|
|
|
```
|
|
|
|
|
|
More examples can be found [here](examples) and in the Test project.
|
|
|
|
|
|
-#### Design
|
|
|
-
|
|
|
-The framework is divided in two packages:
|
|
|
-
|
|
|
-- __[SharpGLTF.Core](src/SharpGLTF.Core/README.md)__ provides the core glTF2 schema implementation,
|
|
|
-read & write operations, and a low level API for direct document access.
|
|
|
-- __[SharpGLTF.Toolkit](src/SharpGLTF.Toolkit/README.md)__ provides a high level API over the Core
|
|
|
-package, adding convenient extensions and utilities to help creating meshes, materials and scenes.
|
|
|
-
|
|
|
#### Appendix
|
|
|
|
|
|
- [Khronos Group glTF-CSharp-Loader](https://github.com/KhronosGroup/glTF-CSharp-Loader)
|
vpenades