@galacean/engine 0.0.0-experimental-animator-additive.1

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright © 2020-2023 Galacean authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,82 @@
+# Galacean Engine
+
+<a href="https://www.npmjs.com/package/@galacean/engine"><img src="https://img.shields.io/npm/v/@galacean/engine"/></a>
+![npm-size](https://img.shields.io/bundlephobia/minzip/@galacean/engine)
+![npm-download](https://img.shields.io/npm/dm/@galacean/engine)
+[![codecov](https://codecov.io/gh/galacean/engine/branch/main/graph/badge.svg?token=KR2UBKE3OX)](https://codecov.io/gh/galacean/engine)
+
+Galacean is a **web-first** and **mobile-first** high-performance real-time interactive engine. Use **component system design** and pursue ease of use and light weight. Developers can independently use and write Typescript scripts to develop projects using pure code.
+
+## Features
+
+- 🖥  &nbsp;**Platform** - Suppport HTML5 and Alipay miniprogram
+- 🔮  &nbsp;**Graphics** - Advanced 2D + 3D graphics engine
+- 🏃  &nbsp;**Animation** - Powerful animation system
+- 🧱  &nbsp;**Physics** - Powerful and easy-to-use physical features
+- 👆  &nbsp;**Input** - Easy-to-use interactive capabilities
+- 📑  &nbsp;**Scripts** - Use TypeScript to write logic efficiently
+
+## Installation
+
+To install, use:
+
+```sh
+npm install @galacean/engine
+```
+
+This will allow you to import engine entirely using:
+
+```javascript
+import * as GALACEAN from "@galacean/engine";
+```
+
+or individual classes using:
+
+```javascript
+import { Engine, Scene, Entity } from "@galacean/engine";
+```
+
+## Usage
+
+```typescript
+// Create engine by passing in the HTMLCanvasElement id and adjust canvas size.
+const engine = new WebGLEngine("canvas-id");
+engine.canvas.resizeByClientSize();
+
+// Get scene and create root entity.
+const scene = engine.sceneManager.activeScene;
+const rootEntity = scene.createRootEntity("Root");
+
+// Create light.
+const lightEntity = rootEntity.createChild("Light");
+const directLight = lightEntity.addComponent(DirectLight);
+lightEntity.transform.setRotation(-45, -45, 0);
+directLight.intensity = 0.4;
+
+// Create camera.
+const cameraEntity = rootEntity.createChild("Camera");
+cameraEntity.addComponent(Camera);
+cameraEntity.transform.setPosition(0, 0, 12);
+
+// Create sphere.
+const meshEntity = rootEntity.createChild("Sphere");
+const meshRenderer = meshEntity.addComponent(MeshRenderer);
+const material = new BlinnPhongMaterial(engine);
+meshRenderer.setMaterial(material);
+meshRenderer.mesh = PrimitiveMesh.createSphere(engine, 1);
+
+// Run engine.
+engine.run();
+```
+
+## Links
+
+- [Official Site](https://oasisengine.cn)
+- [Examples](https://oasisengine.cn/#/examples/latest)
+- [Documentation](https://oasisengine.cn/#/docs/latest/cn/install)
+- [API References](https://oasisengine.cn/#/api/latest/core)
+
+
+## License 
+
+The engine is released under the [MIT](https://opensource.org/licenses/MIT) license. See LICENSE file.