scratch-io 0.1.4

A rust library for managing, downloading, and launching games from itch.io
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

use crate::{errors::FilesystemError, filesystem, itch_api::types::*};
use std::path::{Path, PathBuf};

const MANIFEST_FILENAME: &str = ".itch.toml";
const MANIFEST_PLAY_ACTION: &str = "play";

impl ManifestAction {
  pub async fn get_canonical_path(&self, folder: &Path) -> Result<PathBuf, FilesystemError> {
    filesystem::get_canonical_path(&folder.join(&self.path)).await
  }
}

/// Read the manifest from a folder and parse it (if any)
pub async fn read_manifest(upload_folder: &Path) -> Result<Option<Manifest>, String> {
  let manifest_path = upload_folder.join(MANIFEST_FILENAME);

  if !filesystem::exists(&manifest_path).await? {
    return Ok(None);
  }

  let manifest_text: String = tokio::fs::read_to_string(&manifest_path)
    .await
    .map_err(|e| e.to_string())?;

  toml::from_str::<Manifest>(&manifest_text)
    .map(Some)
    .map_err(|e| {
      format!(
        "Couldn't parse itch manifest: {}\n{e}",
        manifest_path.to_string_lossy()
      )
    })
}

/// Returns an itch.io [`ManifestAction`] given its name and the folder where the game manifest is located
pub async fn launch_action(
  upload_folder: &Path,
  action_name: Option<&str>,
) -> Result<Option<ManifestAction>, String> {
  let Some(manifest) = read_manifest(upload_folder).await? else {
    return Ok(None);
  };

  let action_name = action_name.unwrap_or(MANIFEST_PLAY_ACTION);

  Ok(
    manifest
      .actions
      .unwrap_or_default()
      .into_iter()
      .find(|a| a.name == action_name),
  )
}