nitro_plugin 0.31.0

Plugin loading and definition for Nitrolaunch
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
117
118

use nitro_shared::Side;
use serde::{Deserialize, Serialize};

/// A serializable value with a schema
#[derive(Serialize, Deserialize, Clone, PartialEq, Default)]
pub struct Control {
	/// Serialized field ID of this control. Can have dots to specify nested structure.
	pub id: String,
	/// Display name for this control
	pub name: String,
	/// Schema for this control
	pub schema: ControlSchema,
	/// Optional default value for this control
	#[serde(default)]
	pub default: Option<serde_json::Value>,
	/// Tooltip / description for this control
	#[serde(default)]
	pub description: Option<String>,
	/// CSS color for the control. May not be used.
	#[serde(default)]
	pub color: Option<String>,
	/// Icon for the control. May not be used.
	#[serde(default)]
	pub icon: Option<String>,
	/// Name of the section this control is in
	#[serde(default)]
	pub section: Option<String>,
	/// Whether to always serialize this control, even if it is the default value
	#[serde(default)]
	pub always_serialize: bool,
	/// Optional required side to show this control
	#[serde(default)]
	pub side: Option<Side>,
}

/// Schema of possible values and the interface for a controllable value, like a config field
#[derive(Serialize, Deserialize, Clone, PartialEq, Default)]
#[serde(rename_all = "snake_case")]
#[serde(tag = "type")]
pub enum ControlSchema {
	/// True / False
	#[default]
	Boolean,
	/// Define metadata for a section
	Section,
	/// Enumeration / Multiple choice
	Choice {
		/// The available variants
		variants: Vec<Variant>,
		/// Whether to use a dropdown
		#[serde(default)]
		dropdown: bool,
		/// Whether selection of multiple variants is allowed
		#[serde(default)]
		multiple: bool,
	},
	/// String of characters
	String {
		/// Whether to force the string to be lowercase
		#[serde(default)]
		lowercase: bool,
	},
	/// Absolute filesystem path
	Path {
		/// Whether to allow selection of directories
		#[serde(default)]
		directory: bool,
	},
	/// Number
	Number {
		/// Minimum value
		min: Option<f32>,
		/// Maximum value
		max: Option<f32>,
		/// Step value. If 1, number will be serialized as an integer.
		step: f32,
		/// Whether to use a slider for the value
		#[serde(default)]
		slider: bool,
	},
	/// List of simple string values
	StringList,
	// /// Optional guard around another control
	// Optional(Box<ControlSchema>),
	/// List of sub-objects
	List {
		/// Controls for each sub-object
		fields: Vec<Control>,
		/// Whether this is a schema of a list or string key-value map
		#[serde(default)]
		is_map: bool,
	},
	/// A raw JSON object
	Json,
	/// A keyboard keybind, following the schema of the nitro_options crate
	Keybind,
	/// A button that copies text
	CopyButton {
		/// Text to copy
		text: String,
	},
}

/// Variant of a choice control
#[derive(Serialize, Deserialize, Clone, PartialEq)]

pub struct Variant {
	/// ID of the variant. Can be null to specify a null variant.
	pub id: Option<String>,
	/// Display name of the variant
	pub name: String,
	/// Description of the variant
	#[serde(default)]
	pub description: Option<String>,
	/// Color of the variant
	#[serde(default)]
	pub color: Option<String>,
}