Oasis Engine (Ant Graphics Engine)

Oasis 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. This repository is the core engine of Oasis. 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 get root entity.
const engine = new WebGLEngine("canvas-id");
const canvas = engine.canvas;
const rootEntity = engine.sceneManager.activeScene.createRootEntity("Root");
canvas.width = window.innerWidth * SystemInfo.devicePixelRatio;
canvas.height = window.innerHeight * SystemInfo.devicePixelRatio;

// Create light.
const lightEntity = rootEntity.createChild("Light");
const ambient = lightEntity.addComponent(AmbientLight);
const directLight = lightEntity.addComponent(DirectLight);
ambient.color = new Color(0.5, 0.5, 0.5);
directLight.color = new Color(0.3, 0.4, 0.4);

// Create camera.
const cameraEntity = rootEntity.createChild("Camera");
cameraEntity.transform.setPosition(0, 6, 10);
cameraEntity.transform.lookAt(new Vector3(0, 0, 0));
cameraEntity.addComponent(Camera);

// Create cube.
const cubeEntity = rootEntity.createChild("Cube");
const cubeRenderer = cubeEntity.addComponent(MeshRenderer);
const material = new BlinnPhongMaterial(engine);
cubeEntity.transform.rotate(0, 60, 0);
cubeRenderer.mesh = PrimitiveMesh.createCuboid(engine, 1, 1, 1);
cubeRenderer.setMaterial(material);

// Run engine.
engine.run();

npm

Oasis Engine are published on npm with full typing support. To install, use:

npm install oasis-engine

This will allow you to import Oasis 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 for wechat miniprogram or minigame, using npm:

npm run b:wechat

All the build details are in rollup.wechat.config.js, there are several adaptation manner:

API Polyfill

create a adapter for standard API, just like Alipay Miniprogram adaptation skills

const adapterArray = [
  "window",
  "WebGLRenderingContext",
  "WebGL2RenderingContext",
  "document",
  "Element",
  "Event",
  "EventTarget",
  "HTMLCanvasElement",
  "HTMLElement",
  "HTMLMediaElement",
  "HTMLVideoElement",
  "Image",
  "navigator",
  "Node",
  "requestAnimationFrame",
  "cancelAnimationFrame",
  "performance",
];

Compiler Variable

Used for compile-time logic replacement

if (process.env.WECHAT) {
  // logic in wechat platform
}

Related files:

packages/loaders/src/BufferLoader.ts
packages/loader/src/gltf/Util.ts
packages/core/src/asset/request.ts

Module Replaced

replace a module with another file, by custom rollup plugin

const adapterRemap = {
  './OrbitControl': './WechatOrbitControl',
  './SystemInfo': './WechatSystemInfo',
  '../SystemInfo': '../WechatSystemInfo',
  './WebGLRenderer': './WechatWebGLRenderer',
}