eternum game docs

.knip.json

@@ -1,11 +1,13 @@
 {
+  "entry": ["eternum-docs/**/*.mdx", "eternum-docs/**/*.tsx"],
   "ignore": [
     ".trunk/**",
     "**/*.js",
     "bot/**",
     "**/vitest**",
-    "eternum-docs/package.json",
+
     "eternum-docs/vocs.config.ts",
+
     "sdk/packages/eternum/global.d.ts",
     "config/bank/index.ts",
     "**/**__test__**/**",

eternum-docs/components/ResourceIcon.tsx

@@ -0,0 +1,19 @@
+import React from "react";
+type Props = {
+  name: string;
+  id: string | number;
+  size?: number;
+};
+
+export default function ResourceIcon({ name, id, size = 50 }: Props) {
+  return (
+    <img
+      src={`/resources/${id}.png`}
+      alt={name}
+      title={name}
+      width={size}
+      height={size}
+      style={{ verticalAlign: "middle" }}
+    />
+  );
+}

eternum-docs/docs/pages/index.mdx

@@ -10,7 +10,7 @@ import { HomePage } from "vocs/components";
     Eternum is a decentralized, open-source, and community-driven MMORPG game built on the Dojo framework.
   </HomePage.Description>
   <HomePage.Buttons>
-    <HomePage.Button href="/game" variant="accent">
+    <HomePage.Button href="/overview/overview" variant="accent">
       Get started
     </HomePage.Button>
     <HomePage.Button href="https://github.com/BibliothecaDAO/eternum">GitHub</HomePage.Button>

eternum-docs/docs/pages/mechanics/hyperstructures.mdx

@@ -0,0 +1,56 @@
+---
+title: Hyperstructures & Points
+description: Hyperstructure mechanics and leaderboard system in Eternum
+---
+
+# Hyperstructures
+
+## Construction Process
+
+> 🏗️ **Initialization**
+>
+> - Requires Ancient Fragments to start construction
+> - Can be placed anywhere on the map
+> - Two contribution modes:
+>   - Public: Anyone can contribute
+>   - Tribe-only: Limited to owner's tribe members
+
+### Building Requirements
+
+> 📦 **Resource Contributions**
+>
+> - Requires all 22 resource types
+> - Multiple players can contribute
+> - Construction complete when all requirements met
+
+## Points System
+
+### Construction Points
+
+> 🎯 **One-time Rewards**
+>
+> - Contributors earn points upon completion
+> - Points based on:
+>   - Amount of resources contributed
+>   - Rarity of contributed resources
+> - Awarded once construction is complete
+
+### Generation Points
+
+> ⚡ **Ongoing Points**
+>
+> - Begins after construction is complete
+> - Generates points every Eternum cycle
+> - Points distributed via share system
+> - Owner controls share distribution
+> - Share changes restricted to 48-hour cooldown
+
+## Strategic Considerations
+
+> 💡 **Management**
+>
+> - Plan resource gathering before initialization
+> - Consider tribe-only mode for security
+> - Defend completed structures to maintain control
+> - New owner gains share control upon capture
+> - Previous share settings reset on capture

eternum-docs/docs/pages/mechanics/military/combat.mdx

@@ -0,0 +1,42 @@
+---
+title: Combat
+description: Military and combat mechanics in Eternum
+---
+
+## Combat System
+
+### Unit Advantages
+
+> ⚔️ **Combat Matchups**
+>
+> ```
+> Paladins    →  Crossbowmen
+> Crossbowmen →  Knights
+> Knights     →  Paladins
+> ```
+>
+> Units deal more damage to their strong matchup and less damage to their weak matchup.
+
+### Battle Duration
+
+- Combat duration is dynamically calculated based on army sizes
+- Larger armies result in longer battles
+- Highly uneven matchups may resolve more quickly
+
+### Battle Dynamics
+
+- Additional armies can join either side during ongoing combat
+- Combat continues until one side is defeated or retreats
+
+### Siege Mechanics
+
+> 🏰 **Siege System**
+>
+> - Attacking a realm initiates a siege phase before combat
+> - During siege phase:
+>   - Defenders can prepare defenses
+>   - Resources can be transferred in/out of the realm
+>   - Defenders can "break" the siege by initiating combat early
+> - Once combat begins:
+>   - Resource transfers are blocked
+>   - The realm is considered under active attack

eternum-docs/docs/pages/mechanics/military/units.mdx

@@ -0,0 +1,51 @@
+---
+title: Units
+description: Military and combat mechanics in Eternum
+---
+
+### Units
+
+> 🎯 **Unit Types**
+>
+> - **Paladins**
+>   - Larger energy pool for extended movement
+>   - Same energy regeneration rate as other units
+>   - Can cover more distance in a single move
+> - **Crossbowmen**
+>   - Reduced food consumption (50% less)
+>   - More efficient for exploration and movement
+> - **Knights**
+>   - Standard unit with baseline stats
+
+### Army Energy System
+
+> ⚡ **Energy Mechanics**
+>
+> - Army's maximum energy is determined by its composition
+> - The unit with the lowest energy pool sets the army's limit
+> - Energy regenerates at a fixed rate for all unit types every Eternum cycle
+> - Energy is consumed when moving across tiles
+
+## Army Movement
+
+### Energy Consumption
+
+> 🏃 **Movement Mechanics**
+>
+> - Moving armies requires energy
+> - Each tile crossed consumes energy
+> - Food is consumed during movement
+
+### Unit-Specific Movement
+
+> 💨 **Movement Traits**
+>
+> - **Paladins**
+>   - Larger energy pool for extended movement
+>   - Takes longer to fully recharge energy
+> - **Crossbowmen**
+>   - Uses 50% less food while moving
+>   - Ideal for long-distance exploration
+> - **Knights**
+>   - Standard movement costs
+>   - Standard food consumption

eternum-docs/docs/pages/mechanics/realm/buildings.mdx

@@ -0,0 +1,96 @@
+---
+title: Buildings
+description: Building mechanics and costs in Eternum
+---
+
+# Buildings
+
+Buildings are essential structures in your realm that provide various benefits. Each construction increases the cost of
+subsequent buildings of the same type exponentially.
+
+## Building Types
+
+### Basic Infrastructure
+
+> 🏘️ **Worker's Hut**
+>
+> - Basic population housing
+> - Provides population capacity
+
+> 🏪 **Storehouse**
+>
+> - Increases resource storage capacity
+> - Essential for resource management
+> - Prevents production waste
+> - Consider building more when storage is frequently full
+
+### Production Buildings
+
+> 🌾 **Farm**
+>
+> - Produces Wheat for population and armies
+> - Provides 10% production bonus to adjacent buildings
+> - Strategic placement is key for optimization
+
+> **Fishing Village**
+>
+> - Produces Fish for population and armies
+
+> 💰 **Market**
+>
+> - Produces Donkeys
+> - Essential to keep a constant trading flow
+> - Essential for economic growth
+
+> **Resource Facility**
+>
+> - Produces specified resource
+> - Consumes some of your other realms' resources
+
+### Military Buildings
+
+> **Available military buildings and their units:**
+>
+> - **Barracks:** Knights
+> - **Stables:** Paladins
+> - **Archery Range:** Crossbowmen
+> - Each military building also increases your max army count by 1 (up to 3, for a total of 6)
+
+#### Army Size Bonus
+
+> Each military building increases your maximum army count by 1, up to a maximum of 3 buildings (for a total bonus of +3
+> to army size).
+
+### Production Management
+
+> ⚙️ **Production Controls**
+>
+> - Buildings can be paused/resumed
+> - Pausing stops:
+>   - Resource consumption
+>   - Resource production
+> - Use pausing to:
+>   - Prevent resource waste
+>   - Manage storage capacity
+
+### Building Costs
+
+> 💰 **Cost Scaling**
+>
+> - Each building has a base resource cost
+> - Subsequent buildings of same type cost more
+> - Cost increase is exponential
+> - Example progression:
+>   - First Worker's Hut: 100 wood
+>   - Second Worker's Hut: 200 wood
+>   - Third Worker's Hut: 400 wood
+>   - And so on...
+
+### Construction Management
+
+> 🏗️ **Building Tips**
+>
+> - Prioritize buildings based on your realm's needs
+> - Consider population increase and capacity
+> - Monitor resource production and storage capacity
+> - See Production Management section for resource conservation strategies

eternum-docs/docs/pages/mechanics/realm/realm.mdx

@@ -0,0 +1,46 @@
+---
+title: Realms
+description: Your base of operations in Eternum
+---
+
+# Realms
+
+Realms are NFTs that determine your capabilities in Eternum. Originally created as "Realms (For Adventurers)", they were
+the first Loot derivative, comprising 8,000 generative maps with unique metadata of resources and traits.
+
+## Realm Access
+
+- Each Realm NFT grants entry into Eternum seasons
+- Owners become Lords of their onchain kingdoms
+- Access to specific resources from the 22 available types
+- Foundation for building and expanding your influence in the game
+
+## Realm Levels
+
+### Settlement
+
+> A small settlement with 6 buildable hexes.
+
+### City
+
+> A glorious city with 18 buildable hexes.
+
+### Kingdom
+
+> A kingdom with 36 buildable hexes.
+
+### Empire
+
+> A vast empire with 60 buildable hexes.
+
+## Starting Values
+
+> 🏰 **Base Castle Stats**
+>
+> - **Population**: 5 workers
+> - **Military Capacity**:
+>   - 3 attacking armies
+>   - 1 defending army
+> - **Resource Storage**: 300,000 kg
+>
+> _These are the default values for a new realm before any buildings are constructed._

eternum-docs/docs/pages/mechanics/resources/production.mdx

@@ -0,0 +1,14 @@
+## Production
+
+- Every resource, with the exception of food, requires other resources to be produced.
+
+  > Ex: to produce Wood, you need Stone, Coal and Wheat.
+
+- Production will work automatically until paused or resources are depleted
+  > ⚠️ **Warning**  
+  > If some of the input resources required aren't available:
+  >
+  > - Available resources will still be consumed
+  > - No output will be produced
+  >
+  > To prevent resource waste, manually pause buildings when resources are low.