Issue with Game Extension I am trying to create....

[kewpee]

I am losing my mind here trying to figure out what is going wrong. Ready Or Not mod creators tend to double up their folders (ie: Folder - Folder - Mod). This makes Vortex place a folder in the mod location instead of the .pak file.

I am hoping someone can take a look at my .js file and see what the heck I did wrong because following the guide for extension creation I thought this code would ignore any folders outside of the folder containing the .pak file.

Please be my savior.  Here is my code below... it wouldn't let me attach a file in this post. 

Quote

//Import some assets from Vortex we'll need.

const path = require('path');

const semver = require('semver');

const { actions, fs, log, util } = require('vortex-api');

 

// Nexus Mods domain for the game. e.g. nexusmods.com/bloodstainedritualofthenight

const GAME_ID = 'readyornot';

//Steam Application ID, you can get this from https://steamdb.info/apps/

const STEAMAPP_ID = '1144200';

//Add this to the top of the file

const winapi = require('winapi-bindings');

//Add this to the top of the file

const MOD_FILE_EXT = ".pak";

 

function findGame() {

  return util.GameStoreHelper.findByAppId([STEAMAPP_ID])

      .then(game => game.gamePath);

}

 

const oldModPath = path.join('Ready Or Not', 'Content', 'Paks');

const relModPath = path.join('ReadyOrNot', 'Content', 'Paks');

 

function prepareForModding(discovery) {

  return fs.ensureDirWritableAsync(path.join(discovery.path, relModPath),

    () => Promise.resolve());

}

 

function installContent(files) {

  // The .pak file is expected to always be positioned in the mods directory we're going to disregard anything placed outside the root.

  const modFile = files.find(file => path.extname(file).toLowerCase() === MOD_FILE_EXT);

  const idx = modFile.indexOf(path.basename(modFile));

  const rootPath = path.dirname(modFile);

 

  // Remove directories and anything that isn't in the rootPath.

  const filtered = files.filter(file =>

    ((file.indexOf(rootPath) !== -1)

    && (!file.endsWith(path.sep))));

 

  const instructions = filtered.map(file => {

    return {

      type: 'copy',

      source: file,

      destination: path.join(file.substr(idx)),

    };

  });

 

  return Promise.resolve({ instructions });

}

 

function testSupportedContent(files, gameId) {

  // Make sure we're able to support this mod.

  let supported = (gameId === GAME_ID) &&

    (files.find(file => path.extname(file).toLowerCase() === MOD_FILE_EXT)!== undefined);

 

  return Promise.resolve({

    supported,

    requiredFiles: [],

  });

}

 

function main(context) {

    //This is the main function Vortex will run when detecting the game extension.

   

    context.registerGame({

        id: GAME_ID,

        name: 'Ready or Not 1.0',

        mergeMods: true,

        queryPath: findGame,

        supportedTools: [],

        queryModPath: () => 'ReadyOrNot/Content/Paks',

        logo: 'gameart.jpg',

        executable: () => 'ReadyOrNot.exe',

        requiredFiles: [

          'ReadyOrNot.exe',

          'ReadyOrNot/Binaries/Win64/ReadyOrNot-Win64-Shipping.exe'

        ],

        setup: prepareForModding,

        environment: {

          SteamAPPId: STEAMAPP_ID,

        },

        details: {

          steamAppId: STEAMAPP_ID,

        },

      });

   context.registerInstaller('readyornotkewp', 25, testSupportedContent, installContent);

 

    return true

}

 

module.exports = {

    default: main,

};

 

Edited January 18 by kewpee
ADDED JS INFO

[kewpee]

@Pickysaurus Would you be willing to help me out on this? I would really appreciate it and it would make my day. The existing Ready or Not extension that Vortex uses is broken and doesn't properly install mods into the correct location. I am making a new extension I want to submit to Nexus that others can use that will make Vortex Mod Manager usable with RoN but I cannot seem to resolve this issue I am having...

[Pickysaurus]

If you're trying to copy only the PAK files and disregard any other files or folder structures you could try using "Stop Patterns". This means you'd remove the following parts:
 

