Travian 5 API Client Framework
python setup.py sdist --formats=zip
cd dist
pip install primordial-x.x.x.zippip install git+https://github.com/didadadida93/primordial.gitfrom primordial import Lobbylobby = Lobby()lobby.authenticate(email=' ', password=' ')gameworld = lobby.connect_to_gameworld(gameworld_name=' ', gameworld_id=0)gameworld = lobby.connect_to_gameworld(gameworld_name=' ', avatar_id=0)Note: For a complete list of controllers and their actions, see the Table of Contents
dir(gameworld.building)
gameworld.building.upgrade.params
response = gameworld.building.upgrade(params={'villageId': 0, 'locationId': 0, 'buildingType': 0})dir(gameworld.reports)
gameworld.reports.getLastReports.params
response = gameworld.reports.getLastReports(params={'collection': ' ', 'start': 0, 'count': 0, 'filter': [], 'alsoGetTotalNumber': False})By default Lobby object use HttpClient object that have this settings:
headers={'User-Agent': 'Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:66.0) Gecko/20100101 Firefox/66.0'}timeout=20.0cookies=requests.cookies.RequestsCookieJarproxies=None
if you want to customize with your own settings, you can do
from primordial import HttpClient
from primordial import Lobby
client = HttpClient(proxies={}, headers={}, timeout=5.0, ...)
lobby = Lobby(client=client)Note: For a guide on how to use proxies see http://docs.python-requests.org/en/master/user/advanced/#proxies
| Controller | Actions |
|---|---|
| login | logout |
| cache | get |
| player | abortDeletion |
| switchCountry | |
| saveName | |
| getAll | |
| getAvatarData | |
| getPrestigeOnWorlds | |
| getAccountDetails | |
| deleteAvatar | |
| gameworld | getPossibleNewGameworlds |
| sitter | remove |
| add | |
| setPermissions | |
| dual | add |
| notification | markAsRead |
| achievements | update |
| Controller | Actions |
|---|---|
| player | reportPlayer |
| getAll | |
| getReferralDirection | |
| chooseTribe | |
| checkKingRegistrationRule | |
| getSystemMessage | |
| getAchievementNotifications | |
| changeTimeType | |
| ping | |
| deleteAllNotifications | |
| getOpenChatWindows | |
| deleteNotification | |
| getCardgameResult | |
| getMidnight | |
| selectCards | |
| getInvitationRefLink | |
| getPlayerInfo | |
| setOpenChatWindows | |
| changeSettings | |
| addNote | |
| changeNote | |
| removeNote | |
| getActivityStreams | |
| getPrestigeConditions | |
| getRobberVillagesAmount | |
| resetActivityStream | |
| triggerInGameHelpNotice | |
| changeVacationState | |
| requestVerification | |
| verifyAction | |
| abortDeletion | |
| requestExternalLogin | |
| updatePlayerProfileContent | |
| editProfile | |
| getInvitationsList | |
| sendInvitation | |
| reportConversation | |
| reportConversationFinalize | |
| getPlayerInfluence | |
| inviteToKingdom | |
| farmList | changeListOrder |
| toggleEntry | |
| getAttackInfo | |
| editTroops | |
| createList | |
| copyEntry | |
| deleteList | |
| deleteEntry | |
| checkTarget | |
| addEntry | |
| editList | |
| logger | logMessage |
| troops | disband |
| getMarkers | |
| setMarker | |
| abortTroopMovement | |
| checkTarget | |
| send | |
| startPartialFarmListRaid | |
| startFarmListRaid | |
| fightSimulate | |
| moveTroopsHome | |
| village | getVictoryPointsAndInfluenceBonus |
| clickSpecial | |
| toggleAllowTributeCollection | |
| getVillagesWithInfluenceOnOasisForPlayer | |
| getKingdomVillageAttacks | |
| getProductionDetails | |
| useOasis | |
| clearOasis | |
| updateName | |
| checkUnitProduction | |
| getTreasuriesCapacity | |
| cache | get |
| quest | resetDailyQuest |
| getPuzzle | |
| solvePuzzle | |
| dialogAction | |
| checkRewardCollectible | |
| collectReward | |
| error | logJavascriptError |
| auctions | sellItem |
| getRunningAuctionAmount | |
| getRunningAuctionPage | |
| placeBid | |
| getSellerPayout | |
| hero | switchItems |
| getValuePoints | |
| addAttributePoints | |
| mergeItem | |
| saveFace | |
| getLastInventoryView | |
| getTreasureSellPrice | |
| getDurationToClosestVillageWithInfluence | |
| useItem | |
| setLastInventoryView | |
| getResourceForResourceChest | |
| upgradeItem | |
| revive | |
| confirmHeroLevelUp | |
| building | getCpData |
| getCelebrationList | |
| startCelebration | |
| getBuildingList | |
| getTrapperInfos | |
| buildTraps | |
| upgrade | |
| getRecruitList | |
| recruitUnits | |
| useMasterBuilder | |
| getOasisList | |
| getCulturePointBalance | |
| reserveResources | |
| cancel | |
| researchUnit | |
| shiftMasterBuilder | |
| destroy | |
| getTreasuryTransformations | |
| transformTreasury | |
| trade | acceptOffer |
| changeTradeRouteStatus | |
| deleteTradeRoute | |
| checkTarget | |
| createOffer | |
| cancelOffer | |
| getOfferList | |
| sendResources | |
| ranking | getKingdomInternalRanking |
| getKingdomVictoryPointsWithTreasures | |
| getKingdomStats | |
| getRanking | |
| getRankingAveragePoints | |
| getRankAndCount | |
| getWorldStats | |
| kingdom | cancelKingdom |
| cancelGovernor | |
| acceptInvitation | |
| getTop3NearbyKings | |
| startCoronationCeremony | |
| changeTag | |
| promoteToDuke | |
| changeDescription | |
| declineInvitation | |
| getFightStrengthRanks | |
| getNews | |
| changeInternalDescription | |
| getDukeCandidate | |
| map | getKingdomInfluenceStatistics |
| getHeatmapMaximums | |
| getByRegionIds | |
| editMapMarkers | |
| fieldMarkerMinimize | |
| fieldMarkerClose | |
| fieldMarkerDelete | |
| reports | removeAsFavorite |
| getLastReports | |
| getFullReport | |
| markAsFavorite | |
| shareReport | |
| society | close |
| getSharedInformations | |
| create | |
| invite | |
| declineInvitation | |
| changeDescription | |
| premiumFeature | cropProductionBonus |
| saveAutoExtendFlags | |
| treasureResourcesInstant | |
| cardgameSingle | |
| cardgame4of5 | |
| starterPackage | |
| buildingMasterSlot | |
| exchangeOffice | |
| NPCTrader | |
| finishNow | |
| plusAccount | |
| productionBonus | |
| payment | getSmallestPackage |
| getPaymentShopUrl | |
| kingdomTreaty | cancel |
| offer | |
| deny | |
| login | logout |
There are 3 controllers that have not yet been implemented
- cheat
- cheatsheat
- adb
These do not contain any actions that can be used by a non MH client
Some controllers are missing some actions
Please see dev/README.md
Each action contains a dict of params
Each param has been set to a default for the respective type, i.e int=0, bool=False
Ensure that the param types of your queries match those types
Majority of params of type dict or list can have an arbitrary amount of nested params
The cache controller contains only one action: get
The sole param of get is 'names' of type list
The 'names' list may contain an arbitrary amount of values
A list of unique possible values for the 'names' param can be found in dev/cache_params.py
Please note that where a value contains an int, it should be treated as an id and replaced where relevant
disclaimer: please note that this is a research project. i am by no means responsible for any usage of this tool. use on your own behalf. i am also not responsible if your accounts get banned due to extensive use of this tool.