Weather Index

Unified platform for Risk of Rain 2 runs

https://wi.shuflduf.xyz/

Links

• Frontend: https://wi.shuflduf.xyz/
• Backend: https://wi-api.shuflduf.xyz/
• Mod: https://thunderstore.io/c/riskofrain2/p/Shuflduf/WeatherIndex/

Features

• Rust backend
  • axum routing
  • better-auth-rs [^1] for auth
    • OAuth providers: Discord, Google, GitHub, Hack Club Auth, and Slack (Hack Club workspace)
  • sea-orm for database handling
  • Full documented API routes, docs available on the frontend
• SvelteKit frontend
  • Geist design systems
  • TailwindCSS for styling
  • Lucide icons for non-brand icons
  • Simple Icons for brand-icons
  • Scalar for API documentation
  • Interactive guide to get started with Risk of Rain 2 modding and Weather Index
• Risk of Rain 2 mod
  • Tracks all sorts of data, from kills, to distance traveled, to stage order, to which items where picked up and when
    • Full table can be found here
  • Data dumper to extract item data, enemy/survivor data, and more
• CORS support

Screenshots

Click to view screenshots

Main run report listing

Properties to view, filter, and sort by

Stats on played survivors and difficulties

Scalar API docs

Introduction to modding guide

Settings page

Profile page

Installation

Full interactive guide is available on the website here

1. Sign in on the website
2. Ensure that r2modman is installed.
3. Make a new profile (or use an existing profile)
4. Install "WeatherIndex" from the Online tab
5. Start Modded
6. In the game's Mod Settings, find WeatherIndex and click Link Account. This will open your web browser for authentication.

Project Structure [^2]

Weather-Index/
├── backend # This is where the BACKEND goes
├── data # This is where static DATA goes
├── frontend # This is where the FRONTEND goes
└── mod # This is where the MOD goes

Development Setup

For all of the components, you will need a clone of https://github.com/Shuflduf/Weather-Index.git

Backend

1. Make backend/.env from backend/.env.example and fill in all the fields
2. Run cargo build in backend/ to install the dependencies
3. Run cargo run in backend/ to start the backend on http://localhost:3000

Frontend

1. Make frontend/.env from frontend/.env.example and fill in all the fields
2. Run deno install in frontend/ to install the dependencies
3. Run deno run dev in frontend/ to start the frontend on http://localhost:5173

Mod

1. Run dotnet build -c Release in mod/ to install the dependencies, build the mod, and package it.
2. In your r2modman profile, click Settings and click Import Local Mod
3. Select the generated zip under mod/bin/Release/netstandard2.1/WeatherIndex_[VERSION].zip
4. Start Modded
5. Change the Debug > Backend URL option to http://localhost:3000 if interacting with the backend (which you probably are)

[^1]: The official library is so buggy, this project instead uses a fork [^2]: For legal reasons this is a joke