Installation

Get started with HoloScript in your development environment.

VS Code Extension

The easiest way to start using HoloScript.

Install from Marketplace

ext install holoscript.holoscript-vscode

Or search "HoloScript Enhanced" in the VS Code extensions marketplace.

Features Included

• ✅ Syntax highlighting for .hs, .hsplus, .holo
• ✅ IntelliSense and autocomplete
• ✅ Error checking and diagnostics
• ✅ Hover documentation for traits
• ✅ Code snippets
• ✅ Live preview (coming soon)

---

CLI Tools

For compiling and building HoloScript projects.

Install via npm

npm install -g @holoscript/cli

Verify Installation

holoscript --version
# HoloScript CLI v1.0.0

Basic Commands

# Create new project
holoscript init my-project

# Validate syntax
holoscript validate scene.holo

# Preview locally
holoscript preview scene.holo

# Compile to target
holoscript compile scene.holo --target threejs
holoscript compile scene.holo --target unity
holoscript compile scene.holo --target vrchat

# Watch mode
holoscript watch src/ --target threejs

---

MCP Server (For AI Integration)

Connect AI agents (Claude, GPT, Cursor) to HoloScript.

Install

npm install @holoscript/mcp-server

Configure for Claude Desktop

Add to Claude Desktop config (~/.claude/settings.json):

{
  "mcpServers": {
    "holoscript": {
      "command": "npx",
      "args": ["@holoscript/mcp-server"]
    }
  }
}

Available MCP Tools

Tool	Description
generate_object	Create objects from descriptions
generate_scene	Create complete compositions
validate_holoscript	Check code for errors
suggest_traits	Get trait recommendations
explain_code	Get plain English explanation

See MCP Server Guide for full documentation.

---

Package Installation

Use HoloScript packages in your projects.

Core Parser

npm install @holoscript/core

import { parse } from '@holoscript/core';

const ast = parse(`
  orb hello {
    message: "Hello World"
  }
`);

Traits Library

npm install @holoscript/traits

import { getTraitDefinition, listAllTraits } from '@holoscript/traits';

const grabbable = getTraitDefinition('grabbable');
console.log(grabbable.parameters);

Compiler

npm install @holoscript/compiler

import { compile } from '@holoscript/compiler';

const output = compile(holoCode, { target: 'threejs' });

---

Project Setup

Create New Project

holoscript init my-vr-game
cd my-vr-game

Project Structure

my-vr-game/
├── src/
│   ├── scenes/
│   │   └── main.holo
│   ├── templates/
│   │   └── enemies.hsplus
│   └── assets/
│       ├── models/
│       └── sounds/
├── dist/
├── holoscript.config.json
└── package.json

Configuration

holoscript.config.json:

{
  "entry": "src/scenes/main.holo",
  "outDir": "dist",
  "targets": ["threejs", "unity"],
  "assets": {
    "models": "src/assets/models",
    "sounds": "src/assets/sounds"
  },
  "optimization": {
    "minify": true,
    "treeshake": true
  }
}

---

Development Workflow

1. Write HoloScript

Create your scene in .holo:

composition "My Scene" {
  environment {
    skybox: "sunset"
  }
  
  object "Player" {
    @collidable
    position: [0, 1.6, 0]
  }
}

2. Validate

holoscript validate src/scenes/main.holo

3. Preview

holoscript preview src/scenes/main.holo

4. Compile

holoscript compile src/scenes/main.holo --target threejs

5. Deploy

Output is in dist/ ready for deployment.

---

System Requirements

Requirement	Minimum
Node.js	v18+
VS Code	v1.85+
RAM	4GB
OS	Windows, macOS, Linux

---

Next Steps

• Quick Start - Build your first scene
• VS Code Guide - Editor features
• File Formats - Understanding .hs, .hsplus, .holo