mcvm 0.25.0

A fast, extensible, and powerful Minecraft launcher
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

use anyhow::{anyhow, Context};
use directories::{BaseDirs, ProjectDirs};

use std::path::PathBuf;

/// Store for all of the paths that are used throughout the application
#[derive(Debug, Clone)]
pub struct Paths {
	/// System-wide directories
	pub base: BaseDirs,
	/// Project-specific directories
	pub project: ProjectDirs,
	/// Paths object from core
	pub core: mcvm_core::Paths,
	/// Holds program data
	pub data: PathBuf,
	/// Holds internal data
	pub internal: PathBuf,
	/// Holds addons
	pub addons: PathBuf,
	/// Holds cached package scripts
	pub pkg_cache: PathBuf,
	/// Holds cached package repository indexes
	pub pkg_index_cache: PathBuf,
	/// Holds log files
	pub logs: PathBuf,
	/// Holds launch log files
	pub launch_logs: PathBuf,
	/// Used for runtime info like PIDs
	pub run: PathBuf,
	/// Storing instance snapshots
	pub snapshots: PathBuf,
	/// Storing proxy data
	pub proxy: PathBuf,
	/// Holding user plugins
	pub plugins: PathBuf,
}

impl Paths {
	/// Create a new Paths object and also create all of the paths it contains on the filesystem
	pub async fn new() -> anyhow::Result<Paths> {
		let out = Self::new_no_create()?;
		out.create_dirs().await?;

		Ok(out)
	}

	/// Create the directories on an existing set of paths
	pub async fn create_dirs(&self) -> anyhow::Result<()> {
		let _ = tokio::join!(
			tokio::fs::create_dir_all(&self.data),
			tokio::fs::create_dir_all(self.project.cache_dir()),
			tokio::fs::create_dir_all(self.project.config_dir()),
			tokio::fs::create_dir_all(&self.internal),
			tokio::fs::create_dir_all(&self.addons),
			tokio::fs::create_dir_all(&self.pkg_cache),
			tokio::fs::create_dir_all(&self.pkg_index_cache),
			tokio::fs::create_dir_all(&self.logs),
			tokio::fs::create_dir_all(&self.launch_logs),
			tokio::fs::create_dir_all(&self.run),
			tokio::fs::create_dir_all(&self.snapshots),
			tokio::fs::create_dir_all(&self.proxy),
			tokio::fs::create_dir_all(&self.plugins),
		);

		self.core.create_dirs()?;

		Ok(())
	}

	/// Create the paths without creating any directories
	pub fn new_no_create() -> anyhow::Result<Self> {
		let base = BaseDirs::new().ok_or(anyhow!("Base directories failed"))?;
		let project =
			ProjectDirs::from("", "mcvm", "mcvm").ok_or(anyhow!("Base directories failed"))?;

		let data = project.data_dir().to_owned();
		let internal = data.join("internal");
		let addons = internal.join("addons");
		let pkg_cache = project.cache_dir().join("pkg");
		let pkg_index_cache = pkg_cache.join("index");
		let logs = data.join("logs");
		let launch_logs = logs.join("launch");
		let run = project
			.runtime_dir()
			.map(|x| x.to_path_buf())
			.unwrap_or(internal.join("run"));
		let snapshots = internal.join("snapshots");
		let proxy = data.join("proxy");
		let plugins = data.join("plugins");

		let core_paths = mcvm_core::Paths::new().context("Failed to create core paths")?;

		Ok(Paths {
			base,
			project,
			core: core_paths,
			data,
			internal,
			addons,
			pkg_cache,
			pkg_index_cache,
			logs,
			launch_logs,
			run,
			snapshots,
			proxy,
			plugins,
		})
	}
}