/loot-survivor

Loot Survivor - onchain arcade

Primary LanguageCairoMIT LicenseMIT

discord License: MIT

background

🪦 Loot Survivor

Go and die with glory

Play Loot Survivor

Table of contents


🕹️ Game Design

Loot Survivor is an onchain Arcade machine game. You add some tokens, try to get the highscore and live for eternity onchain.

Each play through will be different and there is no end to the game. Every level just gets progressively harder.

Game Statistics Each level up grants adventurers 1+ upgrade to help them survive their explorations. Although Luck cannot be upgraded directly, it can be increased by equipping jewelry items:
  • Strength: Boosts attack damage by 10%.
  • Vitality: Increases health by +20ph and max health.
  • Dexterity: Improves chances of successfully fleeing.
  • Wisdom: Helps evade Beast ambushes.
  • Intelligence: Aids in avoiding Obstacles.
  • Luck: Raises chances of critical damage (cannot be upgraded directly).
Combat Logic

There are three categories of weapons and armor materials:

Weapons: Blade, Bludgeon, Magic

Armor materials: Cloth, Hide, Metal

Weapon vs. Armor Efficacy Chart

Weapon Type Metal Hide Cloth
Blade Weak Fair Strong
Bludgeon Fair Strong Weak
Magic Strong Weak Fair
Weapons and Materials

Weapons

The items are based off the OG loot contract

  • Weapon
  • Head
  • Chest
  • Hands
  • Waist
  • Feet
  • Neck
  • Ring

Weapon Types and Ranks

Weapon Type Item Name Rank
Blade Katana 1
Blade Falchion 2
Blade Scimitar 3
Blade Long Sword 4
Blade Short Sword 5
Bludgeon Warhammer 1
Bludgeon Quarterstaff 2
Bludgeon Maul 3
Bludgeon Mace 4
Bludgeon Club 5
Magic Ghost Wand 1
Magic Grave Wand 2
Magic Bone Wand 3
Magic Wand 4
Magic Grimoire 1
Magic Chronicle 2
Magic Tome 3
Magic Book 4

Encounters

  • Beasts
  • Obstacles

🏗️ Contributing

The game is a work in progress and contributions are greatly appreciated.


⛓️ Technology

Loot Survivor is an onchain game, designed to be immutable and permanently hosted on Starknet. We use advanced gas optimization to reduce costs on Starknet. A player's gamestate exists primarily in a single felt252, every action the player takes only updates a single storage slot.

  • Client: Nextjs
  • Indexer: Apibara
  • Graphql: Strawberry, AIOHTTP
  • Contracts: Cairo 1.0

🖥️ Infrastructure

Servers

Goerli

  • Indexer: Northflank loot-survivor-indexer
  • Mongo DB: Northflank loot-survivor-mongo-goerli
  • Graph QL: Northflank loot-survivor-graphql

Deploying

Set up env

Follow instructions here: https://docs.starknet.io/documentation/getting_started/environment_setup/

source ~/cairo_venv/bin/activate
export STARKNET_NETWORK=alpha-goerli
export STARKNET_WALLET=starkware.starknet.wallets.open_zeppelin.OpenZeppelinAccount
export CAIRO_COMPILER_DIR=~/.cairo/target/release/
export CAIRO_COMPILER_ARGS=--add-pythonic-hints

# you will have an account from the Starknet ENV setup
export ACCOUNT_NAME=INSERT_YOUR_ACCOUNT_NAME_HERE
export ADVENTURER_ID=INSERT_YOUR_ADVENTURER_ID_HERE
export STRENGTH=0
export DEXTERITY=1
export VITALITY=2
export INTELLIGENCE=4
export CHARISMA=5

export LORDS_ADDRESS=0x059dac5df32cbce17b081399e97d90be5fba726f97f00638f838613d088e5a47
export DAO_ADDRESS=0x020b96923a9e60f63a1829d440a03cf680768cadbc8fe737f71380258817d85b

# nav to dir
cd contracts/game

# build
scarb build

# declare
starknet declare --contract target/dev/game_Game.sierra.json --account $ACCOUNT_NAME

# deploy
# <classhash> will be in the output of the previous command
starknet deploy --class_hash 0x2958304935054101c0aeab16cf6507adda1c98b4d977af40d59c2ae75f05767 --max_fee 100000000000000000 --input $LORDS_ADDRESS $DAO_ADDRESS --account $ACCOUNT_NAME
# set contract address
export CONTRACT_ADDRESS=0x06ee32da9f22c736c4ef049719c0021380c302e5d449fbc8acf97489e16a9d05
starknet invoke --function mint --address $LORDS_ADDRESS --input 0x1feb9c05d31b70a1506decf52a809d57493bfcd5cc85d6a3e9fd54a12d64389 1000000000000000000000 0 --max_fee 10000000000000000 --account $ACCOUNT_NAME

starknet invoke --function approve --address $LORDS_ADDRESS --input $CONTRACT_ADDRESS 1000000000000000000000 0 --max_fee 10000000000000000 --account $ACCOUNT_NAME

Game Actions

Start

starknet invoke --function start --address $CONTRACT_ADDRESS --input 12 123 0 0 0 0 --max_fee 10000000000000000 --account $ACCOUNT_NAME

Explore

starknet invoke --function explore --address $CONTRACT_ADDRESS --input $ADVENTURER_ID 0 --max_fee 10000000000000000 --account $ACCOUNT_NAME

Attack

starknet invoke --function attack --address $CONTRACT_ADDRESS --input $ADVENTURER_ID 0 --max_fee 10000000000000000 --account $ACCOUNT_NAME

Flee

starknet invoke --function flee --address $CONTRACT_ADDRESS --input $ADVENTURER_ID 0 --max_fee 10000000000000000 --account $ACCOUNT_NAME

Upgrade Stat (Charisma)

starknet invoke --function upgrade_stat --address $CONTRACT_ADDRESS --input $ADVENTURER_ID 0 $CHARISMA --max_fee 10000000000000000 --account $ACCOUNT_NAME

Checking On Your Adventurer

Get full adventurer state
starknet call --function get_adventurer --address $CONTRACT_ADDRESS --input $ADVENTURER_ID 0 --account $ACCOUNT_NAME
Get adventurer health
starknet call --function get_health --address $CONTRACT_ADDRESS --input $ADVENTURER_ID 0 --account $ACCOUNT_NAME
Get adventurer gold
starknet call --function get_gold --address $CONTRACT_ADDRESS --input $ADVENTURER_ID 0 --account $ACCOUNT_NAME
Get adventurer xp
starknet call --function get_xp --address $CONTRACT_ADDRESS --input $ADVENTURER_ID 0 --account $ACCOUNT_NAME
Get upgradable stat points
starknet call --function get_stat_upgrades_available --address $CONTRACT_ADDRESS --input $ADVENTURER_ID 0 --account $ACCOUNT_NAME
Get base charisma stat (doesn't include boost from items)
starknet call --function get_base_charisma --address $CONTRACT_ADDRESS --input $ADVENTURER_ID 0 --account $ACCOUNT_NAME
Get charisma stat including item boosts
starknet call --function get_charisma --address $CONTRACT_ADDRESS --input $ADVENTURER_ID 0 --account $ACCOUNT_NAME