mirror of
https://github.com/Omni-guides/Jackify.git
synced 2026-01-17 11:37:01 +01:00
feat: prepare for public release - updated README, added assets, and migration content
- Updated README with banner, navigation, disclaimer, and future features - Added assets/images directory structure for repository images - Added JackifyWikiUserGuide.md for wiki content - Updated installation instructions for 7z archive distribution - Added comprehensive future planned features section - Prepared content for GitHub migration and Nexus Mods release
This commit is contained in:
51
README.md
51
README.md
@@ -1,9 +1,31 @@
|
||||

|
||||
|
||||
| [Wiki](https://github.com/Omni-guides/Jackify/wiki) | [Download](https://www.nexusmods.com/site/mods/xxx) | [Wabbajack Discord](https://discord.gg/wabbajack) | [Jackify Issues](https://github.com/Omni-guides/Jackify/issues) | [Legacy Guides](Legacy/) | [Ko-fi](https://ko-fi.com/omni1) |
|
||||
|:---:|:---:|:---:|:---:|:---:|:---:|
|
||||
|
||||
---
|
||||
|
||||
|
||||
# Jackify
|
||||
A modlist installer and manager for Wabbajack modlists on Linux
|
||||
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.
|
||||
|
||||
### **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. Currently, there are two main functions that Jackify will perform at this stage of development:
|
||||
@@ -19,6 +41,16 @@ Jackify is an almost Linux-native application written in Python, with a GUI prod
|
||||
- Automated Steam Integration: Automatic Steam shortcut creation with complete Proton configuration
|
||||
- Professional Interface: Both GUI and CLI interfaces with identical features
|
||||
|
||||
## Disclaimer
|
||||
|
||||
**Jackify is a hobby project in early Alpha development stage. Use at your own risk.**
|
||||
|
||||
- **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
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Requirements
|
||||
@@ -30,8 +62,8 @@ Jackify is an almost Linux-native application written in Python, with a GUI prod
|
||||
### Installation
|
||||
|
||||
```bash
|
||||
# Download latest release
|
||||
wget https://github.com/your-repo/jackify/releases/latest/Jackify.AppImage
|
||||
# Download latest release from Nexus Mods
|
||||
# Extract the Jackify.AppImage from the 7z archive
|
||||
chmod +x Jackify.AppImage
|
||||
./Jackify.AppImage
|
||||
```
|
||||
@@ -85,6 +117,17 @@ This project is licensed under the GPLv3 License - see the LICENSE file for deta
|
||||
## 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)
|
||||
|
||||
- Continue to expand the supported games list for fully automated configuration
|
||||
- Add full TTW+Modlist automation for TTW based modlists
|
||||
- Replace the API Key requirement with a more secure OAuth based approach
|
||||
- Add support for modding and modlist creation tools via a sister application or module
|
||||
- Revise the GUI to be more refined
|
||||
- Dark/Light theme support for the GUI
|
||||
- Advanced logging and diagnostics - more detailed troubleshooting information
|
||||
- Automatic dependency resolution - ensure all required tools and libraries are installed
|
||||
|
||||
## Support
|
||||
- Issues: Report bugs and request features via GitHub Issues
|
||||
- Documentation: See the Wiki for detailed guides
|
||||
@@ -97,4 +140,4 @@ At this early stage of development, where basic functionality is the primary foc
|
||||
|
||||
---
|
||||
|
||||
**Jackify** - Bringing Wabbajack modlist management to Linux
|
||||
**Jackify** - Simplifying Wabbajack modlist installation and configuration on Linux
|
||||
Reference in New Issue
Block a user