project guidelines

Guide for project guidelines

Project Guidelines

1. Asset Generation Rules

IMPORTANT
White Background Rule: All generated icons MUST have a solid WHITE background (not transparent). This is critical for our automated asset processing scripts which handle transparency. Do not generate images with transparent backgrounds directly.

2. Architecture & Observability

Shared Constants

  • Use constants.rs for all shared UI styling tokens, colors, and layout dimensions.
  • Avoid hardcoding values in individual systems.

Observability

  • Telemetry: The game uses Prometheus, Sentry, and tracing-subscriber for observability.
  • Metrics: Ensure critical systems emit metrics (e.g., frame times, combat events).

UI Architecture

  • State-Driven Visibility: HUD elements (Milestone Tracker, Minimap) must only render when GameState is Playing or Tutorial. They must be hidden in MainMenu.
  • Layout: The UI follows a strict 6-column tab layout on the right panel.
    • Top Row: Combat, Skills, Equipment, Inventory, Prayer, Magic.
    • Bottom Row: Quests, Settings, Radio, Achievements, Friends, Notes.
  • Orb Constraints: Health, Prayer, and Energy orbs are constrained to circular areas.

3. UI Design Standards

  • Theme: Dark mode with Gold accents.
  • Palette: Modern Blue-Gray background for panels.
  • Icons:
    • 512x512 resolution.
    • Indian Mythology / Ancient aesthetic.
    • Distinctive silhouettes.
  • Compactness: The Skills tab and other lists should use compact grids (e.g., 2-column) with tight spacing to maximize screen real estate.

4. Game Data & Lore

Narrative Setting

  • Name: Legends of Hastinapur.
  • Theme: Ancient India / Mythology.
  • Location: Hastinapur (Capital City) - Spanning from Iran in the east to Vietnam in the west, and Central Asia to Sri Lanka. Covers the entire story from King Shantanu to the Mahabharata's epilogue.
  • Role: A warrior recruit in the Royal Guard, guided by the Guard Captain (unnamed).

Progression

  • Levels 1-40 (Tutorial/Early Game):
    • Equipment is provided by the Guard Captain at milestones.
    • Gear Tier: Bronze -> Iron -> Steel -> Swarna.
  • Level 40+ (End Game):
    • Players must be self-reliant (Smithing, Trading, Questing).
    • Champions' Guild becomes available.
    • Vajra tier equipment (Elite) unlocks.

Tapasya (Prayer) & Magic (Mantras)

  • Concept: Magic uses "Mantras" powered by "Bijas". Prayer (Tapasya) is the accumulation of spiritual power.
  • Tapasya (Prayer):
    • Thirtha: A holy place (sthala) related to a deity (temple, crematorium, battlefield, etc.). Not just a water body.
    • Gaining XP:
      • Active: Mine Sphatikas and worship at specific Thirthas.
      • Cremation: Cremating Asuras yields Tapasya XP.
    • Rewards:
      • Boons: Rare buffs from deities.
      • Veda Vidya Scrolls: Dropped or found, these unlock new prayers/mantras.
  • Magic (Mantras):
    • Bijas: Seed syllables (Elemental or Deity-based) used to cast spells.
    • Spells: Pulse -> Volley -> Cascade -> Cataclysm tiers.
    • Teleportation: Uses "Charged Coconuts" infused with Bijas.

Ayurveda (Herbalism)

  • Concept: Creating "Ayurvedic Brews" and potions using a Primary Herb and Secondary Ingredient.
  • Structure: Primary Herb + Secondary Ingredient -> Brew.
  • Ingredients:
    • Primary: Tulsi Leaf, Ashwagandha, Saffron, Sandalwood.
    • Secondary: Demon Ash, Dragon Blood, Turtle Shell, Holy Water, Milk, Ghee.
  • Potions:
    • Combat: Attack, Strength, Defense (Standard -> Super -> Divine).
    • Utility: Stamina Potion, Agility Boost, Prayer Renewal.

Skills & Resources

  • Mining:
    • Tiers: Copper/Tin (1) -> Iron (15) -> Coal (30) -> Gold/Swarna (50).
    • Note: Adamant and Rune are NOT present. Top tier is Swarna/Vajra.
  • Smithing:
    • Smelt ores into bars at Furnaces.
    • Smith bars into equipment at Anvils.
    • Tiers: Bronze -> Iron -> Steel -> Swarna.
  • Woodcutting:
    • Trees: Banyan, Peepal, Ashoka, Sandalwood.
  • Firemaking:
    • Lighting logs for cooking or religious ceremonies (Yajna).
  • Fishing:
    • River and Ocean fishing (Ganga, Yamuna).
  • Cooking:
    • Cooking fish and baking primitive breads/offerings.
  • Farming:
    • Growing herbs (Tulsi) and vegetables at allotments.
  • Slayer:
    • Killing specific mythical beasts assigned by Masters.
  • Thieving:
    • Stealing from market stalls or pickpocketing citizens/Asuras.
  • Agility:
    • Navigating obstacle courses (rooftops, jungles) to restore run energy faster.
  • Fletching:
    • Creating bows and arrows from logs and feathers.
  • Crafting:
    • Working with leather, gems (Navaratna), and pottery.