Added READMEs

Author: JayanAXHF

README.md

@@ -0,0 +1,109 @@
+# Modder-rs
+
+[![CI](https://github.com/jayansunil/modder/actions/workflows/rust.yml/badge.svg)](https://github.com/jayansunil/modder/actions/workflows/rust.yml)
+
+A simple, fast tool for managing Minecraft mods from the command line.
+
+Modder is a tool for managing mods for Minecraft. It can add mods from Modrinth, CurseForge, and Github Releases. Other features include bulk-updating a directory of mods to a specified version, listing detailed information about the mods in a directory, and toggling mods on or off without deleting the files.
+
+## Features
+
+- [x] Bulk-update a directory of mods
+- [x] Add mods via Modrinth
+- [ ] Add mods via CurseForge (implementation on hold)
+- [x] Add mods via Github Releases
+- [x] Toggle mods in a directory (enables/disables them by renaming the file extension)
+- [x] List mods with details like version, source, and category
+- [ ] Support for `modpacks`
+
+## Workspace Structure
+
+This repository is a cargo workspace containing two main crates:
+
+-   `core`: The primary crate that contains all the command-line logic, API wrappers, and file management code.
+-   `tui`: A work-in-progress crate for a Terminal User Interface (TUI) for `modder`.
+
+## Installation
+
+1.  Ensure you have Rust and Cargo installed.
+2.  Clone the repository:
+    ```sh
+    git clone https://github.com/jayansunil/modder.git
+    cd modder
+    ```
+3.  Install the binary:
+    ```sh
+    cargo install --path .
+    ```
+    This will install the `modder` binary in your cargo bin path.
+
+## Usage
+
+Modder provides several commands to manage your mods.
+
+### `add`
+
+Add a mod from Modrinth, CurseForge, or GitHub.
+
+```sh
+modder add <MOD_NAME> --version <GAME_VERSION> --loader <LOADER>
+```
+
+-   **Example (Modrinth):**
+    ```sh
+    modder add sodium --version 1.21 --loader fabric
+    ```
+-   **Example (GitHub):** If the mod is on GitHub, `modder` will infer it.
+    ```sh
+    modder add fabricmc/fabric-api --version 1.21
+    ```
+-   **Example (CurseForge):**
+    ```sh
+    modder add create --version 1.20.1 --loader forge --source curseforge
+    ```
+
+### `update`
+
+Bulk-update all mods in a directory to a specific game version.
+
+```sh
+modder update --dir ./mods --version <NEW_GAME_VERSION>
+```
+
+-   **Example:**
+    ```sh
+    modder update --dir ./mods --version 1.21 --delete-previous
+    ```
+
+### `list`
+
+List all mods in a directory with detailed information.
+
+```sh
+modder list [--dir ./mods] [--verbose]
+```
+
+-   **Example:**
+    ```sh
+    modder list --dir ./mods --verbose
+    ```
+
+### `toggle`
+
+Enable or disable mods in a directory interactively.
+
+```sh
+modder toggle [--dir ./mods]
+```
+
+### `quick-add`
+
+Interactively select from a list of popular mods to add.
+
+```sh
+modder quick-add --version <GAME_VERSION> --loader <LOADER>
+```
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](tui/LICENSE) file for details.

core/README.md

@@ -1,13 +1,32 @@
-# Modder-rs
+# Modder Core
 
-A simple, fast tool to make managing minecraft mods that much easier
+This crate contains the core business logic for the `modder` command-line tool. It handles interactions with modding APIs, file management, and the implementation of the CLI commands.
 
----
-# Features
-- [x] Bulk-Update a directory of mods
-- [x] Add mods via modrinth
-- [ ] Add mods via curseforge
+## Features
+
+- [x] Bulk-update a directory of mods
+- [x] Add mods via Modrinth
+- [x] Add mods via CurseForge
 - [x] Add mods via Github Releases
-- [x] Toggle Mods in a directory
-- [x] Edit the `minecraft/mods` directory
-- [ ] Support `modpacks`
+- [x] Toggle mods in a directory
+- [x] List mods with detailed information
+- [ ] Support for `modpacks`
+
+## Core Functionality
+
+The crate is structured into several key modules:
+
+-   **`modrinth_wrapper`**: Provides functions for interacting with the Modrinth API (`v2`), including searching for mods, fetching version information, and handling dependencies.
+-   **`curseforge_wrapper`**: Contains the logic for interacting with the CurseForge API. **Note: This implementation is currently on hold due to API complexity.**
+-   **`gh_releases`**: Handles fetching release information and downloading mod files from GitHub Repositories.
+-   **`actions`**: Implements the primary logic for each of the CLI subcommands (e.g., `add`, `update`, `list`).
+-   **`cli`**: Defines the command-line interface structure, arguments, and subcommands using the `clap` crate.
+-   **`metadata`**: Manages reading and writing custom metadata to mod JAR files. This is used to track the source of a mod (Modrinth, GitHub, etc.) for future updates.
+
+## Usage
+
+While this crate can be used as a library to build other Minecraft-related tools, its primary purpose is to serve as the engine for the `modder` binary. It is not intended for direct use by end-users.
+
+## License
+
+This project is licensed under the MIT License.

core/src/actions.rs

@@ -265,13 +265,12 @@ pub async fn run(cli: Cli) -> color_eyre::Result<()> {
                 Source::CurseForge => {
                     let api = CurseForgeAPI::new(API_KEY.to_string());
                     let dependencies = Arc::new(Mutex::new(Vec::new()));
-                    let mods = api.search_mods(&version, loader, &mod_).await.unwrap();
+                    let mods = api.search_mods(&version, loader, &mod_, 30).await.unwrap();
                     let prompt = inquire::MultiSelect::new("Select mods", mods);
                     let selected = prompt.prompt().unwrap();
                     let mut handles = Vec::new();
                     let dir = Arc::new(dir.clone());
                     for mod_ in selected {
-                        dbg!(&mod_.latest_files[0].file_fingerprint);
                         let dependencies = Arc::clone(&dependencies);
                         let version = version.clone();
                         let api = api.clone();

core/src/curseforge_wrapper/mod.rs

@@ -1,4 +1,3 @@
-//!WARN: ON HOLD for now because this API is tom-fucking-beaurocratic shit
 mod file_utils;
 mod hash;
 mod structs;
@@ -181,14 +180,47 @@ impl CurseForgeAPI {
         fs::write(&path, file_data.bytes().await?)?;
         Ok(())
     }
+    pub async fn get_version_from_file(&self, file: PathBuf) -> Result<File> {
+        let f = file.clone();
+        let f_name = f.file_name().unwrap().to_str().unwrap();
+        let contents = get_jar_contents(&file)?;
+        let fingerprint = MurmurHash2::hash(&contents);
+        let url = format!("{BASE_URL}/fingerprints/{GAME_ID}");
+        let mut headers = HEADERS.clone();
+        headers.insert(
+            HeaderName::from_static("content-type"),
+            HeaderValue::from_static("application/json"),
+        );
+        let body = json!({
+        "fingerprints": [
+            fingerprint
+        ]});
+        let body = serde_json::to_string(&body)?;
+        let response = self
+            .client
+            .request(Method::POST, Url::parse(&url)?)
+            .headers(headers)
+            .body(body)
+            .send()
+            .await?;
+        let response = response.error_for_status()?;
+        let body = response.text().await?;
+
+        let res: FingerprintResponseRoot = serde_json::from_str(&body)?;
+        let res = res.data;
+        if res.exact_matches.is_empty() {
+            return Err(CurseForgeError::NoFingerprintFound(f_name.to_string()));
+        }
+        let exact_match = res.exact_matches.first().unwrap();
+        let file = exact_match.file.clone();
+        Ok(file)
+    }
     pub async fn get_mod_from_file(&self, file: PathBuf) -> Result<Mod> {
         let f = file.clone();
         let f_name = f.file_name().unwrap().to_str().unwrap();
         let contents = get_jar_contents(&file)?;
         let fingerprint = MurmurHash2::hash(&contents);
-        dbg!(&fingerprint);
         let url = format!("{BASE_URL}/fingerprints/{GAME_ID}");
-        dbg!(&url);
         let mut headers = HEADERS.clone();
         headers.insert(
             HeaderName::from_static("content-type"),
@@ -208,8 +240,8 @@ impl CurseForgeAPI {
             .await?;
         let response = response.error_for_status()?;
         let body = response.text().await?;
-        dbg!(&body);
-        let res: FingerprintResponse = serde_json::from_str(&body)?;
+        let res: FingerprintResponseRoot = serde_json::from_str(&body)?;
+        let res = res.data;
         if res.exact_matches.is_empty() {
             return Err(CurseForgeError::NoFingerprintFound(f_name.to_string()));
         }
@@ -254,7 +286,10 @@ mod tests {
     async fn test_search_mods() {
         let api = CurseForgeAPI::new(API_KEY.to_string());
         let loader = ModLoader::Fabric;
-        let mods = api.search_mods("1.21.4", loader, "Carpet").await.unwrap();
+        let mods = api
+            .search_mods("1.21.4", loader, "Carpet", 10)
+            .await
+            .unwrap();
         assert_eq!(!mods.is_empty(), true);
     }
     #[tokio::test]
@@ -281,7 +316,7 @@ mod tests {
         let loader = ModLoader::Fabric;
         let v = "1.21.4";
         let api = CurseForgeAPI::new(API_KEY.to_string());
-        let mods = api.search_mods(v, loader, search).await.unwrap();
+        let mods = api.search_mods(v, loader, search, 10).await.unwrap();
         println!("{:#?}", mods);
         let prompt = inquire::MultiSelect::new("Select mods", mods);
         let selected = prompt.prompt().unwrap();
@@ -310,10 +345,13 @@ mod tests {
     async fn test_fingerprint_specific_jar() {
         color_eyre::install().unwrap();
         let api = CurseForgeAPI::new(API_KEY.to_string());
-        let jar_path =
-            PathBuf::from("/Users/jayansunil/Downloads/fabric-carpet-1.21.7-1.4.177+v250630.jar");
+        let jar_path = PathBuf::from(
+            "/Users/jayansunil/Dev/rust/modder/tui/test/createaddition-1.19.2-1.2.3.jar",
+        );
         let fingerprint = MurmurHash2::hash(&get_jar_contents(&jar_path).unwrap());
         dbg!(&fingerprint);
         // The fingerprint will be debug-printed by dbg!(&fingerprint) inside get_mod_from_file
+        let mod_ = api.get_mod_from_file(jar_path).await.unwrap();
+        assert_eq!(mod_.name, "CreateAddition");
     }
 }

core/src/curseforge_wrapper/structs.rs

@@ -213,6 +213,12 @@ pub struct ModBuilder {
     pub search: String,
 }
 
+#[derive(Debug, Deserialize, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct FingerprintResponseRoot {
+    pub data: FingerprintResponse,
+}
+
 #[derive(Debug, Deserialize, Clone)]
 #[serde(rename_all = "camelCase")]
 pub struct FingerprintResponse {
@@ -223,7 +229,7 @@ pub struct FingerprintResponse {
     pub partial_matches: Vec<PartialMatch>,
     pub partial_match_fingerprints: std::collections::HashMap<String, Vec<u32>>,
     pub installed_fingerprints: Vec<u32>,
-    pub unmatched_fingerprints: Vec<u32>,
+    pub unmatched_fingerprints: Option<Vec<u32>>,
 }
 
 #[derive(Debug, Deserialize, Clone)]

core/src/lib.rs

@@ -7,7 +7,7 @@ pub mod modrinth_wrapper;
 use clap::ValueEnum;
 use cli::Source;
 use color_eyre::Result;
-use color_eyre::eyre::{ContextCompat, bail};
+use color_eyre::eyre::bail;
 use curseforge_wrapper::{CurseForgeAPI, CurseForgeMod};
 use gh_releases::{Error, GHReleasesAPI};
 use hmac_sha512::Hash;

core/src/modrinth_wrapper/modrinth.rs

@@ -1,19 +1,15 @@
 #![allow(dead_code)]
-use crate::cli::Source;
-use crate::gh_releases::{self, GHReleasesAPI};
-use crate::metadata::{Error as MetadataError, Metadata};
+use crate::gh_releases::{self};
+use crate::metadata::Error as MetadataError;
 use crate::{Link, ModLoader, calc_sha512};
-use clap::ValueEnum;
-use color_eyre::eyre::{self, ContextCompat, bail, eyre};
+use color_eyre::eyre::{ContextCompat};
 use colored::Colorize;
 use futures::lock::Mutex;
 use itertools::Itertools;
 use serde::{Deserialize, Serialize};
-use std::path::PathBuf;
-use std::rc::Rc;
 use std::sync::Arc;
 use std::{fmt::Display, fs};
-use tracing::{self, debug, error, info, warn};
+use tracing::{self, debug, error, info};
 
 #[derive(thiserror::Error, Debug)]
 pub enum Error {

tui/src/components/add.rs

@@ -6,7 +6,7 @@ use futures::{executor::block_on, lock::Mutex};
 use modder::{
     MOD_LOADERS, ModLoader, calc_sha512,
     cli::{SOURCES, Source},
-    curseforge_wrapper::{CurseForgeAPI, CurseForgeError},
+    curseforge_wrapper::{API_KEY, CurseForgeAPI},
     gh_releases::{GHReleasesAPI, get_mod_from_release},
     metadata::Metadata,
     modrinth_wrapper::modrinth::{self, GetProject, Mod, Modrinth, VersionData},
@@ -1304,23 +1304,40 @@ async fn get_mods(dir: PathBuf) -> Vec<CurrentModsListItem> {
             let enabled = !path_str.contains("disabled");
             let version_data = VersionData::from_hash(hash).await;
             if version_data.is_err() {
-                let metadata = Metadata::get_all_metadata(path_str.clone().into());
-                if metadata.is_err() {
-                    error!(version_data = ?version_data, "Failed to get version data for {}", path_str);
-                    return None;
+                debug!(path = ?path);
+                let cf = CurseForgeAPI::new(API_KEY.to_string());
+                let mod_ = cf.get_mod_from_file(path.clone()).await;
+                if mod_.is_err() {
+                    debug!(path = ?path);
+                    let metadata = Metadata::get_all_metadata(path_str.clone().into());
+                    if metadata.is_err() {
+                        error!(version_data = ?version_data, "Failed to get version data for {}", path_str);
+                        return None;
+                    }
+                    let metadata = metadata.unwrap();
+                    let source = metadata.get("source").unwrap();
+                    if source.is_empty() {
+                        error!(version_data = ?version_data, "Failed to get version data for {}", path_str);
+                        return None;
+                    }
+                    let repo = metadata.get("repo").unwrap();
+                    let repo_name = repo.split('/').last().unwrap();
+                    let out = CurrentModsListItem {
+                        name: repo_name.to_string(),
+                        version_type: "GITHUB".to_string(),
+                        project_id: repo.to_string(),
+                        enabled,
+                    };
+                    return Some(out);
                 }
-                let metadata = metadata.unwrap();
-                let source = metadata.get("source").unwrap();
-                if source.is_empty() {
-                    error!(version_data = ?version_data, "Failed to get version data for {}", path_str);
+                let Ok(mod_) = mod_ else {
                     return None;
-                }
-                let repo = metadata.get("repo").unwrap();
-                let repo_name = repo.split('/').last().unwrap();
+                };
+                debug!(mod_curseforge = ?mod_);
                 let out = CurrentModsListItem {
-                    name: repo_name.to_string(),
-                    version_type: "GITHUB".to_string(),
-                    project_id: repo_name.to_string(),
+                    name: mod_.name,
+                    version_type: "RELEASE".to_string(),
+                    project_id: mod_.slug,
                     enabled,
                 };
                 return Some(out);

tui/src/components/home.rs

@@ -78,7 +78,7 @@ impl MenuList {
 impl Home {
     pub fn new() -> Self {
         Home {
-            list: MenuList::from_iter(vec![Mode::Add, Mode::QuickAdd, Mode::Toggle, Mode::List]),
+            list: MenuList::from_iter(vec![Mode::Add, Mode::Toggle, Mode::List]),
             mode: Mode::Home,
             enabled: true,
             ..Default::default()