eliza/packages/examples/setup-guide.html at develop · elizaOS/eliza · 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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>elizaOS Examples Setup Guide</title>
    <style>
      :root {
        color-scheme: light dark;
        font-family:
          Inter, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont,
          "Segoe UI", sans-serif;
        line-height: 1.5;
      }
      body {
        margin: 0;
        color: #1f2937;
        background: #f7f7f5;
      }
      main {
        max-width: 980px;
        margin: 0 auto;
        padding: 40px 24px 64px;
      }
      h1,
      h2,
      h3 {
        color: #111827;
        line-height: 1.15;
      }
      h1 {
        margin: 0 0 8px;
        font-size: 34px;
      }
      h2 {
        margin-top: 36px;
        padding-top: 22px;
        border-top: 1px solid #d8d8d2;
      }
      a {
        color: #075985;
      }
      code,
      pre {
        font-family: ui-monospace, SFMono-Regular, Menlo, Consolas, monospace;
      }
      pre {
        overflow: auto;
        padding: 14px 16px;
        border: 1px solid #d8d8d2;
        border-radius: 8px;
        background: #ffffff;
      }
      table {
        width: 100%;
        border-collapse: collapse;
        margin: 16px 0 24px;
        background: #ffffff;
      }
      th,
      td {
        border: 1px solid #d8d8d2;
        padding: 10px 12px;
        text-align: left;
        vertical-align: top;
      }
      th {
        background: #ecece7;
      }
      .note {
        padding: 12px 14px;
        border-left: 4px solid #0f766e;
        background: #eef8f6;
      }
      @media (prefers-color-scheme: dark) {
        body {
          color: #e5e7eb;
          background: #111827;
        }
        h1,
        h2,
        h3 {
          color: #f9fafb;
        }
        a {
          color: #7dd3fc;
        }
        pre,
        table {
          background: #1f2937;
        }
        th {
          background: #374151;
        }
        th,
        td,
        pre,
        h2 {
          border-color: #4b5563;
        }
        .note {
          color: #d1fae5;
          background: #064e3b;
        }
      }
    </style>
  </head>
  <body>
    <main>
      <h1>elizaOS Examples Setup Guide</h1>
      <p>
        Use this page for examples that need accounts, desktop apps, cloud
        CLIs, game servers, API keys, or hardware before the local test clients
        can run end to end.
      </p>

      <div class="note">
        Run local verification from the repository root with
        <code>bun install</code>, then each example's
        <code>bun run typecheck</code>, <code>bun run test</code>, and
        <code>bun run build</code> scripts where present. Live integrations
        should start in dry-run or test projects.
      </div>

      <h2>Minecraft</h2>
      <p>
        Minecraft automation currently lives in
        <code>plugins/plugin-minecraft</code> and uses a local Mineflayer bridge
        server. There is no separate <code>packages/examples/minecraft</code>
        app in this worktree.
      </p>
      <ol>
        <li>
          Install Java and run a local Minecraft Java server, or use a test
          server you control. Mojang's server setup docs:
          <a href="https://www.minecraft.net/en-us/download/server">
            Minecraft Java Server
          </a>.
        </li>
        <li>
          Review Mineflayer setup and supported versions:
          <a href="https://github.com/PrismarineJS/mineflayer">Mineflayer</a>.
        </li>
        <li>
          For offline local testing, configure the server for offline auth and
          use a test username. For production servers, use proper online auth
          and a dedicated account.
        </li>
      </ol>
      <pre><code>cd plugins/plugin-minecraft/mineflayer-server
