• 

🌟 Overview

Welcome to ByteBeasts Tamagotchi Game! 🎮 This interactive web-based game brings to life the magical creatures of Etheria known as ByteBeast. 🐾 Players act as guardians responsible for nurturing and caring for their Beasts, building a unique bond, and ensuring their companion grows strong and healthy. 💖

💻 Client Setup (with HTTPS)

To run the frontend locally over HTTPS (required for Controller), follow these steps:

1️⃣ Install mkcert

Open a terminal and run:

brew install mkcert

mkcert is a simple tool for making locally-trusted development certificates.

---

2️⃣ Generate Local Certificates

Run the following commands in the project root (or in the client folder):

mkcert -install
mkcert localhost

This will generate the files:

• localhost.pem (certificate)
• localhost-key.pem (private key)

---

3️⃣ Update Vite Configuration

In your vite.config.ts, add the following server configuration:

import fs from 'fs';

export default defineConfig({
  server: {
    https: {
      key: fs.readFileSync('localhost-key.pem'),
      cert: fs.readFileSync('localhost.pem'),
    },
  },
});

---

4️⃣ Run the Development Server

Make sure you're inside the client directory, then install dependencies and run the app:

cd client
pnpm install
pnpm run dev

Ensure the HTTPS certificates (localhost.pem and localhost-key.pem) are present in the root of the client project.

---

🧱 Client Dependencies

• Node.js (make sure it’s installed)
• pnpm (recommended for managing dependencies)

---

⛩️ Dojo

✅ Prerequisites

Ensure the following dependencies are installed:

• Dojo: v1.2.1
• Scarb: v2.9.2

---

🔨 Building Contracts

To compile the smart contracts:

sozo build

---

🧪 Running Tests

To execute the test suite:

sozo test

---

📦 Deployment

Instructions for local and testnet deployment are provided below.

---

🖥️ Running Locally

1️⃣ Start Katana (Terminal 1)

Launch a local Starknet node:

katana --disable-fee --allowed-origins "*"

---

2️⃣ Build, Migrate, and Start Torii (Terminal 2)

# Build the contracts
sozo build

# Deploy the world locally
sozo migrate

# Start the Torii indexer
torii --world <WORLD_ADDRESS> --allowed-origins "*"

Replace <WORLD_ADDRESS> with the address returned by sozo migrate.

---

🌍 Deploying to Sepolia

1️⃣ Set Up Environment

cp .env.example .env.sepolia

Edit .env.sepolia and provide the following:

• STARKNET_RPC_URL → https://api.cartridge.gg/x/starknet/sepolia
• DOJO_ACCOUNT_ADDRESS → Your deployment account address
• DOJO_PRIVATE_KEY → Your deployment private key

⚠️ Ensure this account is funded before proceeding.

---

2️⃣ Load Environment Variables

source .env.sepolia

---

3️⃣ Deploy to Sepolia

scarb run sepolia

After deployment, the CLI will output your world address, which is required to interact with the deployed game.

3️⃣ Simple integration steps

1. At this point you should have a new manufest for sepolia here dojo/manifest_sepolia.json copy the whole file to the front end manifest client/src/dojo/manifest_dev.json
2. There are the new contract address for the actiond and the world address, copy the world address and make sure It's the same in thie file dojo/torii-config.toml
3. Copy the contract address for the game contract and the player contract and paste It in the client/src/config/cartridgeConnector.tsx file in the variables CONTRACT_ADDRESS_TAMAGOTCHI_SYSTEM and CONTRACT_ADDRESS_PLAYER_SYSTEM + go to this file client/src/utils/tamagotchi.tsx and update the address for fetch age and status with the game contract adrress
4. Now, let's create a new Torii for the new world address, please make sure you have latest slotup version, make sure you are in the dojo folder in your terminal, and execute this command

slot auth login

slot d create [name of the torii] torii --config ./torii-config.toml --version v1.5.1

or try

slot deployments create DEPLOYMENT_NAME torii --world YOUR_WORLD_ADDRESS --rpc YOUR_NEW_RPC_URL

5. Use that new torii name to replace It in these files client/src/dojo/dojoConfig.ts (line 17) + client/src/config/cartridgeConnector.tsx (line 102)
6. Last step, update your env file with the new Torii address
7. Run de app

Here is an example of a clean integration of the new sepolia contracts https://github.com/ByteBuildersLabs/Tamagotchi/commit/2742f7e79c5aa0191519e5a1d7b163953569cd28

Founders

Rolando

Luis

Marco

Daniel