noctra/Jackify
1
0
Fork 0
mirror of https://github.com/Omni-guides/Jackify.git synced 2026-06-07 21:37:45 +02:00
Code Issues Packages Projects Releases Wiki Activity

Revise README for clarity and updated features

Browse Source 
Updated project description and features in README.
This commit is contained in:
Omni-guides
2026-02-24 13:41:18 +00:00
committed by GitHub
parent 69738e8e9e
commit 9cc5245db7
1 changed files with 64 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

171
README.md
View File

@@ -2,162 +2,119 @@
<div align="center"> <div align="center">
[Wiki](https://github.com/Omni-guides/Jackify/wiki) | [Nexus](https://www.nexusmods.com/site/mods/1427) | [Download](https://www.nexusmods.com/site/mods/1427?tab=files) | [Wabbajack Discord](https://discord.gg/wabbajack) | [Jackify Issues](https://github.com/Omni-guides/Jackify/issues) | [Legacy Guides](https://github.com/Omni-guides/Jackify/tree/master/Legacy) | [Ko-fi](https://ko-fi.com/omni1) [Wiki](https://github.com/Omni-guides/Jackify/wiki) | [Nexus](https://www.nexusmods.com/site/mods/1427) | [Download](https://www.nexusmods.com/site/mods/1427?tab=files) | [Wabbajack Discord](https://discord.gg/wabbajack) | [Jackify Issues](https://github.com/Omni-guides/Jackify/issues) | [Ko-fi](https://ko-fi.com/omni1)
</div> </div>
--- ---
# Jackify # Jackify
A modlist installation and configuration tool for Wabbajack modlists on Linux
Jackify enables seamless installation and configuration of Wabbajack modlists on Linux systems, providing automated Steam shortcut creation and Proton prefix configuration. Jackify is a Linux application for installing and configuring Wabbajack modlists on Linux and Steam Deck. It provides a complete end-to-end workflow — downloading, installing, Steam shortcut creation, Proton prefix setup, and post-install configuration — through both a GUI and a full-featured CLI.
### **Repository Migration Notice**
This repository has evolved from the original [Wabbajack-Modlist-Linux](https://github.com/Omni-guides/Wabbajack-Modlist-Linux) guides and bash scripts into **Jackify** - a comprehensive Linux application for Wabbajack modlist management.
**What changed?**
- **From**: Semi-automated bash scripts and step-by-step wiki guides
- **To**: A complete, automated Linux application with GUI and CLI interfaces
- **Why**: To provide a user-friendly application that removes the complexity of Wabbajack and modlist configuration
**Previous Content**: All original guides and scripts are preserved in the `Legacy/` directory. Jackify provides the same functionality with significantly improved automation and user experience.
---
## 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.
**Important Notes for Alpha Users:**
- This is the first alpha release - there WILL be bugs and issues that need to be resolved
- I am not a UI developer, so the current interface is functional but not polished
- Please report any issues you encounter to help improve the application
**Prefer Manual Installation?** If you'd rather use the proven bash scripts and manual guides that have been tested over many months, see the [Legacy Guides](https://github.com/Omni-guides/Jackify/wiki/Legacy-Wiki-Home) for the old installation methods.
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.
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD)
## Features ## Features
- 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 - **Complete Modlist Workflow**: Install from scratch with Nexus Premium, configure a pre-downloaded modlist, or reconfigure an existing modlist already in Steam
- Comprehensive Modlist Support: Support for Skyrim, Fallout 4, Fallout New Vegas, Oblivion, Starfield, Enderal and more - **Game Support**: Skyrim, Fallout 4, Fallout New Vegas, Oblivion, Starfield, Enderal, and more
- Automated Steam Integration: Automatic Steam shortcut creation with complete Proton configuration - **Automated Steam Integration**: Steam shortcut creation with full Proton configuration
- Professional Interface: Both GUI and CLI interfaces with identical features - **GUI and CLI**: Both interfaces provide identical functionality
## Disclaimer ## Disclaimer
**Jackify is a hobby project in early Alpha development stage. Use at your own risk.** **Jackify is a hobby project in early Alpha development. Use at your own risk.**
- **No Warranty**: This software is provided "as is" without any warranty or guarantee of functionality - **No Warranty**: This software is provided "as is" without any warranty or guarantee of functionality
- **Best Effort Support**: Support is provided on a best-effort basis through community channels
- **System Compatibility**: Functionality on your specific system is not guaranteed
- **Data Safety**: Always backup your important data before using Jackify
- **Alpha Software**: Features may be incomplete, unstable, or change without notice - **Alpha Software**: Features may be incomplete, unstable, or change without notice
- **Best Effort Support**: Support is provided on a best-effort basis through community channels
- **Data Safety**: Always back up your important data before using Jackify
- **System Compatibility**: Functionality on your specific system is not guaranteed
- **A successful installation does not guarantee a working modlist**: Linux introduces hardware, driver, and system-specific variables that cannot be accounted for. If your modlist installs successfully but does not run correctly, seek help in [#unofficial-linux-help](https://discord.gg/wabbajack) on the Wabbajack Discord — do not contact the modlist author unless they explicitly support Linux
- **Not all modlists can be fully automated**: Some modlists (e.g. Fallout New Vegas lists) require manual steps that Jackify cannot automate (or I have not automated yet). Always check the Install Guide of the Modlist itself to see what could be needed.
- **Most Modlists are not officially supported on Linux**: Jackify makes a best effort to get modlists running, but compatibility is not guaranteed and will vary between modlists, hardware, and system configuration
## Quick Start ## Requirements
### Requirements - Linux system (most modern distributions will work)
- Steam installed and configured
- Linux system (Most modern distributions supported) - **Protontricks** — required for modlist configuration
- Python 3.8+ installed - See [Installing Additional Tools](https://github.com/Omni-guides/Jackify/wiki/Installing-Additional-Tools#installing-protontricks)
- Steam installed and configured, Proton Experimental available - **GE-Proton 10-14** — While other Proton versions may work, GE-Proton 10-14 is highly recommended for ENB compatibility
- See [Installing Additional Tools](https://github.com/Omni-guides/Jackify/wiki/Installing-Additional-Tools#installing-ge-proton)
- **Nexus Mods Premium subscription** (required for automated downloads) - **Nexus Mods Premium subscription** (required for automated downloads)
- Non-premium support planned for future releases - See [Installing a Modlist with Jackify](https://github.com/Omni-guides/Jackify/wiki/Installing-a-Modlist-with-Jackify) for the full automated workflow
- **FUSE** (required for AppImage execution) - Non-Premium users can still install modlists via Wabbajack under Proton — see [Installing a Modlist with Wabbajack](https://github.com/Omni-guides/Jackify/wiki/Installing-a-Modlist-with-Wabbajack)
- Pre-installed on most Linux distributions - Native non-premium support planned for a future release
- If AppImage fails to run, install FUSE using your distribution's package manager - **FUSE** (required for AppImage execution, pre-installed on most distributions)
- **Ubuntu/Debian only**: Qt platform plugin library - **Ubuntu/Debian-based distros only** (Ubuntu, Kubuntu, Linux Mint, Pop!_OS, Zorin OS, elementary OS, and others): Qt platform plugin library
- `sudo apt install libxcb-cursor-dev` - `sudo apt install libxcb-cursor-dev`
- Required for Qt GUI to initialize properly
### Installation ## Installation Quick Start
1. Download the latest release from [Nexus Mods](https://www.nexusmods.com/site/mods/1427?tab=files)
2. Extract the AppImage from the 7z archive
3. Make it executable and run:
```bash ```bash
# Download latest release from Nexus Mods
# Extract the Jackify.AppImage from the 7z archive
chmod +x Jackify.AppImage chmod +x Jackify.AppImage
./Jackify.AppImage ./Jackify.AppImage
``` ```
## Usage For CLI mode: `./Jackify.AppImage --cli`
For a complete step-by-step guide with screenshots, see the [User Guide](https://github.com/Omni-guides/Jackify/wiki/User-Guide). For a full step-by-step guide with screenshots, see the [User Guide](https://github.com/Omni-guides/Jackify/wiki/User-Guide).
### Quick Start
1. **Download**: Get the latest release from [NexusMods](https://www.nexusmods.com/site/mods/1427?tab=files)
2. **Extract**: Unzip the .7z archive to get `Jackify.AppImage`
3. **Run**: `chmod +x Jackify.AppImage && ./Jackify.AppImage`
4. **Install**: Choose "Install a Modlist", select your game and modlist, configure directories and API key
**CLI Mode**: Run `./Jackify.AppImage --cli` for command-line interface
## Supported Games ## Supported Games
- Skyrim Special Edition - Skyrim Special Edition
- Fallout 4 - Fallout 4
- Fallout New Vegas - Fallout New Vegas
- Oblivion - Oblivion
- Starfield - Starfield
- Enderal - Enderal
- Other Games (Cyberpunk 2077, Baldur's Gate 3, and more - Download and Install only for now) - Other games (Cyberpunk 2077, Baldur's Gate 3, and more — download and install support only for now - full automatioin coming in the future)
## Architecture ## Architecture
Jackify follows a clean separation between frontend and backend: Jackify follows a clean separation between frontend and backend:
- Backend Services: Pure business logic with no UI dependencies - **Backend Services**: Pure business logic with no UI dependencies
- Frontend Interfaces: CLI and GUI implementations using shared backend - **Frontend Interfaces**: CLI and GUI implementations sharing the same backend
- Native Engine: Powered by jackify-engine (custom fork of wabbajack-cli.exe) for optimal performance and compatibility - **Native Engine**: Powered by jackify-engine (custom fork of wabbajack-cli) for optimal Linux performance and compatibility. Texconv for hash-matched texture conversion requires Proton.
- Steam Integration: Direct Steam shortcuts.vdf manipulation for creating and modifying Steam shortcuts - **Steam Integration**: Direct Steam shortcuts.vdf manipulation for shortcut creation and management
## Configuration All Jackify relted files and configuration data is are stored in `~/Jackify/` (Jackify) and `~/.config/jackify/`.
Configuration files are stored in:
- Jackify Related: ~/Jackify/
- jackify-engine config: ~/.config/jackify/
## Development
Development and contribution guidelines coming soon.
## License
This project is licensed under the GPLv3 License - see the LICENSE file for details.
## Contributing ## Contributing
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.
## Future Planned Features (not guaranteed) At this early stage of development, I'd prefer GitHub Issues for bug reports and suggestions rather than PRs. This will likely change as the project matures. See the CONTRIBUTING document for more details.
- Continue to expand the supported games list for fully automated configuration ## Future Plans (not guaranteed)
- Add full TTW+Modlist automation for TTW based modlists
- Replace the API Key requirement with a more secure OAuth based approach - Continue to expand supported games for fully automated configuration
- Add support for modding and modlist creation tools via a sister application or module - Non-Premium / manual download support
- Revise the GUI to be more refined - GUI refinements
- Dark/Light theme support for the GUI - Dark/Light theme support
- Advanced logging and diagnostics - more detailed troubleshooting information
- Automatic dependency resolution - ensure all required tools and libraries are installed ## Legacy Guides
The original bash scripts and step-by-step manual installation guides are preserved in the [Legacy Guides](https://github.com/Omni-guides/Jackify/wiki/Legacy-Wiki-Home) for those who prefer them or need a fallback.
## License
This project is licensed under the GPLv3 License — see the LICENSE file for details.
## Support ## Support
- Issues: Report bugs and request features via GitHub Issues
- Documentation: See the Wiki for detailed guides - **Bugs and feature requests**: [GitHub Issues](https://github.com/Omni-guides/Jackify/issues)
- Community: Join the community in the #unofficial-linux-help channel of the Official Wabbajack discord server - https://discord.gg/wabbajack - **Documentation**: [Wiki](https://github.com/Omni-guides/Jackify/wiki)
- **Community**: [#unofficial-linux-help](https://discord.gg/wabbajack) on the Wabbajack Discord
## Acknowledgments ## Acknowledgments
- Wabbajack team for the modlist ecosystem, and wabbajack-cli.exe
- Wabbajack team for the modlist ecosystem and wabbajack-cli
- Linux and Steam Deck gaming communities - Linux and Steam Deck gaming communities
- Modlist Authors for their tireless effort in creating modlists in the first place - Modlist authors for their tireless work
--- ---
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD) [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D8H8WBD)
**Jackify** - Simplifying Wabbajack modlist installation and configuration on Linux