diff --git a/Config.cs b/Config.cs new file mode 100644 index 0000000..c1c5435 --- /dev/null +++ b/Config.cs @@ -0,0 +1,18 @@ +namespace S2PK; + +public class Config +{ + public string Destination { get; set; } = string.Empty; + + /// + /// Loads the configuration from the specified file path. + /// + /// The path to the configuration file. + /// The loaded configuration. + public static Config Load(string path) + { + var file = File.ReadAllText(path); + var config = Toml.ToModel(file); + return config; + } +} diff --git a/GlobalUsing.cs b/GlobalUsing.cs new file mode 100644 index 0000000..800695e --- /dev/null +++ b/GlobalUsing.cs @@ -0,0 +1,2 @@ +global using S2PK; +global using Tomlyn; diff --git a/PackageManger.cs b/PackageManger.cs index 38d2ab5..bd44614 100644 --- a/PackageManger.cs +++ b/PackageManger.cs @@ -1,4 +1,4 @@ -namespace S2Pkg; +namespace S2PK; using System.IO.Compression; @@ -7,6 +7,11 @@ public static class PackageManager const string PackageExtension = ".package"; const string S2pkExtension = ".s2pk"; + /// + /// Packs a directory into a package file. + /// + /// The source directory. + /// The output package file. public static void PackPackages(string source, string output) { var dir = new DirectoryInfo(source); @@ -36,8 +41,19 @@ public static class PackageManager Console.WriteLine($"Created {file.FullName} with {packageFiles.Length} files."); } - public static void UnpackPackages(string package, string destination) + /// + /// Unpacks a package file into a destination directory. + /// + /// The path to the package file. + /// The destination directory. If not provided, the destination is read from the configuration file. + public static void UnpackPackages(string package, string destination = "") { + if (string.IsNullOrEmpty(destination)) + { + var config = Config.Load("s2pk.toml"); // TODO: Config file should be in application directory + destination = config.Destination; + } + var file = new FileInfo(package); var dir = new DirectoryInfo(destination); diff --git a/Program.cs b/Program.cs index 307e2e7..ba595e0 100644 --- a/Program.cs +++ b/Program.cs @@ -1,4 +1,3 @@ -using S2Pkg; using System.CommandLine; var rootCommand = new RootCommand("The Sims 2 .s2pk Package Manager"); @@ -32,8 +31,7 @@ var packageOption = new Option( var destinationOption = new Option( aliases: ["--destination", "-d"], - description: "Destination directory (e.g., The Sims 2 Downloads folder)") -{ IsRequired = true }; + description: "Destination directory (e.g., The Sims 2 Downloads folder)"); // Unpack command var unpackCommand = new Command("unpack", "Unpacks a .s2pk archive to the Downloads folder") diff --git a/README.md b/README.md index 91afc5d..283c864 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,26 @@ S2PK, or Sims 2 Package Manager, aims to provide a simple cross-platform solution to package management. -## πŸ’‘ Why This Exists +## ❓ Why This Exists -S2PK was created to address the need for a reliable and efficient cross-platform package management system for The Sims 2 on Linux and macOS. Players on these platforms often face challenges in managing mods due to the lack of a unified solution that their Windows counterparts solved a long time ago. +While The Sims 2 runs well on Linux through Wine, especially with Lutris setups, and natively from macOS, only the Windows community had varies mod managers and installers compared to their cross-platform counterparts. Later installments addressed this dilemma, but TS2 never got that treatment. + +``s2pk`` aims to fill this gap: a no-nonsense CLI utility for packaging, sharing, and managing mods across all platforms. It’s small, clean, and plays nicely with scripts, backups, and version control. In theory, it would be possible to use it on legacy front ends. ## πŸ›£οΈ Project Roadmap | Phase | Goal | Status | | ----- | ------------------------------------------- | ------ | -| v0.1 | Core package manager | βœ… | +| v0.1 | Core package manager | βœ… | | v0.2 | Config file with default destination | πŸ”œ | | v0.x | Target .NET 10 | πŸ”œ | | v1.0 | Stable "Release" version with documentation | πŸ”œ | +## 🎯 Stretch Goals + +- [ ] Manifest validation +- [ ] ``s1pk`` soft fork + ## 🧩 Tech Stack - .NET 8.0 @@ -22,7 +29,28 @@ S2PK was created to address the need for a reliable and efficient cross-platform - System.CommandLine for CLI parsing (no external libraries) - Pure backend logic (no UI planned) -## Example +## πŸ“ Design Principles + +- Stay true to UNIX design philosophy +- Simple with no bloat or feature creep +- Portable and clean + +## πŸ› οΈ Installation + +You can build yourself with ``make``, or use the installer script: + +```shell +./install.sh ./dist/s2pk-linux/s2pkg +``` + +Make sure ``~/.local/bin`` is in your ``PATH``: + +```shell +echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc +source ~/.bashrc +``` + +## πŸ—œοΈ Usage ```shell s2pk pack -s ./mods -o output.s2pk diff --git a/S2PK.csproj b/S2PK.csproj index 48a4c19..e970283 100644 --- a/S2PK.csproj +++ b/S2PK.csproj @@ -13,8 +13,8 @@ - + diff --git a/install.sh b/install.sh new file mode 100644 index 0000000..20a5fda --- /dev/null +++ b/install.sh @@ -0,0 +1,27 @@ +#!/bin/bash + +# Install s2pkg locally for current user (no sudo) +# Usage: ./install.sh ./dist/s2pkg-linux/s2pkg + +set -e + +SOURCE_BIN="$1" +INSTALL_DIR="$HOME/.local/bin" +TARGET="$INSTALL_DIR/s2pkg" + +if [[ ! -x "$SOURCE_BIN" ]]; then + echo "❌ Error: Provide a valid built s2pkg binary as the first argument." + exit 1 +fi + +mkdir -p "$INSTALL_DIR" +cp "$SOURCE_BIN" "$TARGET" +chmod +x "$TARGET" + +if [[ ":$PATH:" != *":$INSTALL_DIR:"* ]]; then + echo "⚠️ $INSTALL_DIR is not in your PATH. Consider adding this to your shell profile:" + echo " export PATH=\"\$HOME/.local/bin:\$PATH\"" +else + echo "βœ… Installed s2pkg to $TARGET" + echo "Run 's2pkg --help' to get started." +fi