Skip to content

README.md

Latest commit

 

History

History
60 lines (38 loc) · 1.61 KB

README.md

File metadata and controls

60 lines (38 loc) · 1.61 KB

Osrs Progress Lambda

This AWS Lambda function fetches Old School Runescape player progress and posts updates to a Discord channel via webhook.

Features

  • Fetches player progress from the Wise Old Man API
  • Wont include inactive players
  • Ranks players by either experience, boss, activity, or efficiency metrics
  • Formats and sends updates to Discord using webhooks
  • Designed for automated deployment with GitHub Actions

Ranking Embed

image

Player Embed

image

Usage

  1. Set the following environment variables in Lambda:

    • USERNAMES: Comma-separated list of OSRS usernames - Required
    • WEBHOOK_URL: Discord webhook URL - Required
    • SEND_PLAYER_EMBED: true, false - Defaults to true
    • SEND_RANKING_EMBED: true,false - Default to true
    • SORT_BY: experience_gains, boss_gains, activity_gains - Defaults to experience_gains
    • PERIOD: five_min day, week, month - Defaults to day
    • SEND_PLAYER_UPDATE: true, false - Defaults to true. Requests a Wise Old Man player update before fetching gains so the report uses the latest available data.

  2. https://github.com/Dava96/osrs-progress-lambda/wiki

Local Installation

Install dependencies with:

pip install -r requirements.txt

Testing

Run tests with:

python -m unittest discover tests

Requirements

  • Python 3.12+
  • requests
  • discord-webhook

Thanks to

https://github.com/wise-old-man/wise-old-man