Shuflduf-WeatherIndex icon

WeatherIndex

Unified platform for Risk of Rain 2 runs

Last updated 13 hours ago
Total downloads 8
Total rating 0 
Categories Mods Tools Client-side
Dependency string Shuflduf-WeatherIndex-0.1.0
Dependants 0 other packages depend on this package

This mod requires the following mods to function

Rune580-Risk_Of_Options-2.8.5 icon
Rune580-Risk_Of_Options

A convenient API for adding BepInEx ConfigEntry's to a option menu

Preferred version: 2.8.5

README

Weather Index

Unified platform for Risk of Rain 2 runs

Features

  • Rust backend
  • SvelteKit frontend
  • 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 at [backend/src/entity/run_report.rs]
    • Data dumper to extract item data, enemy/survivor data, and more
  • CORS support

Installation

TODO: ACTUALLY PUBLISH THE FUCKING MOD

  1. Sign in on the website
  2. Ensure that r2modman is installed.
  3. Make a new profile (or use an existing profile)
  4. Install "Weather Index" 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

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

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

Mod

  1. Run dotnet build in mod/ to install the dependencies and build the mod
  2. TODO

[^1]: The official library is so buggy, this project instead uses a fork