Mithraeum API Docs
This section explains game structure, existing game assets and contract interactions
Game structure
Scheme above roughly represents how smart contracts placed in the system.
Brief explanation of each element
World.sol
Contains registry, geography, banners, bless token, distributions, cross epochs' memory, reward pool. Also contains helpful methods to interact with game assets such as batch resource transfers.
Registry.sol
Contains game configuration constants related to game balance, also contains configuration related to creation of new world assets and their implementations.
Geography.sol
Contains geography information.
Banners.sol
Standalone ERC721 & ERC1155Receiver. Used to link settlement with Nft.
Distributions.sol
Standalone ERC1155. Specifies distribution rules. Each building has own distribution rules.
CrossEpochsMemory.sol
Contains saved data in between world destruction's, such as settlements positions, zones settlements count.
RewardPool.sol
Contains bless tokens which can be swapped for weapons.
Epoch.sol
Contains addresses which represent current game tokens such as resources, units, workers, prosperity; Also contains placed settlements and activated zones in current epoch.
Workers.sol
Custom ERC-20 token, only certain world asset able to have this token, such as 'Settlement', 'Building', 'WorkersPool'. Interacts with world when transfer happens related to world assets and gives the world an ability to modify balances whenever necessary (in such events as set from/to production building, interacting with workers pools, etc.).
Prosperity.sol
Custom ERC-20 token, only certain world asset able to have this token, such as 'Settlement', 'WorkersPool'. Gives the world an ability to modify balances whenever necessary (in such events as replenishing treasury, interacting with workers pools, etc.). Even though this is ERC-20 token real balance of it can be negative.
Resource.sol
Custom ERC-20 token, interacts with world when transfer happens related to world assets and gives the world an ability to modify balances whenever necessary (in such events as productions, robbery, interacting with workers or units markets, etc.). Currently represents FOOD, WOOD, COPPER, WEAPON tokens.
Units.sol
Custom ERC-20 token, only certain world asset able to have this token, such as 'Siege', 'Army', 'UnitsPool'. Interacts with world when transfer happens related to world assets and gives the world an ability to modify balances whenever necessary (in such events as minting occultists, interacting with units pools, etc.).
TileCapturingSystem.sol
Tile capturing system related to its epoch. Contains parameters and method to provide interact with tile capturing mechanics.
Settlement.sol
Central hub of user assets. Banner id specified in this contract will be considered as settlement owner. Contains settlements' assets, such as buildings, siege, army. Also methods to manage governors and settlement.
Zone.sol
Contains settlement market, addresses to related workers and units pools and parameters which are related to these pools. Also contains method to spawn occultists.
OccultistsSettlement.sol
Modified settlement entity, which doesn't have an owner. Main purpose of it is containing the army of occultists in each zone.
Army.sol
Contains data about current position, siege, battle, movement and method to manage/interact with current army.
SettlementMarket.sol
Settlement market related to its zone. Contains parameters and method to provide settlement market capabilities. Bless token is the currency you use in this market.
WorkersPool.sol
Workers pool which related to its zone. Contains parameters and method to provide workers pool capabilities. Settlement's prosperity is the currency you use in this pool.
UnitsPool.sol
Units pool which related to its zone. Contains parameters and method to provide units pool capabilities. Tools is the currency you use in this pool.
Building.sol
Abstract entity of production building which contains common production state and logic related to production. Every production building inherits this element.
Siege.sol
Contains data about current siege, besieging armies. Also contains method to manage siege, such as stake/unstake units, building robbery, army liquidation, etc.
Battle.sol
Contains data about current battle, joined armies. Also contains methods to interact with battle, such as joining, finishing battle, exiting from battle.
Last updated
