Eternum

https://eternum-docs.realms.world
Admin
Eternum is a decentralized, open-source, and community-driven gaming ecosystem built on the Dojo...
Tokens:34,644
Snippets:405
Trust Score:7.6
Update:8 months ago
Show doc for...
Tokens:
Raw
### Example Calculation for Hyperstructure Foundation Discovery Chance

Source: https://eternum-docs.realms.world/eternum/world-structures

An example demonstrating the application of the Hyperstructure Foundation discovery chance formula. It shows the step-by-step calculation for a specific scenario, illustrating how distance from the center and previously found foundations affect the discovery probability.

```plaintext
Discovery Chance = (0.975^100 × 4) - (5 × 0.001)
                 = (0.079 × 4) - 0.005
                 = 0.316 - 0.005
                 = 0.311 or 31.1%
```

--------------------------------

### Compile Eternum SDK Packages

Source: https://eternum-docs.realms.world/development/sdk

This command installs project dependencies and builds the SDK packages. It is executed from the root of the project using pnpm.

```shell
pnpm i && pnpm run build:packages
```

--------------------------------

### Run React Client Dev Server

Source: https://eternum-docs.realms.world/development/client

Provides two methods to run the development server for the React client. The easy method uses a script, while the manual method involves installing dependencies and starting the dev server. The client requires environment variables to be configured.

```bash
./scripts/client.sh
```

```bash
pnpm i && pnpm dev
```

--------------------------------

### Query World State with Recs

Source: https://eternum-docs.realms.world/development/client

Illustrates how to query the local state of the game world using Recs. This example shows how to find all structures at a specific position. Queries run against the local state, which is synced with the latest updates, avoiding direct calls to Torii.

```typescript
const structureAtPosition = runQuery([HasValue(Position, { x, y }), Has(Structure)]);
```

--------------------------------

### Subscribe to World State Changes with useEntityQuery

Source: https://eternum-docs.realms.world/development/client

Shows how to subscribe to changes in the game world using the `useEntityQuery` hook. This hook returns entities matching a query and updates them when their state changes. The example fetches all entities with the `Realm` component.

```typescript
const allRealms = useEntityQuery([Has(Realm)]);
```

--------------------------------

### Use useDojo Hook for Game Functionality

Source: https://eternum-docs.realms.world/development/client

Demonstrates the usage of the `useDojo` hook, a core part of the Dojo framework. It provides access to account management, network interactions, and game setup. The hook must be used within a `DojoProvider` and requires specific environment variables.

```typescript
import { useDojo } from "@/hooks/context/dojo-context";

function GameComponent() {
  const { account, network, masterAccount } = useDojo();
  // ... your game logic
}
```

```typescript
import { useDojo } from "@/hooks/context/dojo-context";

function GameUI() {
  const { account } = useDojo();
  return (
    <div>
      <p>Current Account: {account.account.address}</p>
    </div>
  );
}
```

--------------------------------

### Define Starknet Event Model: ExampleEvent

Source: https://eternum-docs.realms.world/development/contracts

Defines an event model 'ExampleEvent' for data that needs to be accessible by the client but not necessarily stored onchain. It includes keys 'id' and 'event_id', and a data field 'my_data_field'. Event models use #[dojo::event] and #[dojo::model] macros.

```rust
#[derive(Introspect, Copy, Drop, Serde)]
#[dojo::event]
#[dojo::model]
pub struct ExampleEvent {
    #[key]
    id: ID,
    #[key]
    event_id: EventType,
    my_data_field: u8
}
```
Tokens:
Raw