@tcool86/zylem
v0.2.2
Published
A powerful and easy-to-use framework for creating simple 3D digital interactive applications using TypeScript.
Downloads
13
Maintainers
tcool86Readme
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 installnpm run devExamples
Check out the examples repo here
Basic Usage
<!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 featurefix: A bug fixdocs: Documentation only changesstyle: 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 featurecleanup: Removal of dead code, unused functionality, or code changes involving renamingperf: A code change that improves performancetest: Adding missing or correcting existing testsbuild: Changes that affect the build system or external dependencies (example scopes: vite, npm, typescript, etc)