sodoff/README.md
2023-11-23 15:15:38 +01:00

138 lines
3.9 KiB
Markdown

# SoD-Off - School of Dragons, Offline
On 7th June, 2023, School of Dragons announced they were "sunsetting" the game, and turning the servers off on the 30th of June.
## Discord
[![Discord Banner](https://discordapp.com/api/guilds/1124405524679643318/widget.png?style=banner2)](https://discord.gg/bqHtMRbhM3)
## Getting started
For the first time setup, run the following command:
```
dotnet restore
```
Then run the server as follows:
```
# run mitmproxy to redirect requests to the app
mitmproxy -s mitm-redirect.py
# run the server
dotnet run --project src/sodoff.csproj
```
Then run School of Dragons.
## Status
### What works
- register/login
- create profile
- list profiles
- tutorial
- roaming in the open world
- inventory
- store
- missions
- hideouts
- farms
- minigames
- MMO (using sodoff-mmo)
### Methods
#### Fully implemented
- GetKeyValuePairByUserID
- GetKeyValuePair
- SetKeyValuePairByUserID
- SetKeyValuePair
- GetAuthoritativeTime
- LoginParent
- GetUserInfoByApiToken
- IsValidApiToken_V2
- LoginChild
- SetAvatar
- RegisterParent
- RegisterChild
- CreatePet
- SetSelectedPet
- GetAllActivePetsByuserId
- GetSelectedRaisedPet
- SetImage
- GetImage
- GetImageByUserId
- GetItem
- GetStore
- PurchaseItems (V1)
- PurchaseItems (V2)
- AcceptMission
- GetUserMissionState
- GetUserActiveMissionState
- GetUserUpcomingMissionState
- GetUserCompletedMissionState
- GetChildList
- GetUnselectedPetByTypes
- UseInventory
- DeleteProfile
- DeleteAccountNotification
- SetAchievementAndGetReward
- GetAchievementsByUserID
- GetPetAchievementsByUserID
- RerollUserItem
- FuseItems
- AddBattleItems
- SetAchievementByEntityIDs
- RedeemMysteryBoxItems
- SetDragonXP (used by account import tools)
- SetPlayerXP (used by account import tools)
- AuthenticateUser
- GetMMOServerInfoWithZone (uses resource xml as response)
- GetDefaultNameSuggestion
- SetCommonInventory
- GetCommonInventory (V2)
- GetUserRoomItemPositions
- SetUserRoomItemPositions
- GetUserProfileByUserID
- GetUserProfile
- GetDetailedChildList
#### Implemented enough (probably)
- GetRules (doesn't return any rules, probably doesn't need to)
- GetQuestions (doesn't return all questions, probably doesn't need to)
- GetSubscriptionInfo (always returns member, with end date 10 years from now)
- SetTaskState (only the TaskCanBeDone status is supported; might contain a serious problem - see the MissionService class)
- SetUserAchievementAndGetReward (works like SetAchievementAndGetReward)
- ValidateName
- GetCommonInventory (V1 - returns the viking's inventory if it is called with a viking; otherwise returns 8 viking slots)
- SetUserRoom
- SetNextItemState
#### Partially implemented
- GetUserRoomList (room categories are not implemented, but it's enough for SoD)
- SetUserAchievementTask (returns a real reward but still use task placeholder)
- ProcessRewardedItems (gives gems, but doesn't give gold, gold is not yet implemented)
- SellItems (gives gems, but doesn't give gold, gold is not yet implemented)
- ApplyRewards
- ApplyPayout (doesn't calculate rewards properly)
- GetUserAchievements (used by Magic & Mythies)
#### Currently static or stubbed
- GetAllRanks (needs to be populated with what ranks the user has)
- GetAchievementTaskInfo (returns a static XML)
- GetAllRewardTypeMultiplier (returns a static XML)
- GetBuddyList (returns an emtpy array)
- GetRankAttributeData (returns a static XML)
- GetAllRewardTypeMultiplier (returns a static XML)
- GetUserMessageQueue (returns an emtpy array)
- SendMessage (doesn't do anything and returns false)
- SaveMessage (doesn't do anything and returns false)
- GetActiveChallenges (returns an empty array)
- GetAnnouncementsByUser (returns no announcements, but that might be sufficient)
- GetAverageRatingForRoom (return max rating)
- GetUserActivityByUserID (returns an empty array)
- GetUserGameCurrency (return 65536 gems and 65536 coins)
- GetGameData (empty response)
- GetProfileTagAll (returns an empty array - used by Magic & Mythies)