function installContent(files) {
  // The .pak file is expected to always be positioned in the mods directory we're going to disregard anything placed outside the root.
  const modFile = files.find(file => path.extname(file).toLowerCase() === MOD_FILE_EXT);
  const idx = modFile.indexOf(path.basename(modFile));
  const rootPath = path.dirname(modFile);
 
  // Remove directories and anything that isn't in the rootPath.
  const filtered = files.filter(file =>
    ((file.indexOf(rootPath) !== -1)
    && (!file.endsWith(path.sep))));
 
  const instructions = filtered.map(file => {
    return {
      type: 'copy',
      source: file,
      destination: path.join(file.substr(idx)),
    };
  });
 
  return Promise.resolve({ instructions });
}
 
function testSupportedContent(files, gameId) {
  // Make sure we're able to support this mod.
  let supported = (gameId === GAME_ID) &&
    (files.find(file => path.extname(file).toLowerCase() === MOD_FILE_EXT)!== undefined);
 
  return Promise.resolve({
    supported,
    requiredFiles: [],
  });
}


context.registerInstaller('readyornotkewp', 25, testSupportedContent, installContent);

 

The inside the "details" part of your game registration you'd add. 

stopPatterns: ['[^|/|\\]*.pak$'],

 

Edited January 18 by Pickysaurus
Updated the stop pattern

[kewpee]

@Pickysaurus Thank you for such a quick reply. I messed around with stop pattern prior to trying what you saw... I kept getting an error. I just deleted everything you showed and then added the stopPatterns under details and am now getting errors when trying to delploy mods. Did I do something wrong with the code?

Quote

//Import some assets from Vortex we'll need.

const path = require('path');

const semver = require('semver');

const { actions, fs, log, util } = require('vortex-api');

 

// Nexus Mods domain for the game. e.g. nexusmods.com/bloodstainedritualofthenight

const GAME_ID = 'readyornot';

//Steam Application ID, you can get this from https://steamdb.info/apps/

const STEAMAPP_ID = '1144200';

//Add this to the top of the file

const winapi = require('winapi-bindings');

//Add this to the top of the file

const MOD_FILE_EXT = ".pak";

 

function findGame() {

  return util.GameStoreHelper.findByAppId([STEAMAPP_ID])

      .then(game => game.gamePath);

}

 

const oldModPath = path.join('Ready Or Not', 'Content', 'Paks');

const relModPath = path.join('ReadyOrNot', 'Content', 'Paks');

 

function prepareForModding(discovery) {

  return fs.ensureDirWritableAsync(path.join(discovery.path, relModPath),

    () => Promise.resolve());

}

 

function main(context) {

    //This is the main function Vortex will run when detecting the game extension.

   

    context.registerGame({

        id: GAME_ID,

        name: 'Ready or Not 1.0',

        mergeMods: true,

        queryPath: findGame,

        supportedTools: [],

        queryModPath: () => 'ReadyOrNot/Content/Paks',

        logo: 'gameart.jpg',

        executable: () => 'ReadyOrNot.exe',

        requiredFiles: [

          'ReadyOrNot.exe',

          'ReadyOrNot/Binaries/Win64/ReadyOrNot-Win64-Shipping.exe'

        ],

        setup: prepareForModding,

        environment: {

          SteamAPPId: STEAMAPP_ID,

        },

        details: {

          steamAppId: STEAMAPP_ID,

          stopPatterns: ['[^|/|\\]*.pak$'],

        },

      });

 

    return true

}

 

module.exports = {

    default: main,

};

 

[kewpee]

@Pickysaurus I figured it out. Working like a charm now. The code for the stopPattern is:

Quote

stopPatterns: ['(^|/).*\.pak$'],

Thank you for pointing me in the right direction! You are awesome! How do I go iabout sending this over to you guys for approval so we can get this extension to replace the outdated one? I'm excited to provide a way for people to use the Mod Manager to manage their Ready Or Not mods!

[Pickysaurus]

You just need to create a page for it. There is already an extension for Ready or Not so it may be worth checking if it works? https://www.nexusmods.com/site/mods/342

Once you've set it up on a page it'll be checked over by @insomniousor @Nagev

[kewpee]

@Pickysaurus Yeah, that extension doesn't work properly and hasn't been updated in over a year. It installs to the wrong directory and also installs a folder with the mod inside of it instead of just the .pak file. By create a page for it do you mean upload it onto Nexus website?

[kewpee]

@insomnious @Nagev The page has been setup for the extension. https://www.nexusmods.com/site/mods/766/

 

This extension should be included in the main Vortex build and replace https://www.nexusmods.com/site/mods/342 as it is broken and does not properly install RoN mods where they need to be placed.