dmclc5 0.3.2

A minecraft launching library
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

//! Things about contents.
//! Contents are things like mods, data packs, resource packs, worlds, modpacks and shaders...

pub(crate) mod modrinth;
pub(crate) mod curseforge;

use std::collections::HashMap;

use anyhow::Result;
use async_trait::async_trait;

use crate::{minecraft::version::MinecraftInstallation, utils::BetterPath, LauncherContext};

/// Type of contents.
#[derive(PartialEq, Eq, Hash)]
#[allow(missing_docs)]
pub enum ContentType {
    ModPack,
    Shader,
    Mod,
    ResourcePack,
    DataPack,
    World,
}

/// Represents a screenshot.
#[allow(missing_docs)]
pub struct Screenshot {
    pub url: String,
    pub title: Option<String>,
    pub description: Option<String>
}

/// Represents a `content`.
#[async_trait]
pub trait Content: Send + Sync {
    /// List downloadable versions.
    async fn list_downloadable_versions(&self, for_version: Option<&MinecraftInstallation<'_>>, launcher: &LauncherContext) -> Result<Vec<Box<dyn ContentVersion>>>;
    /// Get title.
    fn get_title(&self) -> String;
    /// Get description.
    fn get_description(&self) -> String;
    /// Get content body article in HTML.
    async fn get_body(&self, launcher: &LauncherContext) -> Result<String>;
    /// Get icon url.
    fn get_icon_url(&self) -> Option<String>;
    /// Get url for issue, Discord, source....
    /// The key is the name, the value is the url.
    fn get_urls(&self) -> HashMap<String, String>;
    /// Get the screenshots.
    fn get_screenshots(&self) -> Vec<Screenshot>;
    /// Get other informations like authors, downloads...
    fn get_other_information(&self) -> HashMap<String, String>;
    /// Check if this is a library mod.
    fn is_library(&self) -> bool;
    /// Returns the [ContentType].
    fn kind(&self) -> ContentType;
}

/**
 * A content version.
 */
#[async_trait]
pub trait ContentVersion: Send + Sync {
    /// Get file url.
    fn get_version_file_url(&self) -> String;
    /// Get file SHA1.
    fn get_version_file_sha1(&self) -> String;
    /// Get file name.
    fn get_version_file_name(&self) -> String;
    /// Get changelog in HTML.
    async fn get_version_changelog(&self, launcher: &LauncherContext) -> Result<String>;
    /// Get version number.
    fn get_version_number(&self) -> String;
    /// List the dependencies.
    async fn list_dependencies(&self, launcher: &LauncherContext) -> Result<Vec<ContentDependency>>;
}

/// Represents the dependencies.
pub enum ContentDependency
{
    /// A [Content].
    Content(Box<dyn Content>),
    /// A [ContentVersion].
    ContentVersion(Box<dyn ContentVersion>),
}

/// A service (website) that provides contents like CurseForge and Modrinth.
#[async_trait]
pub trait ContentService: Send + Sync {
    /// Search for contents.
    async fn search_content(
        &self,
        name: String,
        skip: usize,
        limit: usize,
        kind: ContentType,
        sort_field: usize,
        for_version: Option<&MinecraftInstallation<'_>>,
        launcher: &LauncherContext
    ) -> Result<Vec<Box<dyn Content>>>;
    /// Get unsupported [ContentType]s.
    fn get_unsupported_content_types(&self) -> Vec<ContentType>;
    /// Get all sort fields.
    fn get_sort_fields(&self) -> Vec<String>;
    /// Get the default sort field.
    fn get_default_sort_field(&self) -> String;
    /// Get a [ContentVersion] from a file.
    async fn get_content_version_from_file(&self, path: &BetterPath, launcher: &LauncherContext) -> Result<Option<Box<dyn ContentVersion>>>;

    /// Get a [Content] by ID.
    async fn get_content_by_id(&self, id: &str, launcher: &LauncherContext) -> Result<Option<Box<dyn Content>>>;

    /// Get a [ContentVersion] by ID.
    async fn get_content_version_by_id(&self, content_id: &str, id: &str, launcher: &LauncherContext) -> Result<Option<Box<dyn ContentVersion>>>;
}