Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review: Atlyss #16736

Open
3 of 14 tasks
LuneMods opened this issue Dec 3, 2024 · 3 comments
Open
3 of 14 tasks

Review: Atlyss #16736

LuneMods opened this issue Dec 3, 2024 · 3 comments

Comments

@LuneMods
Copy link

LuneMods commented Dec 3, 2024

Nexus Username

lunemods

Extension URL

https://www.nexusmods.com/site/mods/1110

Game URL

https://www.nexusmods.com/atlyss

Existing Extension URL

No response

New features

A Vortex extension for Atlyss that allows for loading of both BepInEx & MelonLoader .dll mods.
I'm not sure how else to manage 2x different types of .dll files without enforcing a certain file structure in the mods .zip file.

Mod files must have the correct file structure to work. See the example file the optional downloads + below:

BepInEX:
ModName.zip/BepInEx/plugins/ModName/ModName.dll

MelonLoader
ModName.zip/MLLoader/Mods/ModName.dll

Information

  • I confirm the above is accurate

Packaging

  • This extension is packaged correctly

Testing

  • This game extension has been tested

Review Tasks

If a task fails, contact the author to request changes before continuing.

  • Double-check for existing extension
  • Is the extension packaged correctly?
  • Does it install into Vortex?
  • Does it correctly discover the game?
  • Does it successfully install a mod?
  • Does it successfully install a collection?
  • Does the game run correctly with the mods installed? ​

When reviewed and passed, please complete the following tasks:

  • Run the GitHub Actions to add to manifest
  • Contact author
  • Ask Community to enable the Vortex button for the game
  • Update the #vortex-announcements channel on Discord
@IDCs IDCs mentioned this issue Dec 5, 2024
14 tasks
@IDCs
Copy link
Contributor

IDCs commented Dec 5, 2024

Hi there @LuneMods , first of all thank you for your contribution. Not sure you noticed, but there's a second extension attempting to add support for the same game:
https://www.nexusmods.com/site/mods/1109
#16728

Please discuss this with the author of the other extension and hopefully merge your efforts to provide your users with the best possible game support.

Both extensions have a flaw in the custom installer logic where you've set the FILE_EXT constant to an empty string, yet you're using it in the installer test to decide whether the installer is supported.

Unfortunately a very common packaging strategy by BepInEx modders is to upload just a dll file. You cannot expect mod authors to apply a certain packaging standards.

Please have a read through existing BepInEx API documentation and implement support using the existing API.

@LuneMods
Copy link
Author

LuneMods commented Dec 6, 2024

Thanks for the response.

The other Extension will only work with MelonLoader Mods, and it just downloads the MelonLoader installer through the browser, requiring the user to install it manually. When discussing this with them, they did not seem to want to change it. This version requires less user input, and will work with both MelonLoader & BepInEx mods.

The reason why I have left the FILE_EXT empty is due to the fact that many of the current mods also include assetbundles or .png's that are loaded at runtime using BepInEx or MelonLoader. The Mods are coded in a way that requires the additional files to be in a certain directory relative to the .dll. For instance there is a texture loading plugin that requires the textures to be placed in 'BepInEx/plugins/CustomTextures'.

Both MelonLoader and BepInEx mods provide .dll files, but they need to be placed in different directories.

I'll write something to parse the .dll and move it to the correct directory based on whether it contains 'MelonLoader', then upload a new revision.

I'll also have a further look to see how it functions when there is no .dll in the .zip, and only textures.

@IDCs
Copy link
Contributor

IDCs commented Dec 9, 2024

Thank you for your clarifications @LuneMods

Is MelonLoader the main reason behind not using the BepInEx API ?
https://github.com/Nexus-Mods/Vortex/wiki/LEGACY-Tutorial-BepInEx-Extensions-Usage

The BepInEx API functionality will cover download/installation and cover most BepInEx modTypes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants