opensim-stack.github.io/get-it.html at main · opensim-stack/opensim-stack.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Get It — OpenSim AI Stack</title>
  <meta name="description" content="Install the OpenSim AI Stack with Docker Compose.">
  <link rel="preconnect" href="https://fonts.googleapis.com">
  <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  <link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700;800&family=JetBrains+Mono:wght@400;500;600&display=swap" rel="stylesheet">
  <script src="https://cdn.tailwindcss.com"></script>
  <script>
    tailwind.config = {
      darkMode: 'class',
      theme: {
        extend: {
          colors: {
            dark: { 900: '#0a0a12', 800: '#12121f', 700: '#1a1a2e', 600: '#252542' },
            neon: { primary: '#8b5cf6', secondary: '#d946ef', accent: '#06b6d4' }
          }
        }
      }
    }
  </script>
  <link rel="stylesheet" href="styles.css">
</head>
<body class="min-h-screen bg-dark-900 text-gray-100">
  <canvas id="code-rain"></canvas>
  <div class="cyber-grid"></div>
  <div class="shape shape-1"></div>
  <div class="shape shape-2"></div>
  <div class="shape shape-3"></div>

  <nav class="navbar fixed top-0 left-0 right-0 z-50">
    <div class="container mx-auto px-4 py-3 flex items-center justify-between">
      <a href="index.html" class="flex items-center gap-3 group">
        <img src="opensim-stack.png" alt="OpenSim AI Stack" class="h-10 w-auto drop-shadow-lg group-hover:drop-shadow-[0_0_10px_rgba(139,92,246,0.8)] transition-all">
        <span class="text-xl font-bold gradient-text">OpenSim AI Stack</span>
      </a>
      <div class="hidden md:flex items-center gap-1">
        <a href="index.html" class="px-3 py-2 rounded-lg text-gray-100 hover:text-neon-primary transition-colors">Home</a>
        <a href="get-it.html" class="px-3 py-2 rounded-lg text-neon-primary transition-colors">Get It</a>
        <a href="play-it.html" class="px-3 py-2 rounded-lg text-gray-100 hover:text-neon-primary transition-colors">Play It</a>
        <a href="extend-it.html" class="px-3 py-2 rounded-lg text-gray-100 hover:text-neon-primary transition-colors">Extend It</a>
        <a href="share-it.html" class="px-3 py-2 rounded-lg text-gray-100 hover:text-neon-primary transition-colors">Share It</a>
        <a href="docs/index.html" class="px-3 py-2 rounded-lg text-gray-100 hover:text-neon-primary transition-colors">Docs</a>
        <a href="https://github.com/opensim-stack/opensim-ai-docker" target="_blank" rel="noopener" class="ml-2 px-4 py-2 rounded-lg bg-neon-primary text-white font-medium hover:bg-violet-500 transition-colors btn-glow">GitHub</a>
      </div>
      <button id="mobile-menu-btn" class="md:hidden p-2 rounded-lg text-gray-100 hover:bg-dark-700 transition-colors" aria-label="Toggle menu">
        <svg xmlns="http://www.w3.org/2000/svg" class="h-6 w-6" fill="none" viewBox="0 0 24 24" stroke="currentColor">
          <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M4 6h16M4 12h16M4 18h16" />
        </svg>
      </button>
    </div>
    <div id="mobile-menu" class="mobile-menu md:hidden border-t border-neon-primary/20 bg-dark-900/95 backdrop-blur">
      <div class="container mx-auto px-4 py-4 flex flex-col gap-2">
        <a href="index.html" class="px-4 py-2 rounded-lg text-gray-100 hover:bg-dark-700">Home</a>
        <a href="get-it.html" class="px-4 py-2 rounded-lg text-gray-100 hover:bg-dark-700">Get It</a>
        <a href="play-it.html" class="px-4 py-2 rounded-lg text-gray-100 hover:bg-dark-700">Play It</a>
        <a href="extend-it.html" class="px-4 py-2 rounded-lg text-gray-100 hover:bg-dark-700">Extend It</a>
        <a href="share-it.html" class="px-4 py-2 rounded-lg text-gray-100 hover:bg-dark-700">Share It</a>
        <a href="docs/index.html" class="px-4 py-2 rounded-lg text-gray-100 hover:bg-dark-700">Docs</a>
        <a href="https://github.com/opensim-stack/opensim-ai-docker" target="_blank" rel="noopener" class="px-4 py-2 rounded-lg bg-neon-primary text-white text-center">GitHub</a>
      </div>
    </div>
  </nav>

  <main class="pt-20">
    <section class="container mx-auto px-4 py-16 lg:py-24">
      <div class="max-w-4xl mx-auto">
        <div class="text-center mb-12 animate-on-scroll">
          <h1 class="text-4xl lg:text-6xl font-extrabold mb-4 text-white">Get <span class="gradient-text neon-text">It</span></h1>
          <p class="text-lg text-gray-400">Deploy your AI-enabled OpenSimulator grid in minutes.</p>
        </div>

        <div class="bg-dark-800/80 backdrop-blur border border-neon-primary/20 p-6 lg:p-8 rounded-xl mb-8 animate-on-scroll">
          <h2 class="text-2xl font-bold mb-6 flex items-center gap-3 text-white">
            <span class="w-8 h-8 rounded-lg bg-neon-primary/20 flex items-center justify-center text-neon-primary text-sm">1</span>
            Prerequisites
          </h2>
          <div class="grid md:grid-cols-2 gap-6">
            <div class="space-y-3">
              <h3 class="text-lg font-semibold text-white">Docker Compose</h3>
              <p class="text-gray-400 text-sm">You need Docker Engine and Docker Compose v2 (<code>docker compose</code>) installed.</p>
              <a href="https://docs.docker.com/compose/install/" target="_blank" rel="noopener" class="inline-block px-4 py-2 rounded-lg border border-neon-primary/50 text-gray-100 hover:bg-neon-primary/10 text-sm transition-colors">Install Docker Compose</a>
            </div>
            <div class="space-y-3">
              <h3 class="text-lg font-semibold text-white">OpenSimulator Viewer</h3>
              <p class="text-gray-400 text-sm">A viewer is how you log in to your grid. We recommend Firestorm, but any compatible viewer works.</p>
              <div class="flex flex-wrap gap-2">
                <a href="https://www.firestormviewer.org/" target="_blank" rel="noopener" class="px-4 py-2 rounded-lg border border-neon-secondary/50 text-gray-100 hover:bg-neon-secondary/10 text-sm transition-colors">Firestorm</a>
                <a href="https://www.singularityviewer.org/downloads/" target="_blank" rel="noopener" class="px-4 py-2 rounded-lg border border-neon-accent/50 text-gray-100 hover:bg-neon-accent/10 text-sm transition-colors">Singularity</a>
                <a href="https://sldev.pages-perso.free.fr/" target="_blank" rel="noopener" class="px-4 py-2 rounded-lg border border-neon-secondary/70 text-gray-100 hover:bg-neon-secondary/50 text-sm transition-colors">Cool VL</a>

              </div>
            </div>
          </div>
        </div>

        <div class="bg-dark-800/80 backdrop-blur border border-neon-secondary/20 p-6 lg:p-8 rounded-xl mb-8 animate-on-scroll">
          <h2 class="text-2xl font-bold mb-6 flex items-center gap-3 text-white">
            <span class="w-8 h-8 rounded-lg bg-neon-secondary/20 flex items-center justify-center text-neon-secondary text-sm">2</span>
            Compose
          </h2>
          <div class="space-y-6">
            <div>
              <p class="text-gray-300 mb-3">Clone the repository and switch into it:</p>
              <div class="relative">
                <pre id="code-clone"><code>git clone https://github.com/opensim-stack/opensim-ai-docker.git
