Code Monkey home page Code Monkey logo

r2modmanplus's Introduction

r2modman

Discord

GitHub

Features What is a mod manager? Installing Help Feedback and suggestions Changelog Screenshots

Features

  • Support for Risk of Rain 2, Dyson Sphere Program, Valheim, GTFO, BONEWORKS, and more
  • A clean user interface designed to make modding as simple as possible
  • Safer mod installation allowing you to play the game through Steam normally
  • Mod profiles to switch between different sets of mods quickly and easily
  • Export profiles to easily share both your mods and configs with friends
  • Download and install mods directly from the manager
  • View and update any outdated mods
  • Edit configs directly from the manager
  • Auto-updates
  • And more!

What is a mod manager?

It's quite simple really, a mod manager is an application to make it easier to control which mods you have installed.

You can choose to update, enable/disable or even uninstall mods with a simple click, all whilst keeping it available on another profile.

Installing

First time installing

Windows

  1. Click "Manual Download" on Thunderstore.
  2. Inside the downloaded .zip file. Run the "r2modman Setup X.X.X.exe" (where X.X.X is the current version).
  3. Follow the steps in the installer.

Linux

  1. Click "Manual Download" on Thunderstore.
  2. Inside the download .zip file there is an AppImage release.

If you'd prefer to install platform specific builds then you can find them under the latest GitHub release on the ebkr/r2modmanPlus repository

Platform builds:

  • deb
  • rpm
  • pacman
  • tar.gz

Problems with Linux builds should be reported in the r2modman discord.

Note
  • Temporary workaround to force Proton on Linux systems
    • Place a .forceproton file in the game directory whilst a solution is in development

Updating

r2modman will automatically download any available updates whilst you use it.

If an update has been downloaded, it will be installed once you have closed the application.

Help

Manager errors:

  1. Check the wiki.
  2. If you can't find the solution, join the community modding discord and ask for help in the appropriate channels.

Mod errors:

  1. Join the relevant community modding discord and ask for help in the appropriate channels.

Feedback and suggestions

It's encouraged to provide as much feedback as you'd like, and fully open to criticism.

Suggestions are welcome and there are already some suggestions that have made it in to the manager! From small features such as always-expanded cards, all the way to larger features such as code-based profile exports.

The only thing you have to consider when suggesting a feature is the impact it will have on users who don't have a lot of experience with computers.

Screenshots

Game selection

Installed mod view

Downloadable mods

Config editor

Profiles

r2modmanplus's People

Contributors

anttimaki avatar cgytrus avatar chirivulpes avatar codengine avatar compile-time avatar cspotcode avatar dependabot[bot] avatar ebkr avatar ethangreen-dev avatar hollofox avatar imatrisciano avatar ingohhacks avatar lonegamedev avatar lordmau5 avatar madh95 avatar mschmoecker avatar mythicmaniac avatar oksamies avatar randomwolf avatar sheybey avatar skourismanolis avatar starfi5h avatar thetimesweeper avatar vilpperiskidev avatar windows10ce avatar xiaoxiao921 avatar zeprus avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

r2modmanplus's Issues

Add author name to title or description

Would appreciate as it would help distinguish mods with the same name that haven't been deprecated in Thunderstore and possibly allow sorting by author to make sense.

I was thinking lighter weight text next to the mod name would be best, so you wouldn't have to expand the mod to see the author (again, making a list sorted by author look nice). Mods with an excessively long name might require the author name to be clipped off, but at least at my resolution and the default window size, this would require a mod name of ~60+ characters, which seems like a separate issue entirely ๐Ÿ˜ƒ

Another option that would avoid that issue would be to put the author name in the description, which would at least help the problem of differentiating mods with the same name.

Feel free to ping/message me on Discord @blazingdrummer#1929.

Retain a dependency's installed list position when it has multiple dependents

Currently, if a mod has multiple dependents, its position on the installed list moves to above the last installed dependent, rather than retaining its position on the list. This is most commonly seen with BepInEx and R2API, which are constantly shifting around as new mods are installed. This can sometimes make it hard to quickly locate mods in the list.

Feel free to ping/message me on Discord @blazingdrummer#1929.

Import profile will not actually install mods

I tried this both installed only for me and installed for all users. I tested this across multiple computers as well.
r2modman says that the r2x file has been imported, and the installed mods list looks correct. I checked mods/cache and it does look like the mods downloaded, but none of them are actually copied to the profile's folder. The only thing present in the profile is the "mods.yml" file.
Restarting r2modman doesn't resolve this issue. Nothing seems to affect the files inside the profile except going to the "online" tab and manually installing mods. I tried installing just r2api hoping it would cascade and cause r2modman to recognize all the mods that are supposed to be there and install them, but it did not.

Please let me know if there are any other useful files I can upload.

Default2.zip

r2modmanPlus does not launch the game

For some reason it does not launch the game when "Start Modded" or "Start Vanilla" buttons are pressed
And i've checked, the path to the Risk Of Rain 2 Install is correct

Also, my RoR2 install is not on my C drive with steam, its on another drive.
Clicking the links in the help tab does not work either.

2020-02-15_12-13-34
2020-02-15_12-19-28