bun install
export MC_SERVER_PORT=3457
export MC_HOST=127.0.0.1
export MC_PORT=25565
export MC_AUTH=offline
export MC_USERNAME=ElizaBot
bun run build
bun run start</code></pre>

      <h2>Other Human-Gated Examples</h2>
      <table>
        <thead>
          <tr>
            <th>Example</th>
            <th>Setup links</th>
            <th>Local command</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <td>AWS</td>
            <td>
              <a href="https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html">AWS CLI</a>,
              <a href="https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/install-sam-cli.html">AWS SAM CLI</a>
            </td>
            <td><code>cd packages/examples/aws &amp;&amp; bun run test</code></td>
          </tr>
          <tr>
            <td>GCP</td>
            <td>
              <a href="https://docs.cloud.google.com/sdk/docs/install-sdk">Google Cloud CLI</a>,
              <a href="https://docs.cloud.google.com/run/docs/quickstarts/build-and-deploy/deploy-nodejs-service">Cloud Run Node.js</a>
            </td>
            <td><code>cd packages/examples/gcp &amp;&amp; bun run build</code></td>
          </tr>
          <tr>
            <td>Cloudflare</td>
            <td>
              <a href="https://developers.cloudflare.com/workers/wrangler/install-and-update/">Wrangler</a>,
              <a href="https://developers.cloudflare.com/workers/configuration/secrets/">Worker secrets</a>
            </td>
            <td><code>cd packages/examples/cloudflare &amp;&amp; bun run dev</code></td>
          </tr>
          <tr>
            <td>Convex</td>
            <td>
              <a href="https://docs.convex.dev/tutorial">Convex quickstart</a>,
              <a href="https://docs.convex.dev/production/environment-variables/">Convex env vars</a>
            </td>
            <td><code>cd packages/examples/convex &amp;&amp; convex dev</code></td>
          </tr>
          <tr>
            <td>Supabase</td>
            <td>
              <a href="https://supabase.com/docs/guides/local-development/cli/getting-started">Supabase CLI</a>,
              <a href="https://supabase.com/docs/guides/functions/secrets">Edge Function secrets</a>
            </td>
            <td><code>cd packages/examples/supabase &amp;&amp; supabase start</code></td>
          </tr>
          <tr>
            <td>Vercel</td>
            <td>
              <a href="https://vercel.com/docs/cli">Vercel CLI</a>,
              <a href="https://vercel.com/docs/environment-variables">Vercel env vars</a>
            </td>
            <td><code>cd packages/examples/vercel &amp;&amp; bun run dev</code></td>
          </tr>
          <tr>
            <td>Social bots</td>
            <td>
              <a href="https://docs.discord.com/developers/quick-start/getting-started">Discord apps</a>,
              <a href="https://core.telegram.org/bots/tutorial">Telegram bots</a>,
              <a href="https://docs.bsky.app/docs/get-started">Bluesky API</a>,
              <a href="https://docs.neynar.com/">Neynar/Farcaster</a>
            </td>
            <td>Use each package README and dry-run flags first.</td>
          </tr>
          <tr>
            <td>Smartglasses</td>
            <td>
              <a href="https://hub.evenrealities.com/docs/getting-started/installation">Even Hub setup</a>,
              <a href="https://github.com/abandonware/noble">Noble BLE</a>
            </td>
            <td><code>cd packages/examples/smartglasses &amp;&amp; bun run test</code></td>
          </tr>
          <tr>
            <td>Wallet/trading</td>
            <td>
              <a href="https://solana.com/docs/intro/installation">Solana CLI</a>,
              <a href="https://docs.birdeye.so/">Birdeye API</a>,
              <a href="https://docs.li.fi/introduction/introduction">LI.FI</a>
            </td>
            <td>Use paper trading and isolated test wallets first.</td>
          </tr>
        </tbody>
      </table>

      <h2>Model Keys</h2>
      <p>
        Most server examples need one model provider key. Common options are
        <a href="https://developers.openai.com/api/docs/quickstart#create-and-export-an-api-key">OpenAI</a>,
        <a href="https://platform.claude.com/settings/keys">Anthropic</a>,
        <a href="https://aistudio.google.com/app/apikey">Google GenAI</a>,
        <a href="https://console.groq.com/keys">Groq</a>,
        <a href="https://docs.x.ai/developers/quickstart">xAI</a>, and
        <a href="https://openrouter.ai/settings/keys">OpenRouter</a>.
      </p>
    </main>
  </body>
</html>