/SotLedger

A simple script to show Sea of Thieves Leaderboards in more readable way 🦜

Primary LanguageTypeScriptMIT LicenseMIT

SotLedger has been archived 📚 OSS Lifecycle

I don't want to maintain the project anymore. Because it depends on not-public API, it will be constantly broken and must be constantly fixed. There is no documentation to refer to and breaking changes are happing without warning. Also, prizes after season one remained the same so I don't get any benefits from maintaining it. Code remains on MIT license so if anyone would want to continue it, they can.


Presentation Image

🏴‍ Introduction

Ships of Fortune monthly update for Sea Of Thieves game made by Rare and Xbox Games Studio introduced Emissaries. Most active players became Ledgers and compete for the unique prizes in the leaderboard.

The purpose of the project is to make checking your current positions very easily inside the terminal. Of course, you can use official sources like Leaderboard Page or check it in-game, however, this is a much more readable way.

⚓ Installation

You can set up the script in 4 easy steps:

1 Install Required Software:

2 Clone The Repository:

git clone https://github.com/MrBartusek/SotLedger.git
cd SotLedger

3 Install Dependencies and build project:

npm install
npm run build

4 Setup token.txt file with rat token How to Setup rat token

☠️ Usage

When you are inside the project directory you can type:

npm start

🦜 How SotLedger fetches data and how to get rat token

Unfortunately, Sea Of Thieves doesn't provide any official API at this points so this project uses a slightly hacky way of authenticating a user. When you log in to Microsoft account at Sea Of Thieves Website a rat cookie is saved to your browser so you don't have to use retype your login credentials every visit. Then script fetches data from AJAX endpoints intended for Official Leaderboard Page

❗ And there is a catch 🎣❗ rat token is used to access your account so you should never provide your token to any untrusted source. SotLedger is open source and runs on your local machine and its code is maintained as clean as possible but, still, you shouldn't trust random text file on the internet. That is strongly advised to review project code before providing your token.

To retrieve your token you can use EditThisCookie browser extension to copy rat cookie from LeaderBoard Page. Then create token.txt file in the main project directory and paste rat token intro it. Expand image below for more info!

Expandable Image EditThisCookie tutorial

SotLedger is not Official Rare or Xbox Game Studio project and is not Approved or Associated with Rare nor Xbox Games Studio.