Skip to content

Latest commit

 

History

History
68 lines (52 loc) · 1.68 KB

README.md

File metadata and controls

68 lines (52 loc) · 1.68 KB
Raw

Zylem

A powerful and easy-to-use framework for creating simple 3D digital interactive applications using TypeScript.

Note: This project is still in alpha. There are unfinished features and some APIs that may change.

Installation

pnpm install
npm run dev

Examples

Check out the examples repo here

Basic Usage

Basic usage repo here

<!DOCTYPE html>
<html lang="en">
 <head>
  <meta charset="UTF-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Zylem - Basic Usage</title>
  <link rel="stylesheet" href="./index.css" />
 </head>
 <body>
  <script src="./src/index.ts" type="module"></script>
 </body>
</html>
import { game, stage, sphere } from '@tcool86/zylem';

const example = game(
 stage(),
 sphere({
  update: ({ entity: ball, inputs }) => {
   const { horizontal, vertical } = inputs[0];
   ball.moveXY(horizontal * 5, -vertical * 5);
  }
 })
);

example.start();

Repository Governance

Conventional commits

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • cleanup: Removal of dead code, unused functionality, or code changes involving renaming
  • perf: A code change that improves performance
  • test: Adding missing or correcting existing tests
  • build: Changes that affect the build system or external dependencies (example scopes: vite, npm, typescript, etc)