trid3d 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ZachR622
+
+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

@@ -1,3 +1,105 @@
-# Temporary Holding Version
+<p align="center">
+  <img src="https://raw.githubusercontent.com/ZachR622/Trid/master/docs/public/logo.svg" width="96" alt="Trid logo">
+</p>
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<h1 align="center">Trid</h1>
+
+<p align="center">A small 3D library for the HTML canvas. No dependencies, no build step.</p>
+
+---
+
+Trid gives you a scene, a camera, shapes, model loading and mouse/keyboard tools, all in plain ES modules you can drop next to your page.
+
+> **Status:** early. Objects can be wireframes or filled and shaded; textures and shaders are on the way.
+
+## Features
+
+- **Scene** — holds a canvas, a camera and your objects, and runs the frame loop for you.
+- **Shapes** — cubes, boxes and spheres built in, or any mesh you define as vertices and edges.
+- **Filled faces** — give an object a `material` to fill and shade its faces, flat or smooth, with one directional light.
+- **Textures** — images, canvases or videos on faces, with texture coordinates from built-in shapes and OBJ files.
+- **Effects** — stack shader effects like toon, rim and edge glow, gradients and fog on a material, or write your own in GLSL.
+- **Two renderers** — the canvas 2D context by default, or `WebGLRenderer` for exact depth and big models, with the same scene code.
+- **OBJ files** — load models from a URL, or let users drop their own `.obj` files on the canvas.
+- **Camera** — position, yaw, pitch and field of view, with near-plane clipping.
+- **Tools** — orbit and fly cameras, object dragging, hover highlight, an FPS meter and an OBJ uploader, one line each. Writing your own is a plain object with a few methods.
+- **Pure math** — every transform and projection step is exported, so you can use the pipeline piece by piece.
+
+## Install
+
+```sh
+npm install trid3d
+```
+
+No bundler? Use the CDN with an import map, or copy the `trid/` folder next to your page and import `./trid/index.js`:
+
+```html
+<script type="importmap">
+  { "imports": { "trid3d": "https://cdn.jsdelivr.net/npm/trid3d@0.1/trid/index.js" } }
+</script>
+```
+
+## Quick start
+
+```html
+<canvas id="canvas"></canvas>
+<script type="module" src="main.js"></script>
+```
+
+```js
+// main.js
+import { Scene, makeShape, OrbitCamera } from "trid3d";
+
+const scene = new Scene(document.getElementById("canvas"), { width: 800, height: 400 });
+const cube = scene.add({ mesh: makeShape("cube"), color: "#E9806E" });              // wireframe
+const ball = scene.add({ mesh: makeShape("sphere"), material: { fill: "#8ab4f8" } }); // filled and shaded
+ball.pos.x = 0.8;
+
+scene.use(new OrbitCamera()); // drag to orbit, scroll to zoom
+scene.start((dt) => (cube.rot.y += dt));
+```
+
+Without a bundler, serve the folder (`python3 -m http.server`) instead of opening the file directly: browsers block module imports from `file://` pages.
+
+### Loading a model
+
+```js
+import { loadOBJ } from "trid3d";
+
+const mesh = await loadOBJ("models/teapot.obj", { fit: 1 }); // centered, 1 unit wide
+scene.add({ mesh });
+```
+
+Or let users load their own: `scene.use(new ObjUploader())` accepts dropped `.obj` files, and `uploader.open()` shows a file dialog.
+
+## Project layout
+
+| Folder | Content |
+| --- | --- |
+| `trid/index.js` | Entry file: exports everything (`"trid3d"`) |
+| `trid/scene.js` | The `Scene` class |
+| `trid/math/` | Transforms, camera directions, projection |
+| `trid/render/` | Renderers (Canvas 2D, WebGL), effects, shapes, drawing, frame loop |
+| `trid/loaders/` | OBJ and texture loading |
+| `trid/tools/` | Camera, object and overlay tools |
+| `docs/` | Documentation site with live demos |
+
+## Documentation
+
+**[zachr622.github.io/Trid](https://zachr622.github.io/Trid/)**: every class, option and function, with live demos.
+
+To run the docs locally (Node 18+):
+
+```sh
+npm install
+npm run docs:dev
+```
+
+See [`docs/README.md`](https://github.com/ZachR622/Trid/blob/master/docs/README.md) for building and editing the docs.
+
+## Roadmap
+
+- **More shapes** — cylinder, cone, torus, plane/grid
+- **More tools** — rotate/scale objects with the mouse, selection outline
+- **Parent/child transforms** — e.g. a moon orbiting a planet
+- **Tests** for the math functions

package/package.json

@@ -1,6 +1,47 @@
 {
   "name": "trid3d",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "A small 3D library for the HTML canvas: wireframes, filled and smooth faces, textures and shader effects, drawn with Canvas 2D or WebGL. No dependencies.",
+  "keywords": [
+    "3d",
+    "canvas",
+    "webgl",
+    "wireframe",
+    "renderer",
+    "obj",
+    "shader"
+  ],
+  "license": "MIT",
+  "author": "ZachR622",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ZachR622/Trid.git"
+  },
+  "homepage": "https://zachr622.github.io/Trid/",
+  "bugs": {
+    "url": "https://github.com/ZachR622/Trid/issues"
+  },
+  "type": "module",
+  "main": "./trid/index.js",
+  "module": "./trid/index.js",
+  "types": "./trid/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./trid/index.d.ts",
+      "default": "./trid/index.js"
+    },
+    "./*": "./trid/*"
+  },
+  "files": [
+    "trid"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs"
+  },
+  "devDependencies": {
+    "vitepress": "^1.6.4"
+  }
+}