Wabbajack

https://wiki.wabbajack.org
Admin
Wabbajack is an automated Modlist installer that streamlines sharing and installing modded game...
Tokens:11,018
Snippets:159
Trust Score:8.1
Update:5 months ago
Show doc for...
Tokens:
Raw
### Create .compiler_settings File for Native Wabbajack Installer

Source: https://wiki.wabbajack.org/modlist_author_documentation/Native-Game-Installer%20-%20%28Installers%20not%20using%20MO2%29.html

This JSON configuration file is essential for setting up a native Wabbajack compilation. It defines various parameters for the modlist, including source and download paths, game information, and metadata. Ensure paths are correctly set for your specific setup.

```json
{
    "ModlistIsNSFW": false,
    "Source": "F:\\Wabbajack Modlists Maintenance\\Dishonored 1.1",
    "Downloads": "E:\\Wabbajack Modlist Maintenance\\.Download Folders\\Dishonored",
    "Game": "Dishonored",
    "OutputFile": "F:\\Wabbajack Modlists Maintenance",
    "ModListImage": "F:\\Wabbajack Modlists Maintenance\\Dishonored 1.1\\thumbnail.png",
    "UseGamePaths": true,
    "UseTextureRecompression": false,
    "OtherGames": [],
    "MaxVerificationTime": "00:01:00",
    "ModListName": "Listname",
    "ModListAuthor": "AuthorName",
    "ModListDescription": "",
    "ModListReadme": "",
    "ModListWebsite": "",
    "ModlistVersion": "1.0.0.0",
    "PublishUpdate": false,
    "MachineUrl": "",
    "Profile": "",
    "AdditionalProfiles": [],
    "NoMatchInclude": [],
    "Include": [],
    "Ignore": [],
    "AlwaysEnabled": [],
    "Version": "1.0.0",
    "Description": ""
}
```

--------------------------------

### Configure Mod Organizer 2 Portable Instance Meta File

Source: https://wiki.wabbajack.org/modlist_author_documentation/Compilation%20Issues%20FAQ.html

Create a .meta file for Mod Organizer 2 to define its installation details when setting up a portable instance. Replace 'X.X.X' with the correct version number.

```ini
[General]
installed=true
directURL=https://github.com/ModOrganizer2/modorganizer/releases/download/vX.X.X/Mod.Organizer-X.X.X.7z
```

--------------------------------

### IPS4 Site .meta File Example (Lovers Lab)

Source: https://wiki.wabbajack.org/modlist_author_documentation/Meta%20Files.html

This format is used for files hosted on IPS4-based sites. It requires specifying the site name, mod ID, and the exact filename of the downloaded archive.

```ini
[General]
ips4Site=Lovers Lab
ips4Mod=11116
ips4File=WABBAJACK_TEST_FILE.zip

```

--------------------------------

### Direct URL .meta File Example

Source: https://wiki.wabbajack.org/modlist_author_documentation/Meta%20Files.html

Use this format for archives hosted on sites that do not require logins. Wabbajack will automatically download archives linked via directURL.

```ini
[General]
directURL=https://skse.silverlock.org/beta/skse64_2_00_20.7z
installed=true

```

--------------------------------

### Manual Download .meta File with Prompt

Source: https://wiki.wabbajack.org/modlist_author_documentation/Meta%20Files.html

This configuration is for files that require manual download or user interaction. An optional prompt can be included to guide the user in the Wabbajack UI.

```ini
manualURL=https://foo.bar.bz/someFile.zip
prompt=Please download the second file on this page

```

--------------------------------

### Configure .meta file for CDN URL

Source: https://wiki.wabbajack.org/wabbajack_cdn_and_gallery_access/Getting%20CDN%20Access.html

Use this configuration in a .meta file to specify a direct URL for Wabbajack to source files from the CDN. Replace '<link you copied goes here>' with the actual CDN link.

```ini
[General]
directURL=<link you copied goes here>

```

--------------------------------

### Google Drive .meta File Configuration

Source: https://wiki.wabbajack.org/modlist_author_documentation/Meta%20Files.html

For Google Drive links, use this specific URL format to ensure Wabbajack can recognize and download the file. Replace <ID> with the actual Google Drive file ID.

```ini
[General]
installed = true
directURL = https://drive.google.com/uc?id=1RQl8ki73fgLnzBZn6EWjneuW4Dk8TUO_&export=download

```

--------------------------------

### Basic Nexus Mods .meta File

Source: https://wiki.wabbajack.org/modlist_author_documentation/Meta%20Files.html

This is the standard configuration for a mod originating from Nexus Mods. It includes essential identifiers like game name, mod ID, and file ID.

```ini
[General]
gameName=Skyrim
modID=3863
fileID=1000172397

```

--------------------------------

### Wabbajack CLI Usage

Source: https://wiki.wabbajack.org/wabbajack_cli/Commands.html

This is the general usage information for the Wabbajack CLI. It outlines the basic structure for invoking commands and available global options.

```bash
Usage:
  wabbajack-cli [command] [options]

Options:
  --version       Show version information
  -?, -h, --help  Show help and usage information

Commands:
  compile                         Compiles a modlist
  decrypt                         Decrypts a file from the wabbajack encrypted storage
  download-all                    Downloads all files for all modlists in the gallery
  download-url                    Downloads a file to a given output
  dump-zip-info                   Dumps the contents of a zip file to the console, for use in debugging wabbajack
                                  files
  encrypt                         Encrypts a file and stores it in the Wabbajack encrypted storage
  extract                         Extracts the contents of an archive into a folder
  force-heal                      Creates a patch from New file to Old file and uploads it
  hash-file                       Hashes a file with Wabbajack's hashing routines
  hash-url-string                 Hashes a URL string and returns the hashcode as hex
  install                         Installs a wabbajack file
  install-compile-install-verify  Installs a modlist, compiles it, installs it again, verifies it
  list-creation-club-content      Lists all known creation club content
  list-games                      Lists all games Wabbajack recognizes, and their installed versions/locations (if
                                  any)
  list-modlists                   Lists all known modlists
  mirror-file                     Mirrors a file to the Wabbajack CDN
  modlist-report                  Generates a usage report for a Modlist file
  steam-download-file             Dumps information to the console about the given app
  steam-app-dump-info             Dumps information to the console about the given app
  steam-login                     Logs into Steam via interactive prompts
  upload-to-nexus                 Uploads a file to the Nexus defined by the given .json definition file
  validate-lists                  Gets a list of modlists, validates them and exports a result list
  verify-modlist-install          Verify a modlist installed correctly
  vfs-index                       Index and cache the contents of a folder
```

--------------------------------

### Configure Other Games in Compiler Settings

Source: https://wiki.wabbajack.org/modlist_author_documentation/Compilation%20Settings.html

Specify other games from which Wabbajack can source files. This is useful for VR versions of games that can use DLC from their non-VR counterparts. Ensure the game name matches Wabbajack's internal registry.

```json
"OtherGames": [
    "SkyrimSpecialEdition"
  ],

```

--------------------------------

### Include Other Profiles in Wabbajack

Source: https://wiki.wabbajack.org/modlist_author_documentation/Pre-Compilation.html

To include profiles other than the active one in your Mod Organizer 2 instance, create an `otherprofiles.txt` file in your main profile folder and list the desired profile names, one per line.

```plaintext
Performance
```
Tokens:
Raw