tonytins/s2pk
1
0
Fork 0
mirror of https://github.com/tonytins/s2pk.git synced 2025-05-19 15:33:17 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated roadmap

Browse source
This commit is contained in:
Tony Bark 2025-04-30 09:42:30 -04:00
parent 18a0e73a91
commit b060f1de5e
2 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -6,27 +6,28 @@ S2PK, or Sims 2 Package Manager, aims to provide a simple cross-platform solutio
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. 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. `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.
## 🚀 Features ## 🚀 Features
- First-class CLI support for modders on non-Windows platforms - First-class CLI support for modders on non-Windows platforms
- Custom default unpacking directory for The Sims 2 & 3 - Custom default unpacking directory for The Sims 2 & 3
- Pack ``.packages`` into portable ``.s2pk`` archives - Pack `.packages` into portable `.s2pk` archives
## 🛣️ Project Roadmap ## 🛣️ Project Roadmap
| Phase | Goal | Status | | Phase | Goal | Status |
| ----- | ------------------------------------------- | ------ | | ----- | ------------------------------------------- | ------ |
| v0.1 | Core package manager | ✅ | | v0.1 | Core package manager | ✅ |
| v0.2 | Config file with default destination | 🔜 | | v0.2 | Config file with default paths | ✅ |
| v0.3 | Sims 3 support with `s3pk` extention | 🔜 |
| v0.x | Target .NET 10 | 🔜 | | v0.x | Target .NET 10 | 🔜 |
| v1.0 | Stable "Release" version with documentation | 🔜 | | v1.0 | Stable "Release" version with documentation | 🔜 |
## 🎯 Stretch Goals ## 🎯 Stretch Goals
- [ ] Manifest validation - [ ] Manifest validation
- [ ] ``s1pk`` soft fork - [ ] `s1pk` soft fork
## 🧩 Tech Stack ## 🧩 Tech Stack
@ -43,13 +44,13 @@ While The Sims 2 runs well on Linux through Wine, especially with Lutris setups,
## 🛠️ Installation ## 🛠️ Installation
You can build yourself with ``make``, or use the installer script: You can build yourself with `make`, or use the installer script:
```shell ```shell
./install.sh ./dist/s2pk-linux/s2pkg ./install.sh ./dist/s2pk-linux/s2pkg
``` ```
Make sure ``~/.local/bin`` is in your ``PATH``: Make sure `~/.local/bin` is in your `PATH`:
```shell ```shell
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc

2
S2PK.csproj
View file

@ -3,7 +3,7 @@
<PropertyGroup> <PropertyGroup>
<OutputType>Exe</OutputType> <OutputType>Exe</OutputType>
<TargetFramework>net8.0</TargetFramework> <TargetFramework>net8.0</TargetFramework>
<Version>0.2.101</Version> <Version>0.3.101</Version>
<ImplicitUsings>enable</ImplicitUsings> <ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable> <Nullable>enable</Nullable>
<Authors>Tony Bark</Authors> <Authors>Tony Bark</Authors>