Skip to content

galacean/engine

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

author
shensi.zxd
Mar 14, 2022
ae91a4b ยท Mar 14, 2022
Jul 14, 2021
Mar 14, 2022
Jun 16, 2021
Feb 8, 2021
Jan 26, 2021
May 17, 2021
Jan 26, 2021
Apr 27, 2021
Jan 27, 2021
Dec 29, 2021
Jan 25, 2021
Apr 2, 2021
Mar 3, 2022
Nov 15, 2021
Jun 7, 2021
Apr 2, 2021
Jan 25, 2021

Repository files navigation

Ant Graphics Engine

npm-size npm-download codecov

This is a web-first and mobile-first high-performance real-time development platform. 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

  • ๐Ÿ–ฅ  Platform - Suppport HTML5 and Alipay miniprogram
  • ๐Ÿ”ฎ  Graphics - Advanced 2D + 3D graphics engine
  • ๐Ÿƒ  Animation - Powerful animation system
  • ๐Ÿ“‘  Scripts - Use TypeScript to write logic efficiently

Usage

// 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();

npm

The engine is published on npm with full typing support. To install, use:

npm install oasis-engine

This will allow you to import engine entirely using:

import * as OASIS from "oasis-engine";

or individual classes using:

import { Engine, Scene, Entity } from "oasis-engine";

Contributing

Everyone is welcome to join us! Whether you find a bug, have a great feature request or you fancy owning a task from the road map feel free to get in touch.

Make sure to read the Contributing Guide / ่ดก็ŒฎๆŒ‡ๅ— before submitting changes.

Build

If you don't already have Node.js and NPM, go install them. Then, in the folder where you have cloned the repository, install the build dependencies using npm:

npm run bootstrap

Then, to build the source, using npm:

npm run b:all

Links

License

The engine is released under the MIT license. See LICENSE file.