reality

README

Milthm Reality

Go module milthm.dev/reality/v2 for computing reality scores based on song records.

Features

• Compute individual record ratings from song difficulty and player score.
• Aggregate up to 20 top ratings into a single reality score.

Installation

go get milthm.dev/reality/v2

Usage

import (
    "fmt"
    "milthm.dev/reality/v2"
)

func main() {
    // Implement ScoreRecorder and ChartInformationRepository interfaces
    total, err := reality.CalculateReality(scores, repo)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    fmt.Println("Total reality:", total)
}

Documentation

Index

• func CalculateReality(scores []ScoreRecord, chartRepo ChartInformationRepository) (float64, error)
• func CalculateSingleEntryReality(score ScoreRecord, chartRepo ChartInformationRepository) (float64, error)
• type ChartInformationRepository
• type ScoreRecord

Functions

func CalculateReality

func CalculateReality(scores []ScoreRecord, chartRepo ChartInformationRepository) (float64, error)

CalculateReality is used for calculating reality from given scores list and charts information

func CalculateSingleEntryReality

func CalculateSingleEntryReality(score ScoreRecord, chartRepo ChartInformationRepository) (float64, error)

CalculateSingleEntryReality is used for calculating how much reality this record donated

Types

type ChartInformationRepository

type ChartInformationRepository interface {
	GetDifficulty(chartID string) (float64, error)
}

type ScoreRecord

type ScoreRecord interface {
	GetChartID() string
	GetScore() float64
}