Skip to content

Open-source platform for 3D AI agents. Turn text or a photo into a rigged, animated GLB avatar, give it an LLM brain, memory and a wallet, and embed it anywhere with one web component. Remote MCP server, x402 payments, Three.js, browser-native.

1.4 KB
Raw Blame
{
  "name": "readme-3d",
  "version": "0.1.1",
  "description": "Put interactive, rotatable 3D models in your GitHub README. Converts GLB, glTF, OBJ, and binary STL into the ASCII STL markdown blocks GitHub renders natively - with mesh simplification to fit the 512 KB markdown budget.",
  "type": "module",
  "bin": {
    "readme-3d": "./bin/readme3d.js",
    "readme3d": "./bin/readme3d.js"
  },
  "main": "./src/index.js",
  "exports": {
    ".": "./src/index.js",
    "./package.json": "./package.json"
  },
  "files": [
    "bin",
    "src",
    "README.md",
    "LICENSE",
    "NOTICE"
  ],
  "scripts": {
    "test": "node --test test/*.test.js"
  },
  "keywords": [
    "readme",
    "github",
    "markdown",
    "3d",
    "stl",
    "ascii-stl",
    "glb",
    "gltf",
    "obj",
    "3d-model",
    "github-readme",
    "embed",
    "viewer",
    "mesh-simplification",
    "meshoptimizer",
    "three-js",
    "3d-printing"
  ],
  "repository": {
    "type": "git",
    "url": "git+https://github.com/nirholas/readme-3d.git"
  },
  "homepage": "https://nirholas.github.io/readme-3d/",
  "bugs": {
    "url": "https://github.com/nirholas/readme-3d/issues"
  },
  "author": "three.ws (https://three.ws)",
  "license": "Apache-2.0",
  "engines": {
    "node": ">=18"
  },
  "dependencies": {
    "@gltf-transform/core": "^4.4.0",
    "@gltf-transform/extensions": "^4.4.0",
    "draco3dgltf": "^1.5.7",
    "meshoptimizer": "^1.1.1"
  }
}