feat: add plugins management

Author: MagicTeaMC

.gitignore

@@ -3,4 +3,6 @@ server.jar
 eula.txt
 mcsast.config.json
 gate*
-.DS_Store
+.DS_Store
+plugins
+plugins.json

Cargo.lock

@@ -1,8 +1,8 @@
 [package]
 name = "mcsast"
 authors = ["MagicTeaMC <maoyue@maoyue.tw>"]
-description = "Manage Minecraft server / proxy quickly and easily!"
-version = "2.2.2"
+description = "Manage Minecraft server / proxy / plugins quickly and easily!"
+version = "2.3.0"
 edition = "2024"
 license = "GPL-3.0"
 
@@ -18,5 +18,9 @@ clap = { version = "4.5", features = ["derive"] }
 colored = "3.0"
 inquire = "0.7"
 reqwest = { version = "0.12", features = ["blocking", "json"] }
+tokio = { version = "1.0", features = ["full"] }
 serde = { version = "1.0", features = ["derive"] }
-serde_json = "1.0"
+serde_json = "1.0"
+
+[lints.rust]
+dead_code = "allow"

Cargo.toml

@@ -4,7 +4,7 @@
 [![Crates.io Total Downloads](https://img.shields.io/crates/d/mcsast?style=for-the-badge)](https://crates.io/crates/mcsast)
 [![Crates.io Version](https://img.shields.io/crates/v/mcsast?style=for-the-badge)](https://crates.io/crates/mcsast)
 
-Manage Minecraft server / proxy quickly and easily!
+Manage Minecraft server / proxy / plugins quickly and easily!
 ## Quick start
 ### Install via Cargo  
 ```
@@ -27,25 +27,65 @@ Give information to us with terminal:
 
 Want to add other software support? [Open an Issue](https://github.com/MagicTeaMC/Minecraft-server-auto-setup/issues).  
 
-## Commands
+## Servers commands
 ### Setup a server
-```
+```bash
 mcsast setup
 ```
 If you want it to setup automantic, here is a command  
 Note: The `--mc-version` and `--eula` flags are only required for Java Edition servers (not proxies).
-```
+```bash
 mcsast setup --software=paper --mc-version=1.21.1 --eula=true -y
 ```
 ### Update to latest build of current Minecraft version
-```
+```bash
 mcsast update
 ```
 ### Upgrade Minecraft version
-```
+```bash
 mcsast upgrade
 ```
 or
-```
+```bash
 mcsast upgrade --version 1.21.6
+```
+## Plugins commands
+### Help message
+```bash
+mcsast plugins
+```
+### List plugins
+```bash
+mcsast plugins list
+```
+### Add plugin 
+Note: `--force` to install latest unstable version  
+```bash
+mcsast plugins add <name>
+```
+### Load plugins setup
+```bash
+mcsast plugins load <file.json>
+```
+### Update plugins
+Note: `--force` to install latest unstable version  
+```bash
+mcsast plugins update <name/all>
+```
+### Remove plugin
+```bash
+mcsast plugins remove <name>
+```
+### Search plugins
+```bash
+mcsast plugins search <name>
+```
+### Get plugin information
+```bash
+mcsast plugins info <name/ID>
+```
+### Export plugins setup
+Note: `--output <filename.json>` to custom output file name  
+```bash
+mcsast plugins export
 ```

README.md

@@ -1,4 +1,5 @@
 rm -rf ./server.jar
 rm -rf ./eula.txt
 rm -rf ./mcsast.config.json
-rm -rf ./gate
+rm -rf ./gate
+rm -rf plugins/*

clean.sh

@@ -3,9 +3,9 @@ use clap::{Parser, Subcommand};
 
 #[derive(Parser)]
 #[command(
-    version = "2.2.2",
+    version = "2.3.0",
     author = "Maoyue (MagicTeaMC)",
-    about = "Manage Minecraft server / proxy quickly and easily!"
+    about = "Manage Minecraft server / proxy / plugins quickly and easily!"
 )]
 pub struct CLI {
     #[command(subcommand)]
@@ -40,4 +40,60 @@ pub enum Commands {
         #[arg(short, long)]
         version: Option<String>,
     },
+    /// manage plugins
+    Plugins {
+        #[command(subcommand)]
+        action: PluginActions,
+    },
+}
+
+#[derive(Subcommand)]
+pub enum PluginActions {
+    /// list installed plugins
+    List,
+    /// download and install a plugin
+    Add {
+        /// plugin name or project ID
+        name: String,
+        /// force install even if incompatible
+        #[arg(short, long, default_value_t = false)]
+        force: bool,
+    },
+    /// load plugins from config file
+    Load {
+        /// config file path
+        config: String,
+    },
+    /// update plugins
+    Update {
+        /// plugin name or 'all' for all plugins
+        target: String,
+        /// include beta/alpha versions
+        #[arg(short, long, default_value_t = false)]
+        force: bool,
+    },
+    /// remove a plugin
+    Remove {
+        /// plugin name
+        name: String,
+    },
+    /// search for plugins
+    Search {
+        /// search query
+        query: String,
+        /// number of results to show
+        #[arg(short, long, default_value_t = 10)]
+        limit: u32,
+    },
+    /// show plugin information
+    Info {
+        /// plugin name or project ID
+        name: String,
+    },
+    /// export current plugins to config file
+    Export {
+        /// output file path
+        #[arg(short, long, default_value = "plugins.json")]
+        output: String,
+    },
 }

src/cli.rs

@@ -4,11 +4,23 @@ use std::{fs, path::Path};
 
 const CONFIG_FILE: &str = "mcsast.config.json";
 
+#[derive(Serialize, Deserialize, Clone)]
+pub struct PluginConfig {
+    pub name: String,
+    pub project_id: String,
+    pub version: String,
+    pub source: String,
+    pub filename: String,
+    pub loader: String,
+}
+
 #[derive(Serialize, Deserialize)]
 pub struct Config {
     pub software: Software,
     pub minecraft_version: String,
     pub eula_accepted: bool,
+    #[serde(default)]
+    pub plugins: Vec<PluginConfig>,
 }
 
 impl Config {
@@ -31,4 +43,20 @@ impl Config {
     pub fn config_file() -> &'static str {
         CONFIG_FILE
     }
+
+    pub fn add_plugin(&mut self, plugin: PluginConfig) {
+        // Remove existing plugin with same name if exists
+        self.plugins.retain(|p| p.name != plugin.name);
+        self.plugins.push(plugin);
+    }
+
+    pub fn remove_plugin(&mut self, name: &str) -> bool {
+        let initial_len = self.plugins.len();
+        self.plugins.retain(|p| p.name != name);
+        self.plugins.len() != initial_len
+    }
+
+    pub fn get_plugin(&self, name: &str) -> Option<&PluginConfig> {
+        self.plugins.iter().find(|p| p.name == name)
+    }
 }

src/config.rs

@@ -8,10 +8,12 @@ mod cli;
 mod config;
 mod eula;
 mod get_files;
+mod modrinth;
+mod plugins;
 mod software;
 mod utils;
 
-use cli::{CLI, Commands};
+use cli::{CLI, Commands, PluginActions};
 use config::Config;
 use software::Software;
 use utils::{get_current_directory_name, get_executable_extension, inquired, print_error_and_exit};
@@ -167,6 +169,7 @@ fn handle_setup(
         software: software.clone(),
         minecraft_version: version.clone(),
         eula_accepted: eula,
+        plugins: Vec::new(),
     };
 
     match config.save() {
@@ -329,6 +332,19 @@ fn handle_upgrade(target_version: Option<String>) -> Result<(), Box<dyn std::err
     Ok(())
 }
 
+async fn handle_plugins(action: PluginActions) -> Result<(), Box<dyn std::error::Error>> {
+    match action {
+        PluginActions::List => plugins::list_plugins().await,
+        PluginActions::Add { name, force } => plugins::get_plugin(&name, force).await,
+        PluginActions::Load { config } => plugins::load_plugins_from_config(&config).await,
+        PluginActions::Update { target, force } => plugins::update_plugins(&target, force).await,
+        PluginActions::Remove { name } => plugins::remove_plugin(&name).await,
+        PluginActions::Search { query, limit } => plugins::search_plugins(&query, limit).await,
+        PluginActions::Info { name } => plugins::show_plugin_info(&name).await,
+        PluginActions::Export { output } => plugins::export_plugins_config(&output).await,
+    }
+}
+
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     let cli = CLI::parse();
 
@@ -341,5 +357,9 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
         } => handle_setup(software, mc_version, eula, yes),
         Commands::Update => handle_update(),
         Commands::Upgrade { version } => handle_upgrade(version),
+        Commands::Plugins { action } => {
+            let rt = tokio::runtime::Runtime::new()?;
+            rt.block_on(handle_plugins(action))
+        }
     }
 }