Badges and scoreboards

Cargo.toml

@@ -19,7 +19,9 @@ categories = [
 
 [dependencies]
 # Simpler error handling
-anyhow = "1.0.90"
+anyhow = "1.0.93"
+# Get current date and time.
+chrono = { version = "0.4.38", default-features = false, features = ["clock"] }
 # Framework for parsing CLI args
 clap = { version = "4.5.20", features = ["derive"] }
 # TUI for the "monitor" command, colored terminal output
@@ -29,11 +31,11 @@ data-encoding = "2.6.0"
 # Find the best place to sotre the VFS
 directories = "5.0.1"
 # Serialize app config into meta file in the ROM
-firefly-types = { version = "0.2.0" }
+firefly-types = { version = "0.3.0" }
 # Decode wav files
 hound = "3.5.1"
 # Parse PNG images
-image = { version = "0.25.4", default-features = false, features = ["png"] }
+image = { version = "0.25.5", default-features = false, features = ["png"] }
 # Random device name generation
 rand = "0.8.5"
 # Signatures
@@ -44,7 +46,7 @@ rsa = { version = "0.9.6", default-features = false, features = [
 # REPL
 rustyline = "14.0.0"
 # Deserialize firefly.toml (required by `toml`)
-serde = { version = "1.0.210", features = ["serde_derive", "derive"] }
+serde = { version = "1.0.214", features = ["serde_derive", "derive"] }
 # Deserialize JSON API responses from the firefly catalog.
 serde_json = "1.0.132"
 # Calculate file checksum

src/args.rs

@@ -22,6 +22,21 @@ pub enum Commands {
     #[clap(alias("install"))]
     Import(ImportArgs),
 
+    /// List all badges (aka achievements) defined in the given app.
+    #[clap(alias("badge"), alias("achievements"), alias("achievement"))]
+    Badges(BadgesArgs),
+
+    /// List all boards (aka scoreboards or leaderboards) defined in the given app.
+    #[clap(
+        alias("board"),
+        alias("scoreboard"),
+        alias("leaderboard"),
+        alias("scoreboards"),
+        alias("leaderboards"),
+        alias("scores")
+    )]
+    Boards(BoardsArgs),
+
     /// Show the full path to the virtual filesystem.
     Vfs,
 
@@ -167,6 +182,22 @@ pub struct ExportArgs {
     pub output: Option<PathBuf>,
 }
 
+#[derive(Debug, Parser)]
+pub struct BadgesArgs {
+    /// Full app ID.
+    pub id: String,
+
+    /// Show hidden badges.
+    #[arg(long, default_value_t = false)]
+    pub hidden: bool,
+}
+
+#[derive(Debug, Parser)]
+pub struct BoardsArgs {
+    /// Full app ID.
+    pub id: String,
+}
+
 #[derive(Debug, Parser)]
 pub struct ImportArgs {
     /// The ROM to install.

src/audio.rs

@@ -1,6 +1,8 @@
 use anyhow::{bail, Context, Result};
 use hound::{SampleFormat, WavReader};
-use std::{fs::File, io::Write, path::Path};
+use std::fs::File;
+use std::io::Write;
+use std::path::Path;
 
 pub fn convert_wav(input_path: &Path, output_path: &Path) -> Result<()> {
     let mut reader = WavReader::open(input_path).context("open wav file")?;

src/cli.rs

@@ -8,6 +8,8 @@ pub fn run_command(vfs: PathBuf, command: &Commands) -> anyhow::Result<()> {
         Commands::Build(args) => cmd_build(vfs, args),
         Commands::Export(args) => cmd_export(&vfs, args),
         Commands::Import(args) => cmd_import(&vfs, args),
+        Commands::Badges(args) => cmd_badges(&vfs, args),
+        Commands::Boards(args) => cmd_boards(&vfs, args),
         Commands::Cheat(args) => cmd_cheat(args),
         Commands::Monitor(args) => cmd_monitor(&vfs, args),
         Commands::Inspect(args) => cmd_inspect(&vfs, args),

src/commands/badges.rs

@@ -0,0 +1,63 @@
+use crate::args::BadgesArgs;
+use crate::file_names::BADGES;
+use anyhow::{bail, Context, Result};
+use crossterm::style::Stylize;
+use firefly_types::Encode;
+use std::path::Path;
+
+pub fn cmd_badges(vfs: &Path, args: &BadgesArgs) -> Result<()> {
+    let Some((author_id, app_id)) = args.id.split_once('.') else {
+        bail!("invalid app id: dot not found");
+    };
+
+    // read stats
+    let stats_path = vfs.join("data").join(author_id).join(app_id).join("stats");
+    let raw = std::fs::read(stats_path).context("read stats file")?;
+    let stats = firefly_types::Stats::decode(&raw).context("decode stats")?;
+
+    // read badges
+    let rom_path = vfs.join("roms").join(author_id).join(app_id);
+    if !rom_path.exists() {
+        bail!("app {author_id}.{app_id} is not installed");
+    }
+    let badges_path = rom_path.join(BADGES);
+    if !badges_path.exists() {
+        bail!("the app does not have badges");
+    }
+    let raw = std::fs::read(badges_path).context("read badges file")?;
+    let badges = firefly_types::Badges::decode(&raw).context("decode badges")?;
+    let mut badges: Vec<_> = badges.badges.iter().zip(1..).collect();
+    badges.sort_by_key(|(badge, _id)| badge.position);
+
+    display_badges(&badges, &stats, args)
+}
+
+fn display_badges(
+    badges: &[(&firefly_types::Badge<'_>, usize)],
+    stats: &firefly_types::Stats,
+    args: &BadgesArgs,
+) -> Result<()> {
+    for (badge, id) in badges {
+        let Some(progress) = stats.badges.get(id - 1) else {
+            bail!("there are fewer badges in stats file than in the rom");
+        };
+        if progress.done < badge.hidden {
+            if !args.hidden {
+                continue;
+            }
+            print!("{}", "[hidden] ".grey());
+        };
+        println!("#{id} {} ({} XP)", badge.name.cyan(), badge.xp);
+        println!("{}", badge.descr);
+        let emoji = if progress.earned() {
+            "✅"
+        } else if progress.done == 0 {
+            "🚫"
+        } else {
+            "⌛"
+        };
+        println!("{emoji} {}/{}", progress.done, progress.goal);
+        println!();
+    }
+    Ok(())
+}