Jump to content

Karryn's Prison - Mod Organizer 2 Integration Plugins


Recommended Posts

Karryn's Prison - Mod Organizer 2 Integration Plugins


Mod Organizer Integration Plugins

pipeline status Latest Release

Collection of plugins to allow better integration of mods with Mod Organizer 2.

Installation

  • Download latest release (section Packages > mod-organizer-integration-plugins.zip)
  • Extract content of the archive to the root of Mod Organizer 2

Plugins

GitGud Package Tracker

Plugin allows to track the latest versions of mods from GitGud.

On launch it checks the latest versions for all gitgud mods (given that mod creator distributed mod with required metadata). Also checks the latest version of a mod right after it's successful installation.

Example

For example we have non-nexus mod:

gitgud_mod_custom_url.png
If mod contains required metadata you should see the following behavior.

When mod is up-to-date:
up_to_date

When mod is outdated:
outdated

For mod creators

To receive MO2 notifications about new versions of the mod (without any need in nexusmods approvals) can be achieved by including metadata inside mod archive. To achive that at the root of mod archive create file meta.ini with section [Plugins] and attributes GitGud\projectId, GitGud\releaseId and GitGud\fileId.

Example of meta.ini file for release https://gitgud.io/madtisa/cc-sk-compatibility-mod/-/releases/1.0.0

[Plugins]
# GitGud project id (number, required)
GitGud\projectId=19426
# Release version of mod (string, optional for now, but will be used in future)
GitGud\releaseId=1.0.0
# File identifier - the name of file in the release (string, optional for now, but will be used in future)
GitGud\fileId=CC-SK Compatibility Mod.zip

Project id can be found on main project folder:

project_id

Release and file ids on related release page:

release_and_file_ids

Karryn's Prison Plugin

The plugin adds support for Karryn's Prison game. Without it you won't be able to use MO2 to manage Karryn's Prison mods.

kp_support

Internal Metadata Extractor

The plugin allows to store mod metadata (e.g. modName, version) inside mod package.

By default MO2 overrides modName and version of non-nexus mods:

name_without_plugin

version_without_plugin

 

After installing the plugin name and version of mod can be specified inside mod archive:

name_with_plugin

version_with_plugin

For mod creators

All stardard MO2 metadata properties can specified inside mod archive.

For example, to specify mod default name and mod version you should add meta.ini file with following content:

[General]
# Suggested mod name on installation (string)
modName=CC-SK Compatibility Mod
# Version of the mod. Won't be overriden by MO2 if specified
version=1.0.0

Before installation file meta.ini will be extracted as archive MO2 metadata (as if immitating nexus download) and metadata will be used in process of installing mod and preserved after.

Also useful metadata attributes:

  • directURL - required for creating wabbajack modlists
  • url - custom url to package page
  • hasCustomURL - indicates whether it's a non-nexus mod
  • category - List of mod categories
  • etc...

 

Edited by madtisa
Added discord link and clarified installation instructions
Link to comment

So, I downloaded it, extracted it where stated but I don't know how to use it...? Can we get some more instructions? something?

and yes, I did the "Sanity Check." That file is in the correct location. 

 

edit: same question for the image replacer.

Edited by slice13
Link to comment
  • 3 weeks later...
  • 1 month later...
  • 3 weeks later...
On 2/16/2023 at 4:39 AM, ravensm785 said:

what about github . com ?

I can add support for github.com, sure, but they don't allow nsfw stuff, so I'm afraid there won't be any mod that is hosted there.

 

On 2/16/2023 at 4:39 AM, ravensm785 said:

if this works. then perhaps loverslab its self?

That's the first idea I had (okay, second, since the first was nexusmods). I had talked with loverslab staff about it, but this site doesn't have api to get mods info. I saw the wabbajack code. It parses uses headless browser and various hacks around cloudflare protection to get access. It would be hard to do the same inside MO2 plugin

Link to comment
On 11/29/2022 at 5:29 PM, slice13 said:

So, I downloaded it, extracted it where stated but I don't know how to use it...? Can we get some more instructions? something?

and yes, I did the "Sanity Check." That file is in the correct location.

I thought I clearly described (with screenshots) what each plugin does. If you read it and still have questions, you can quote unclear description parts and we can discuss how to fix it.
 

Also extended installations instruction a little

Edited by madtisa
Link to comment
  • 5 months later...

Mod Organizer won't launch the game even though I don't even have any mods installed yet.

What did I do wrong?
It locks itself for a second then unlocks without launching the game when I click run.

Yes I have the correct exe file that launches the game in the Binary under modify executables.

Yes the game launches fine when not doing it through MO.

There's also two errors whenever I open MO.

image.png.2c11cf9e9c97f52a2f0375431dadaae3.png

Link to comment
  • 4 months later...
On 8/3/2023 at 8:53 PM, MetaKnight145 said:

Mod Organizer won't launch the game even though I don't even have any mods installed yet.

What did I do wrong?
It locks itself for a second then unlocks without launching the game when I click run.

Yes I have the correct exe file that launches the game in the Binary under modify executables.

Yes the game launches fine when not doing it through MO.

There's also two errors whenever I open MO.

image.png.2c11cf9e9c97f52a2f0375431dadaae3.png

That is known problem with MO2 launching this specific game on some PCs. Unfortunately, at the moment no solution has been found, so I recommend to use vortex you experience it.
Details might be found in discord: https://discord.com/channels/454295440305946644/1068978324778528848/1083833951489110016

Link to comment

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
  • Recently Browsing   0 members

    • No registered users viewing this page.
×
×
  • Create New...

Important Information

We have placed cookies on your device to help make this website better. You can adjust your cookie settings, otherwise we'll assume you're okay to continue. For more information, see our Privacy Policy & Terms of Use