noctra/Jackify
1
0
Fork 0
mirror of https://github.com/Omni-guides/Jackify.git synced 2026-01-17 11:37:01 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md with proper markdown formatting

Browse Source 
- Restored professional markdown formatting (headers, bullets, code blocks)
- Maintained AppImage-focused installation instructions
- Added clear warning discouraging source installation
- Professional structure and presentation for public release
This commit is contained in:
Omni
2025-09-07 21:51:51 +01:00
parent af7685dd21
commit f143e033b4
1 changed files with 53 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
README.md
View File

@@ -1,37 +1,53 @@
# Jackify
**Native Linux modlist installer and manager for Wabbajack modlists**
**A Linux-First modlist installer and manager for Wabbajack modlists**
Jackify enables seamless installation and configuration of Wabbajack modlists on Linux systems, providing automated Steam integration and Proton prefix management without requiring Windows dependencies.
Jackify enables seamless installation and configuration of Wabbajack modlists on Linux systems, providing automated Steam shortcut creation and Proton prefix configuration.
## Introduction
Thank you for your interest in Jackify - the next step, and a giant leap forward from my automated Wabbajack and modlist post-install scripts. So, Jackify - What is it?
Jackify is an almost Linux-native application written in Python, with a GUI produced with PySide6, and a full featured CLI interface if preferred. More info on the "almost" can be found in the full Introduction Wiki page. Currently, there are two main functions that Jackify will perform at this stage of development:
- Install Wabbajack modlists using jackify-engine (more on jackify-engine in the full Introduction wiki linked above).
- Fully automate the configuration of the Steam shortcut, modlist paths, prefix components, launch options and various other tweaks required to run Wabbajack Modlists on Linux.
- With both of the above combined, Jackify provides an end-to-end modlist installation and configuration process, automatically.
## Features
- **Native Linux Support**: Pure Linux implementation with no Wine/Windows dependencies for core operations
- **Automated Steam Integration**: Automatic Steam shortcut creation with proper Proton configuration
- **Comprehensive Modlist Support**: Support for Skyrim, Fallout 4, Fallout New Vegas, Oblivion, Starfield, and more
- **Professional Interface**: Both CLI and GUI interfaces with enhanced modlist selection and metadata display
- **Steam Deck Optimized**: Full Steam Deck support with controller-friendly interface
- **Advanced Filtering**: Smart categorization with NSFW filtering and game-specific organization
- **Linux-First Python Application**: Designed specifically for Linux with minimal external dependencies
- **Complete Modlist Workflow**: Install from scratch, configure pre-downloaded modlists, or reconfigure existing modlists installations in Steam
- **Comprehensive Modlist Support**: Support for Skyrim, Fallout 4, Fallout New Vegas, Oblivion, Starfield, Enderal and more
- **Automated Steam Integration**: Automatic Steam shortcut creation with complete Proton configuration
- **Professional Interface**: Both GUI and CLI interfaces with identical features
## Quick Start
### Requirements
- Linux system (Steam Deck supported)
- Steam installed and configured
#### For AppImage (Recommended)
- Linux system (Most modern distributions supported)
- Steam installed and configured, Proton Experimental available
- Python 3.10+ (built for Ubuntu 22.04 LTS compatibility)
#### For Source Installation
- Linux system (Most modern distributions supported)
- Steam installed and configured, Proton Experimental available
- Python 3.8+ (for source installation)
### Installation
#### AppImage (Recommended)
#### Recommended: Download AppImage (Easy!)
```bash
# Download latest release
wget https://github.com/your-repo/jackify/releases/latest/jackify.AppImage
chmod +x jackify.AppImage
./jackify.AppImage
wget https://github.com/your-repo/jackify/releases/latest/Jackify.AppImage
chmod +x Jackify.AppImage
./Jackify.AppImage
```
#### From Source
#### Advanced: From Source (Not Recommended)
> **Note**: We strongly recommend using the AppImage above. Source installation is for developers only.
```bash
git clone https://github.com/your-repo/jackify.git
cd jackify/src
@@ -43,28 +59,28 @@ python -m jackify.frontends.cli # CLI mode
## Usage
### GUI Mode
Launch the GUI and navigate through the intuitive interface:
1. Select "Modlist Tasks" → "Install a Modlist"
Launch the GUI AppImage as above, then navigate through the interface:
1. Select "Modlist Tasks" → "Install a Modlist" (or your desired option)
2. Choose your game type and modlist
3. Configure installation and download directories
4. Enter your Nexus API key
3. Set the installation and download directories
4. Enter your Nexus API key and select your resolution
5. Let Jackify handle the rest
### CLI Mode
```bash
python -m jackify.frontends.cli
./Jackify.AppImage --cli
```
Follow the interactive prompts to configure and install modlists.
## Supported Games
- **Skyrim Special Edition** (88+ modlists)
- **Fallout 4** (22+ modlists)
- **Fallout New Vegas** (13+ modlists)
- **Skyrim Special Edition**
- **Fallout 4**
- **Fallout New Vegas**
- **Oblivion**
- **Starfield**
- **Enderal**
- **Other Games** (Cyberpunk 2077, Baldur's Gate 3, and more)
- **Other Games** (Cyberpunk 2077, Baldur's Gate 3, and more - Download and Install only for now)
## Architecture
@@ -72,49 +88,39 @@ Jackify follows a clean separation between frontend and backend:
- **Backend Services**: Pure business logic with no UI dependencies
- **Frontend Interfaces**: CLI and GUI implementations using shared backend
- **Native Engine**: Powered by jackify-engine for optimal performance
- **Steam Integration**: Direct Steam shortcuts.vdf manipulation
- **Native Engine**: Powered by jackify-engine (custom fork of wabbajack-cli.exe) for optimal performance and compatibility
- **Steam Integration**: Direct Steam shortcuts.vdf manipulation for creating and modifying Steam shortcuts
## Configuration
Configuration files are stored in:
- **Linux**: `~/.config/jackify/`
- **Steam Deck**: `~/.config/jackify/`
- **Jackify Related**: `~/Jackify/`
- **jackify-engine config**: `~/.config/jackify/`
## Development
### Building from Source
```bash
cd src
pip install -r requirements-packaging.txt
pyinstaller jackify.spec
```
### Running Tests
```bash
python -m pytest tests/
```
*Development and contribution guidelines coming soon.*
## License
This project is licensed under the MIT License - see the LICENSE file for details.
This project is licensed under the GPLv3 License - see the LICENSE file for details.
## Contributing
Contributions are welcome! Please read our contributing guidelines and submit pull requests for any improvements.
At this early stage of development, where basic functionality is the primary focus, I'd prefer to use GitHub Issues to suggest improvements, rather tha PRs. This will likely change in the future.
## Support
- **Issues**: Report bugs and request features via GitHub Issues
- **Documentation**: See the Wiki for detailed guides
- **Community**: Join our community discussions
- **Community**: Join the community in the #unofficial-linux-help channel of the Official Wabbajack discord server - https://discord.gg/wabbajack
## Acknowledgments
- Wabbajack team for the modlist ecosystem
- jackify-engine developers
- Steam Deck and Linux gaming community
- Wabbajack team for the modlist ecosystem, and wabbajack-cli.exe
- Linux and Steam Deck gaming communities
- Modlist Authors for their tireless effort in creating modlists in the first place
---
**Jackify** - Bringing professional modlist management to Linux
**Jackify** - Bringing Wabbajack modlist management to Linux