Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,20 @@ python -m k3dgen examples/sample_vectors.csv --gltf examples/sample_output.gltf

The command writes both `examples/sample_output.gltf` and `examples/sample_output.k3d`.

## Browser viewer

To explore the generated dataset in 3D:

```bash
cd viewer
npm install
npm run dev
```

This launches a local server that renders `examples/sample_output.gltf` and shows point IDs on hover.

![Viewer preview](Screenshot_20250730_153941.png)

## Licensing

All code in this repository is released under the Apache‑2.0 License. The white‑paper and related text documents are distributed under the Creative Commons Attribution 4.0 International (CC‑BY‑4.0) license. See [`/docs/LICENSE-CC-BY-4.0.txt`](docs/LICENSE-CC-BY-4.0.txt) for the full CC‑BY‑4.0 text. GitHub may report "No license" for the documentation, but this file is authoritative.
Expand Down
8 changes: 4 additions & 4 deletions docs/ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ This document outlines the planned phases for getting the Knowledge3D repository

## Status

Phases 0 and 1 are complete. With this update the repository enters **Phase 2**
and includes the first working prototype of `k3dgen`. The repository also
Phases 0–2 are complete. With this update the repository enters **Phase 3**
and adds a lightweight Three.js viewer under `/viewer`. The repository also
aggregates AI-generated documents from ChatGPT, Gemini, Claude, Manus AI, and
Perplexity AI under [`reports/Diverse_AI_Reports.md`](reports/Diverse_AI_Reports.md) to reference the many formats that
will be joined going forward.

The first dataset produced by `k3dgen` lives at
`examples/sample_output.k3d` alongside its glTF scene. This file marks the
initial test of the pipeline.
`examples/sample_output.k3d` alongside its glTF scene and now renders in the
browser viewer.

In August 2025 the team adopted the **EchoSystems K3D Collaboration Action Plan**. The first directive is fulfilled here by publishing the draft [`spec/k3d_node_schema.json`](../spec/k3d_node_schema.json). Upcoming milestones will align with the plan's MVP Flight Plan.

Expand Down
24 changes: 24 additions & 0 deletions viewer/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

node_modules
dist
dist-ssr
*.local

# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
13 changes: 13 additions & 0 deletions viewer/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>K3D Viewer</title>
</head>
<body>
<canvas id="scene"></canvas>
<div id="tooltip" style="position: absolute; display: none; background: #fff; border: 1px solid #000; padding: 2px 4px; font-size: 12px;"></div>
<script type="module" src="/src/main.ts"></script>
</body>
</html>
10 changes: 10 additions & 0 deletions viewer/jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
export default {
preset: 'ts-jest',
testEnvironment: 'jsdom',
roots: ['<rootDir>/tests'],
globals: {
'ts-jest': {
tsconfig: './tsconfig.test.json'
}
}
};
Loading