# @three-ws/portal

> Turn any website into a walkable 3D world. Reads a page's real structure and lays out a city from it: sections become buildings, links become doors, images become billboards. Pure layout in JS, a client for the three.ws Portal API, a CLI, and an MCP server.

- Repository: https://github.com/nirholas/portal
- Documentation: https://nirholas.github.io/portal/
- npm: https://www.npmjs.com/package/@three-ws/portal
- License: Apache-2.0
- Part of three.ws: https://three.ws

## Docs

- [README](https://github.com/nirholas/portal/blob/main/README.md): install, usage and full API reference
- [Full text for LLMs](https://nirholas.github.io/portal/llms-full.txt): the entire README as plain text
- [AGENTS.md](https://github.com/nirholas/portal/blob/main/AGENTS.md): conventions for coding agents
- [Security policy](https://github.com/nirholas/portal/blob/main/SECURITY.md)
- [Contributing](https://github.com/nirholas/portal/blob/main/CONTRIBUTING.md)