https://github.com/angelore/remnant-two-overseer
Remnant Overseer: a companion tool for Remnant 2
https://github.com/angelore/remnant-two-overseer
avaloniaui companion-app remnant-2-tools remnant-2-utilities remnant2 save-files
Last synced: 2 months ago
JSON representation
Remnant Overseer: a companion tool for Remnant 2
- Host: GitHub
- URL: https://github.com/angelore/remnant-two-overseer
- Owner: Angelore
- License: mit
- Created: 2024-05-19T11:42:36.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-09T12:01:24.000Z (4 months ago)
- Last Synced: 2025-03-28T23:11:16.271Z (3 months ago)
- Topics: avaloniaui, companion-app, remnant-2-tools, remnant-2-utilities, remnant2, save-files
- Language: C#
- Homepage:
- Size: 5.24 MB
- Stars: 11
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
Remnant Overseer
A companion tool for **Remnant 2** that allows you to view the information about your current save.
Select your character and see which items they are missing and which ones you can get in your currently rolled worlds.
This tool only **reads** the save file, it can not make any changes to it.
# Screenshots
# Features
- Displays the items that are available in the current rolled world
- Displays the current location of the player
- Indicates whether Trait book and/or Simulacrum are available in the location
- ~~Displays Bloodmoon status~~ Temporarily doesn't
- Displays whether an item is only obtainable in co-op
- Allows to filter by item names and injectable events
- Updates the state whenever the save file changes
- Gamepass support
- ... and more?
# Installation
- Download and install [.NET 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) or greater
- You only need a .NET Desktop Runtime x64, but you can install the whole SDK if you want to
- Download the latest release
- Unpack the archive to a folder. To avoid issues, use a non-system folder, such as `C:\Games\RemnantOverseer`
- Launch the .exe file
# Acknowledgements
- Razzmatazzz for his [project](https://github.com/Razzmatazzz/RemnantSaveGuardian), which served as an inspiration for this one and made me look into working on Remnant in the first place
- AndrewSav for [https://github.com/AndrewSav/lib.remnant2.analyzer](https://github.com/AndrewSav/lib.remnant2.analyzer), which is used as an underlying parsing library
- Avalonia (EN) telegram channel and specifically Steve for answering many of my AvaloniaUI-related questions
- And you! For taking an interest in the project
# Known issues
- When viewing a big list of items application is stuttering on refresh. This is due to my control of choice (treeview) not having virtualization, so building a visual tree takes a while. I learned about this quite late in development, so I decided to stick with it for now. I will try to optimize it when I have extra time (this will require a non-trivial rework)