(I know that the gifs are not really showing that nothing is happening but really, nothing's happening)

Launch game as both modded, or vanilla

The game should be able to be launched with mods from the current profile.

It should also have the option to be launched as vanilla, without the need to create an empty profile.

YAML Data Files

I would like all files that store metadata regarding profiles and their mods to be stored using YAML.

Support for mapped drives

I've got a somewhat weird setup and have my games drive mapped on a NAS, but this means I can't use r2modman

If possible, please add a configuration option to copy mods instead of using a symlink.

View on Thunderstore button.

This button should either open a new Electron window, allowing you to browse Thunderstore directly in the app, or, open the webpage via the console, opening Thunderstore in the default browser.

"Start modded" and "Start vanilla" buttons could stand out more

The selections are currently the exact same appearance as any of the other options, which caused me to accidentally click them a few times at first. My suggestions would be make them bold text, give them a background color, or maybe just a border to distinguish them from the other buttons. Now that I've gotten used to them, it's not a problem, so maybe I was just too dumb ๐Ÿ˜ and it wouldn't be worth the time. Either way, just thought I'd mention it.

Feel free to ping/message me on Discord @blazingdrummer#1929.

Allow profiles to include mods that are disabled

This would be an extremely useful feature for current/future modpack creators who want to include mods that imitate Artifacts like ChestItemPicker, Sacrifice, and SpiteMod or unfinished characters like PlayableScavenger, BootlegChef, or SniperRework, but don't want them to be enabled by default.

Feel free to ping/message me on Discord @blazingdrummer#1929.

Install with Mod Manager support

You should be able to browse Thunderstore and click the "Install with Mod Manager" button.

This should launch r2modmanPlus, and pre-open the download modal once the profile has been selected.

Help pages

Help pages:

  1. r2modman help
  2. Mod not working
  3. Launching via Steam
  4. Potential Thunderstore connection problems.
  5. Further support

Profile Selection, Creation, and Deletion

I would like to be able to use custom profiles so that I can organise my mods for different play sessions.

I want to:
โ€ข Create a profile, and call it whatever I want.
โ€ข Delete the profile if I no longer need/want it.
โ€ข Select the profile so that I may install mods for use with that profile.

Implement Manifest V2 Spec

This will be an on-going issue that will only be closed once fully implemented, and Thunderstore has a finalised version of the new manifest.

The new v2 endpoint will be pagination based. Are all results fetched from each page in consecutively, or is it based on how far down a user has scrolled?
(Searching will have it's own endpoint which isn't a concern yet ).

Installing mods to profiles

Depends on issue #1

When I download a mod, I want it to install to my current profile, so that I don't need to edit any configuration files to get r2modman to recognise it.

"Disable all mods" button doesn't work, despite visuals

The button causes all mods to be crossed out and display the "enable" button in the dropdown, exactly as if they were actually disabled, but the mods are still loaded on game launch. Disabling them one-by-one still functions as expected. The "Enable all mods" button still functions as expected.

Feel free to ping/message me on Discord @blazingdrummer#1929.

Enabling/Disabling installed mods.

As uninstalling a mod deletes it from the local profile, there needs to be a noticeable difference between uninstalling and disabling.

Disabling should add ".old" to all DLL extensions for files under BepInEx/[^config]/ModName

Auto updating

Since r2modmanPlus no longer uses unpacked (asar) files in /resources, this should be far easier to update.

Support migration from r2modman 2.1.1

Mods should be detected, and re-downloaded if isHTTP is enabled.

Pre-requisites:

  1. There exists at least one profile.

Steps:

  1. Read mods.json file.
  2. Delete profile.
  3. Re-create profile.
  4. Download mods.
  5. Retrieve path.txt, and set to ror2InstallLocation
  6. Perform cleanup.

Notes:
Previously exported profiles should be ignored, as they work of UUID4. The new version ignores this, and this field is likely to become deprecated in Manifest V2.

Config editor

It'd be nice for users to be able to browse, edit, save, and discard changes for config files without having to leave the manager.

This however, is not essential for the r2modmanPlus first release.

Errors need to be displayed to the user.

Previously, r2modman would silently handle errors,
This wasn't good as errors that could occur wouldn't provide any detailed error message.

Error handling is already implemented in R2MMp, and so requires a way of showing these errors to the user.

In terms of implementation, either a page showing all recorded errors (can do so by adding to the page on R2Error creation, or by showing a notification box with the error title, and a modal that can open explaining the error, and providing the message.

Import profile

One of the nicest features of r2modman were profile exports/imports.

This allows r2modman to import a profile based on a previously exported one.

The manager should allow for custom naming, defaulting to the exported profile's name.

Profiles and cache are cleared on update

Should still have the opportunity to backup files before restarting the program though. Would appreciate confirmation that this isn't just on my end, and that other people have experienced it.

Feel free to ping/message me on Discord @blazingdrummer#1929.

BepInEx Installations

BepInEx needs to be install-able on a per-profile basis.

It should just be a case of extracting the /mods/cache/bbepis-BepInExPack/version/ folder to the active profile's current directory.

Settings page

Settings page needs to be implemented with the following options:

  1. Change RoR2 directory used.
  2. Associate Install with Mod Manager button.
  3. Export profile
  4. Import profile
  5. Raise a bug
  6. Launch via Steam?

Export profile

One of the nicest features of r2modman were profile exports/imports.

This will allow r2modman to export the current modlist in a readable format for another client to install the same, identical, mods.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.