8 8888 ,88' .8. ,8. ,8. 8 8888 ,o888888o. ,o888888o. 8888888 8888888888 ,o888888o. 8 8888 8 8 8888
8 8888 ,88' .888. ,888. ,888. 8 8888 8888 `88. . 8888 `88. 8 8888 8888 `88. 8 8888 8 8 8888
8 8888 ,88' :88888. .`8888. .`8888. 8 8888 ,8 8888 `8. ,8 8888 `8b 8 8888 ,8 8888 `8. 8 8888 8 8 8888
8 8888 ,88' . `88888. ,8.`8888. ,8.`8888. 8 8888 88 8888 88 8888 `8b 8 8888 88 8888 8 8888 8 8 8888
8 8888 ,88' .8. `88888. ,8'8.`8888,8^8.`8888. 8 8888 88 8888 88 8888 88 8 8888 88 8888 8 8888 8 8 8888
8 8888 88' .8`8. `88888. ,8' `8.`8888' `8.`8888. 8 8888 88 8888 88 8888 88 8 8888 88 8888 8 8888 8 8 8888
8 888888< .8' `8. `88888. ,8' `8.`88' `8.`8888. 8 8888 88 8888 8888888 88 8888 ,8P 8 8888 88 8888 8 8888888888888 8 8888
8 8888 `Y8. .8' `8. `88888. ,8' `8.`' `8.`8888. 8 8888 `8 8888 .8' `8 8888 ,8P 8 8888 `8 8888 .8' 8 8888 8 8 8888
8 8888 `Y8. .888888888. `88888. ,8' `8 `8.`8888. 8 8888 8888 ,88' ` 8888 ,88' 8 8888 8888 ,88' 8 8888 8 8 8888
8 8888 `Y8. .8' `8. `88888. ,8' ` `8.`8888. 8 8888 `8888888P' `8888888P' 8 8888 `8888888P' 8 8888 8 8 8888
8 8888 ,88' .8. ,8. ,8. 8 8888 ,o888888o. ,o888888o. 8888888 8888888888 ,o888888o. 8 8888 8 8 8888
8 8888 ,88' .888. ,888. ,888. 8 8888 8888 `88. . 8888 `88. 8 8888 8888 `88. 8 8888 8 8 8888
8 8888 ,88' :88888. .`8888. .`8888. 8 8888 ,8 8888 `8. ,8 8888 `8b 8 8888 ,8 8888 `8. 8 8888 8 8 8888
8 8888 ,88' . `88888. ,8.`8888. ,8.`8888. 8 8888 88 8888 88 8888 `8b 8 8888 88 8888 8 8888 8 8 8888
8 8888 ,88' .8. `88888. ,8'8.`8888,8^8.`8888. 8 8888 88 8888 88 8888 88 8 8888 88 8888 8 8888 8 8 8888
8 8888 88' .8`8. `88888. ,8' `8.`8888' `8.`8888. 8 8888 88 8888 88 8888 88 8 8888 88 8888 8 8888 8 8 8888
8 888888< .8' `8. `88888. ,8' `8.`88' `8.`8888. 8 8888 88 8888 8888888 88 8888 ,8P 8 8888 88 8888 8 8888888888888 8 8888
8 8888 `Y8. .8' `8. `88888. ,8' `8.`' `8.`8888. 8 8888 `8 8888 .8' `8 8888 ,8P 8 8888 `8 8888 .8' 8 8888 8 8 8888
8 8888 `Y8. .888888888. `88888. ,8' `8 `8.`8888. 8 8888 8888 ,88' ` 8888 ,88' 8 8888 8888 ,88' 8 8888 8 8 8888
8 8888 `Y8. .8' `8. `88888. ,8' ` `8.`8888. 8 8888 `8888888P' `8888888P' 8 8888 `8888888P' 8 8888 8 8 8888
built with love, powered by [redacted]
Note: If you run the client remotely you will have to configure your own privy instance, and it will not support connecting to the Kamigotchi production servers. We have included this vercel option for those looking to build their own projects.
Build from the project root using
pnpm iMake sure you specify that the build outputs in the current folder, '.'
baby steps
first we clone the repo
# with github cli
gh repo clone Asphodel-OS/kamigotchi
# rawdogging ssh with git
git clone git@github.com:Asphodel-OS/kamigotchi.gitthen we install dependencies using pnpm
kamigotchi/$ pnpm iyou can spin up a local game client with the following command
which will run a vite development server on localhost:3000 in production mode
kamigotchi/packages/client/$ pnpm start:devyou'll also want a client/.env.production file populated like so
# Network
VITE_CHAIN_ID=428962654539583
# Infra
VITE_KAMIGAZE_URL='https://api.prod.kamigotchi.io'
# World
VITE_WORLD_ADDRESS='0x2729174c265dbBd8416C6449E0E813E88f43D0E7'
VITE_INITIAL_BLOCK_NUMBER=44577and also a client/.env for fields shared across environments
# PRIVY
VITE_PRIVY_APP_ID='cltxr4rvw082u129anv6cq7wr'
VITE_PRIVY_CLIENT_ID='client-WY2ijNSw1URbqeLQm1SPC4cRkHr3pLpcYWjQxaEvrs3wc'
VITE_PRIVY_APP_LOGO='https://i.imgur.com/lYdPt9I.png'
# RPCs
VITE_RPC_TRANSPORT_URL='https://jsonrpc-yominet-1.anvil.asia-southeast.initia.xyz'
VITE_RPC_WS_URL='wss://jsonrpc-ws-yominet-1.anvil.asia-southeast.initia.xyz' first you'll need to have cargo and foundry installed
you'll also want the following environment files
# packages/contracts/.env.puter
RPC="http://127.0.0.1:8545"
WORLD="0xa85233C63b9Ee964Add6F2cffe00Fd84eb32338f"
PRIV_KEY="0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"# packages/client/.env.puter
VITE_CHAIN_ID=1337
VITE_RPC_TRANSPORT_URL='localhost:8545'
VITE_WORLD_ADDRESS='0x379FA7857b8722d2719f16f78753995BafEb4B9b'
PRIV_KEY="0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"once you have everything, run the following script in a dedicated terminal window
kamigotchi/packages/contracts/$ pnpm startyou should see something like the below
followed by ~1200 transactions (this is normal)
do you see it ?
- a local EVM Node generated in the
contracts/window - MUD
ComponentsandSystemsautomagically deployed - lots of transactions (data deployments)
- a spawned browser tab with the newly generated url parameters
the void greets you
wonderful, now that we've rooted your computer
we can continue to setup
the game should now run so long as you
- have a supported wallet manager installed (e.g. metamask, rabby)
- have exactly one wallet manager active
you may need to use or transfer ETH from one of the pre-loaded wallets
[node:local ] Private Keys
[node:local ] ==================
[node:local ]
[node:local ] (0) 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
[node:local ] (1) 0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d
[node:local ] (2) 0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a
[node:local ] (3) 0x7c852118294e51e653712a81e05800f419141751be58f605c371e15141b007a6
[node:local ] (4) 0x47e179ec197488593b187f80a00eb0da91f1b9d0b13f8733639f19c30a34926a
[node:local ] (5) 0x8b3a350cf5c34c9194ca85829a2df0ec3153be0318b5e2d3348e872092edffba
[node:local ] (6) 0x92db14e403b83dfe3df233f83dfa3a0d7096f21ca9b0d6d6b8d88b2b4ec1564e
[node:local ] (7) 0x4bbbf85ce3377467afe5d46f804f221813b2bb87f24d81f60f1fcdbf7cbf4356
[node:local ] (8) 0xdbda1821b80551c9d65939329250298aa3472ba22feea921c0cf5d620ea67b97
[node:local ] (9) 0x2a871d0798f97d79848a013d4936a73bf4cc922c825d33c1cf7073dff6d409c6
now, for the fun part: choose a name for your account
listen to the voices
they're right you know
the intrusive thoughts should win
- local [
.env.puter] - testing [
.env.testing] - production [
.env.production]
8 8888 ,88' .8. ,8. ,8. 8 8888 ,o888888o. ,o888888o. 8888888 8888888888 ,o888888o. 8 8888 8 8 8888
8 8888 ,88' .888. ,888. ,888. 8 8888 8888 `88. . 8888 `88. 8 8888 8888 `88. 8 8888 8 8 8888
8 8888 ,88' :88888. .`8888. .`8888. 8 8888 ,8 8888 `8. ,8 8888 `8b 8 8888 ,8 8888 `8. 8 8888 8 8 8888
8 8888 ,88' . `88888. ,8.`8888. ,8.`8888. 8 8888 88 8888 88 8888 `8b 8 8888 88 8888 8 8888 8 8 8888
8 8888 ,88' .8. `88888. ,8'8.`8888,8^8.`8888. 8 8888 88 8888 88 8888 88 8 8888 88 8888 8 8888 8 8 8888
8 8888 88' .8`8. `88888. ,8' `8.`8888' `8.`8888. 8 8888 88 8888 88 8888 88 8 8888 88 8888 8 8888 8 8 8888
8 888888< .8' `8. `88888. ,8' `8.`88' `8.`8888. 8 8888 88 8888 8888888 88 8888 ,8P 8 8888 88 8888 8 8888888888888 8 8888
8 8888 `Y8. .8' `8. `88888. ,8' `8.`' `8.`8888. 8 8888 `8 8888 .8' `8 8888 ,8P 8 8888 `8 8888 .8' 8 8888 8 8 8888
8 8888 `Y8. .888888888. `88888. ,8' `8 `8.`8888. 8 8888 8888 ,88' ` 8888 ,88' 8 8888 8888 ,88' 8 8888 8 8 8888
8 8888 `Y8. .8' `8. `88888. ,8' ` `8.`8888. 8 8888 `8888888P' `8888888P' 8 8888 `8888888P' 8 8888 8 8 8888
8 8888 ,88' .8. ,8. ,8. 8 8888 ,o888888o. ,o888888o. 8888888 8888888888 ,o888888o. 8 8888 8 8 8888
8 8888 ,88' .888. ,888. ,888. 8 8888 8888 `88. . 8888 `88. 8 8888 8888 `88. 8 8888 8 8 8888
8 8888 ,88' :88888. .`8888. .`8888. 8 8888 ,8 8888 `8. ,8 8888 `8b 8 8888 ,8 8888 `8. 8 8888 8 8 8888
8 8888 ,88' . `88888. ,8.`8888. ,8.`8888. 8 8888 88 8888 88 8888 `8b 8 8888 88 8888 8 8888 8 8 8888
8 8888 ,88' .8. `88888. ,8'8.`8888,8^8.`8888. 8 8888 88 8888 88 8888 88 8 8888 88 8888 8 8888 8 8 8888
8 8888 88' .8`8. `88888. ,8' `8.`8888' `8.`8888. 8 8888 88 8888 88 8888 88 8 8888 88 8888 8 8888 8 8 8888
8 888888< .8' `8. `88888. ,8' `8.`88' `8.`8888. 8 8888 88 8888 8888888 88 8888 ,8P 8 8888 88 8888 8 8888888888888 8 8888
8 8888 `Y8. .8' `8. `88888. ,8' `8.`' `8.`8888. 8 8888 `8 8888 .8' `8 8888 ,8P 8 8888 `8 8888 .8' 8 8888 8 8 8888
8 8888 `Y8. .888888888. `88888. ,8' `8 `8.`8888. 8 8888 8888 ,88' ` 8888 ,88' 8 8888 8888 ,88' 8 8888 8 8 8888
8 8888 `Y8. .8' `8. `88888. ,8' ` `8.`8888. 8 8888 `8888888P' `8888888P' 8 8888 `8888888P' 8 8888 8 8 8888
8 8888 ,88' .8. ,8. ,8. 8 8888 ,o888888o. ,o888888o. 8888888 8888888888 ,o888888o. 8 8888 8 8 8888
8 8888 ,88' .888. ,888. ,888. 8 8888 8888 `88. . 8888 `88. 8 8888 8888 `88. 8 8888 8 8 8888
8 8888 ,88' :88888. .`8888. .`8888. 8 8888 ,8 8888 `8. ,8 8888 `8b 8 8888 ,8 8888 `8. 8 8888 8 8 8888
8 8888 ,88' . `88888. ,8.`8888. ,8.`8888. 8 8888 88 8888 88 8888 `8b 8 8888 88 8888 8 8888 8 8 8888
8 8888 ,88' .8. `88888. ,8'8.`8888,8^8.`8888. 8 8888 88 8888 88 8888 88 8 8888 88 8888 8 8888 8 8 8888
8 8888 88' .8`8. `88888. ,8' `8.`8888' `8.`8888. 8 8888 88 8888 88 8888 88 8 8888 88 8888 8 8888 8 8 8888
8 888888< .8' `8. `88888. ,8' `8.`88' `8.`8888. 8 8888 88 8888 8888888 88 8888 ,8P 8 8888 88 8888 8 8888888888888 8 8888
8 8888 `Y8. .8' `8. `88888. ,8' `8.`' `8.`8888. 8 8888 `8 8888 .8' `8 8888 ,8P 8 8888 `8 8888 .8' 8 8888 8 8 8888
8 8888 `Y8. .888888888. `88888. ,8' `8 `8.`8888. 8 8888 8888 ,88' ` 8888 ,88' 8 8888 8888 ,88' 8 8888 8 8 8888
8 8888 `Y8. .8' `8. `88888. ,8' ` `8.`8888. 8 8888 `8888888P' `8888888P' 8 8888 `8888888P' 8 8888 8 8 8888
8 8888 ,88' .8. ,8. ,8. 8 8888 ,o888888o. ,o888888o. 8888888 8888888888 ,o888888o. 8 8888 8 8 8888
8 8888 ,88' .888. ,888. ,888. 8 8888 8888 `88. . 8888 `88. 8 8888 8888 `88. 8 8888 8 8 8888
8 8888 ,88' :88888. .`8888. .`8888. 8 8888 ,8 8888 `8. ,8 8888 `8b 8 8888 ,8 8888 `8. 8 8888 8 8 8888
8 8888 ,88' . `88888. ,8.`8888. ,8.`8888. 8 8888 88 8888 88 8888 `8b 8 8888 88 8888 8 8888 8 8 8888
8 8888 ,88' .8. `88888. ,8'8.`8888,8^8.`8888. 8 8888 88 8888 88 8888 88 8 8888 88 8888 8 8888 8 8 8888
8 8888 88' .8`8. `88888. ,8' `8.`8888' `8.`8888. 8 8888 88 8888 88 8888 88 8 8888 88 8888 8 8888 8 8 8888
8 888888< .8' `8. `88888. ,8' `8.`88' `8.`8888. 8 8888 88 8888 8888888 88 8888 ,8P 8 8888 88 8888 8 8888888888888 8 8888
8 8888 `Y8. .8' `8. `88888. ,8' `8.`' `8.`8888. 8 8888 `8 8888 .8' `8 8888 ,8P 8 8888 `8 8888 .8' 8 8888 8 8 8888
8 8888 `Y8. .888888888. `88888. ,8' `8 `8.`8888. 8 8888 8888 ,88' ` 8888 ,88' 8 8888 8888 ,88' 8 8888 8 8 8888
8 8888 `Y8. .8' `8. `88888. ,8' ` `8.`8888. 8 8888 `8888888P' `8888888P' 8 8888 `8888888P' 8 8888 8 8 8888
may they spare your soul