cd opensim-ai-docker</code></pre>
                <button class="copy-btn absolute top-2 right-2 px-3 py-1 rounded bg-dark-700 text-gray-300 text-xs hover:bg-dark-600 transition-colors" data-target="#code-clone">Copy</button>
              </div>
            </div>
            <div>
              <p class="text-gray-300 mb-3">Create your environment file from the example:</p>
              <div class="relative">
                <pre id="code-env"><code>cp .env.example .env</code></pre>
                <button class="copy-btn absolute top-2 right-2 px-3 py-1 rounded bg-dark-700 text-gray-300 text-xs hover:bg-dark-600 transition-colors" data-target="#code-env">Copy</button>
              </div>
            </div>
            <div class="flex items-start gap-3 p-4 rounded-lg border border-orange-500/30 bg-orange-500/10 text-gray-100">
              <svg xmlns="http://www.w3.org/2000/svg" class="h-6 w-6 shrink-0 text-orange-400" fill="none" viewBox="0 0 24 24" stroke="currentColor">
                <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z" />
              </svg>
              <span><strong>You must set <code>OPENSIM_HOSTNAME</code></strong> in <code>.env</code> or the stack will only work on <code>localhost</code>.</span>
            </div>
            <div>
              <p class="text-gray-300 mb-3">Start the release stack (recommended for first-timers):</p>
              <div class="relative">
                <pre id="code-up"><code>docker compose -f docker-compose.release.yml up -d</code></pre>
                <button class="copy-btn absolute top-2 right-2 px-3 py-1 rounded bg-dark-700 text-gray-300 text-xs hover:bg-dark-600 transition-colors" data-target="#code-up">Copy</button>
              </div>
            </div>
            <div>
              <p class="text-gray-300 mb-3">Or use the helper script for a local release build:</p>
              <div class="relative">
                <pre id="code-run"><code>./run-release.sh</code></pre>
                <button class="copy-btn absolute top-2 right-2 px-3 py-1 rounded bg-dark-700 text-gray-300 text-xs hover:bg-dark-600 transition-colors" data-target="#code-run">Copy</button>
              </div>
            </div>
            <div class="flex flex-wrap gap-3 pt-2">
              <a href="https://github.com/opensim-stack/opensim-ai-docker/blob/main/docker-compose.release.yml" target="_blank" rel="noopener" class="px-4 py-2 rounded-lg bg-neon-primary text-white text-sm font-medium hover:bg-violet-500 transition-colors btn-glow">View docker-compose.release.yml</a>
              <a href="https://github.com/opensim-stack/opensim-ai-docker/blob/main/.env.example" target="_blank" rel="noopener" class="px-4 py-2 rounded-lg border border-neon-primary/50 text-gray-100 hover:bg-neon-primary/10 text-sm transition-colors">View .env.example</a>
            </div>
          </div>
        </div>

        <div class="bg-dark-800/80 backdrop-blur border border-neon-accent/20 p-6 lg:p-8 rounded-xl animate-on-scroll">
          <h2 class="text-2xl font-bold mb-6 flex items-center gap-3 text-white">
            <span class="w-8 h-8 rounded-lg bg-neon-accent/20 flex items-center justify-center text-neon-accent text-sm">3</span>
            Key Environment Variables
          </h2>
          <div class="overflow-x-auto">
            <table class="data-table text-sm">
              <thead>
                <tr><th>Variable</th><th>Default</th><th>Purpose</th></tr>
              </thead>
              <tbody>
                <tr><td><code>OPENSIM_HOSTNAME</code></td><td><code>opensim</code></td><td>Public hostname for the grid. <strong>Required to change.</strong></td></tr>
                <tr><td><code>OPENSIM_REGION_NAME</code></td><td><code>Welcome Island</code></td><td>Name of your first region.</td></tr>
                <tr><td><code>OPENSIM_REGION_PORT</code></td><td><code>9000</code></td><td>Simulator TCP/UDP port.</td></tr>
                <tr><td><code>OPENSIM_ESTATE_OWNER_FIRST</code></td><td><code>Admin</code></td><td>Estate owner first name.</td></tr>
                <tr><td><code>OPENSIM_ESTATE_OWNER_LAST</code></td><td><code>User</code></td><td>Estate owner last name.</td></tr>
                <tr><td><code>OPENSIM_ESTATE_OWNER_PASSWORD</code></td><td><code>changeme</code></td><td>Estate owner password. Change before exposing externally.</td></tr>
                <tr><td><code>OPENSIM_LOGIN_FIRSTNAME</code></td><td><code>Bot</code></td><td>Bot avatar first name.</td></tr>
                <tr><td><code>OPENSIM_LOGIN_LASTNAME</code></td><td><code>User</code></td><td>Bot avatar last name.</td></tr>
                <tr><td><code>OPENSIM_LOGIN_PASSWORD</code></td><td><code>botpassword</code></td><td>Bot avatar password.</td></tr>
                <tr><td><code>MARIADB_PASSWORD</code></td><td><code>opensimpassword</code></td><td>MariaDB application password.</td></tr>
                <tr><td><code>MARIADB_ROOT_PASSWORD</code></td><td><code>rootpassword</code></td><td>MariaDB root password.</td></tr>
              </tbody>
            </table>
          </div>
          <div class="flex items-start gap-3 p-4 rounded-lg border border-cyan-500/30 bg-cyan-500/10 text-gray-100 mt-6">
            <svg xmlns="http://www.w3.org/2000/svg" class="h-6 w-6 shrink-0 text-cyan-400" fill="none" viewBox="0 0 24 24" stroke="currentColor">
              <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" />
            </svg>
            <span>See <a href="https://github.com/opensim-stack/opensim-ai-docker/blob/main/.env.example" target="_blank" rel="noopener" class="text-cyan-400 hover:underline">.env.example</a> for the full list of variables, including MCP ports, Opencode settings, and LSL bridge options.</span>
          </div>
        </div>
      </div>
    </section>
  </main>

  <footer class="border-t border-neon-primary/20 bg-dark-800/50 backdrop-blur mt-12">
    <div class="container mx-auto px-4 py-8">
      <div class="flex flex-col md:flex-row items-center justify-between gap-4">
        <div class="flex items-center gap-3">
          <img src="opensim-stack.png" alt="OpenSim AI Stack" class="h-8 w-auto">
          <span class="font-bold gradient-text">OpenSim AI Stack</span>
        </div>
        <div class="flex gap-6 text-sm text-gray-400">
          <a href="https://github.com/opensim-stack/opensim-ai-docker" target="_blank" rel="noopener" class="hover:text-neon-primary transition-colors">GitHub</a>
          <a href="https://hub.docker.com/repository/docker/bithatch/opensim-ai-standalone/general" target="_blank" rel="noopener" class="hover:text-neon-primary transition-colors">Docker Hub</a>
          <a href="https://opensimulator.org/" target="_blank" rel="noopener" class="hover:text-neon-primary transition-colors">OpenSimulator</a>
        </div>
        <p class="text-sm text-gray-500">Experimental work in progress.</p>
      </div>
    </div>
  </footer>

  <script src="script.js"></script>
</body>
</html>