Fully-functional standalone Windows/Mac/Linux/Android* client for Archipelago, specializing in Manual for Archipelago. Ensure that .NET 10 is installed prior to opening the application.
Consider also using Emik.Manual to create your manual games programmatically!
This project has a dependency to Emik.Morsels, if you are building this project, refer to its README first.
Many features address usability concerns over the original manual client:
- Accident-proof; You tick a checkbox, press the "Release" button, and confirm the release again by holding down a separate button. This can also be configured to be less explicit.
- Drag-and-drop; YAML files can be dropped into the window to immediately start a session. You can also copy paste the file path to achieve the same result.
- Out-of-logic is highlighted; Locations not in logic are invisible by default, colored red, and a warning message appears when trying to break logic. Additionally, hovering over these locations will showcase the items required.
- Consumable item tracking; Mark items as "consumed", to keep track of whether you resolved temporary fillers or traps.
- Slot-defined category; Locations can be moved to a special category that is always on top. The purpose is left for the user, such as a "try later" list, a priority list, or hinted locations.
- Chat autocomplete; When typing in chat, suggestions for commands and names of items will show up. Can be disabled.
- Notifications; You can enable push notifications for receiving new items, as long as you leave the slot open.
- DeathLink support; Send and receive DeathLink notices. Remote offers a toggle to crash the application when a DeathLink is received, but by adding your own file watcher over the file
DeathLinkin your temporary directory, you can make your computer or game do anything upon death! - Highlights BK; Shows "BK" and "Done" to efficiently communicate the status of a manual slot.
It also includes other quality-of-life features to minimize setup time:
- Manage multiple sessions at the same time in one window, no need to open the application multiple times for each slot.
- Ability to communicate in the chat, see hints, locations, and items, all with sort and filter options.
- Remembers which servers you logged into, allowing you to immediately jump right back into a slot when opening the application again.
- Extensive UI scaling and theming, as well as font alternatives for accessibility.
- Specify
REMOTE_HISTORY_PATHto change the path of thehistory.jsonfile. - Specify
REMOTE_PREFERENCES_PATHto change the path of thepreferences.cfgfile.
Android builds are handled in a separate project file Remote.Android.
Currently, android builds do successfully compile and theoretically work on devices with a x86_64 architecture, but for any other architecture are unable to launch properly due to the missing cimgui library.
As such, I do not publish Android builds at this current time.
If you wish to help out, you can discuss or provide resources in this issue. This would be greatly appreciated.
When compiling the project yourself, make sure to specify -c Debug as compiling under release can take upwards of 20+ minutes.
Thank you to the following projects that make this possible:
- Archipelago
- Archipelago.MultiClient.Net
- Archipelago.MultiClient.Net.Analyzers
- cimgui
- Fira Code (go sponsor Nikita Prokopov!)
- imgui (go sponsor them!)
- ImGui.NET
- ManualForArchipelago
- MonoGame (go sponsor them!)
- Noto Sans
- PupNet Deploy
- YamlDotNet (go sponsor Edward Cooke!)
Issues and pull requests are welcome to help this repository be the best it can be.
This repository largely falls under the MPL-2 license.
The Remote.Resources/Fonts directory is subject to a separate license, being a redistribution of Fira Code.