You are viewing a potentially older version of this package. View all versions.
Xaidee-ShowArtifacts-1.2.2 icon

ShowArtifacts

Displays all currently activated artifacts on the HUD.

Date uploaded 6 months ago
Version 1.2.2
Download link Xaidee-ShowArtifacts-1.2.2.zip
Downloads 578
Dependency string Xaidee-ShowArtifacts-1.2.2

This mod requires the following mods to function

ReturnOfModding-ReturnOfModding-1.1.7 icon
ReturnOfModding-ReturnOfModding

Lua Mod Loader for Risk of Rain Returns

Preferred version: 1.1.7
ReturnsAPI-ReturnsAPI-0.1.19 icon
ReturnsAPI-ReturnsAPI

(Mostly done) API for modding Risk of Rain Returns.

Preferred version: 0.1.19

README

ShowArtifacts

Displays the currently activated artifacts on the HUD.

Each enabled artifact is shown on the top right of the HUD, next to the Difficulty icon. Preview

COPYING

This mod is licensed under the MIT License to make it easy for the Risk of Rain Returns modding community to use and build upon. As a Lua-based mod, the source code is included by default. Here’s what this means for modders:

  • You Can: Freely use, modify, and share this mod’s Lua scripts in your own mods or projects, including those licensed under MIT, GPL, or other compatible licenses, with no restrictions beyond the MIT License terms.

  • Optional: I don’t strictly enforce attribution, but I’d appreciate if you credit this mod when using its code. I also encourage keeping the code readable (avoiding obfuscation) and sharing your modifications to foster collaboration in the RORR community.

  • License Text: The full MIT License is provided in the LICENSE file in this mod’s root directory. Please include it verbatim in distributions, especially if you choose to credit.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

If you have questions about using this code, feel free to reach out in the RORR Modding Discord server or open an issue on GitHub if the mod failes to function properly!

CREDITS

Shout out to @azulineskye (azzy for short) from the Risk of Rain Returns Modding Discord for helping me out, especially with the best way to render the artifacts.

CHANGELOG

1.2.2

  • Make the mod work again (i have no idea how long it's been broken).
    • The global Settings was being set to DefaultSettings before it was defined and thus returning null and breaking everything.
    • Maybe this only affected new instances that didn't have a config file yet?

1.2.1

  • Fix that updates a change to artifact's sprite ids found in ReturnsAPI 0.1.19
  • Update dependency versions for ReturnOfModding and ReturnsAPI

1.2.0

  • Port to use ReturnsAPI
  • Added configuration via the in-game settings menu.
    • So far it's just whether to draw an extra black drop-shadow and the ability to reset the config, offsets and colours are planned to be added.

1.1.0

  • Code refactor:
    • Make things more readable.
    • Enhance debug_print to new log function.
    • Unify constants into Settings table, to make things easier for future configuration
    • Add LICENSE and update README.md appropriately.
    • Added a screen-grabbed preview of how the mod looks in-game
    • Reduced calls to Global/gm.get_global_get() and make them consistent.
    • Sanity checks

1.0.0

  • Initial release.