https://github.com/emik03/remote
Standalone Archipelago client, with dedicated feature-rich support for manual apworlds.
https://github.com/emik03/remote
Last synced: 8 months ago
JSON representation
Standalone Archipelago client, with dedicated feature-rich support for manual apworlds.
- Host: GitHub
- URL: https://github.com/emik03/remote
- Owner: Emik03
- License: mpl-2.0
- Created: 2025-06-21T15:55:50.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-03T11:25:18.000Z (about 1 year ago)
- Last Synced: 2025-08-03T13:12:29.457Z (about 1 year ago)
- Language: C#
- Size: 11.3 MB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[
](https://raw.githubusercontent.com/Emik03/Emik.Manual/refs/heads/main/Images/icon.svg)
# Remote
Fully-functional standalone Windows/Mac/Linux/[Android*](#android) client for [Archipelago](https://archipelago.gg/), specializing in [Manual for Archipelago](https://github.com/ManualForArchipelago). **Ensure that [.NET 10](https://dotnet.microsoft.com/en-us/download/dotnet/10.0) is installed** prior to opening the application.
Consider also using [Emik.Manual](https://github.com/Emik03/Emik.Manual) to create your manual games programmatically!
This project has a dependency to [Emik.Morsels](https://github.com/Emik03/Emik.Morsels), if you are building this project, refer to its [README](https://github.com/Emik03/Emik.Morsels/blob/main/README.md) first.
### [Latest Release (click me!)](https://github.com/Emik03/Remote/releases/latest)
---
- [Features](#features)
- [Screenshots](#screenshots)
- [Android](#android)
- [Thanks](#thanks)
- [Contribute](#contribute)
- [License](#license)
---
## Features
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 `DeathLink` in 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_PATH` to change the path of the `history.json` file.
- Specify `REMOTE_PREFERENCES_PATH` to change the path of the `preferences.cfg` file.
## Screenshots
[](https://raw.githubusercontent.com/Emik03/Remote/refs/heads/main/Images/preview1.png)
[](https://raw.githubusercontent.com/Emik03/Remote/refs/heads/main/Images/preview2.png)
[](https://raw.githubusercontent.com/Emik03/Remote/refs/heads/main/Images/preview3.png)
[](https://raw.githubusercontent.com/Emik03/Remote/refs/heads/main/Images/preview4.png)
[](https://raw.githubusercontent.com/Emik03/Remote/refs/heads/main/Images/preview5.png)
[](https://raw.githubusercontent.com/Emik03/Remote/refs/heads/main/Images/preview6.png)
[](https://raw.githubusercontent.com/Emik03/Remote/refs/heads/main/Images/preview7.png)
[](https://raw.githubusercontent.com/Emik03/Remote/refs/heads/main/Images/preview8.png)
## Android
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](https://github.com/Emik03/Remote/issues/1). 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.
## Thanks
Thank you to the following projects that make this possible:
---
- [Icon](https://github.com/Emik03/Remote/blob/main/Resources/Drawable/Icon.svg) by [Ghostlyfield](https://bsky.app/profile/ghostlyfield.bsky.social)
- [Extractor.py](https://github.com/Emik03/Remote/blob/main/Resources/Values/Extractor.py) by [Darius](https://github.com/itsMapleLeaf)
- [Color Scheme](https://draculatheme.com/contribute)
---
- [Archipelago](https://archipelago.gg)
- [Archipelago.MultiClient.Net](https://github.com/ArchipelagoMW/Archipelago.MultiClient.Net)
- [Archipelago.MultiClient.Net.Analyzers](https://github.com/BadMagic100/Archipelago.MultiClient.Net.Analyzers)
- [cimgui](https://github.com/cimgui/cimgui)
- [Fira Code](https://github.com/tonsky/FiraCode) (go [sponsor Nikita Prokopov](https://github.com/sponsors/tonsky)!)
- [imgui](https://github.com/ocornut/imgui) (go [sponsor them](https://github.com/ocornut/imgui/wiki/Funding)!)
- [ImGui.NET](https://github.com/ImGuiNET/ImGui.NET)
- [ManualForArchipelago](https://github.com/ManualForArchipelago/Manual)
- [MonoGame](https://monogame.net) (go [sponsor them](https://github.com/sponsors/MonoGame)!)
- [Noto Sans](https://fonts.google.com/noto)
- [PupNet Deploy](https://github.com/kuiperzone/PupNet-Deploy)
- [YamlDotNet](https://github.com/aaubry/YamlDotNet/wiki) (go [sponsor Edward Cooke](https://github.com/sponsors/EdwardCooke)!)
---
## Contribute
Issues and pull requests are welcome to help this repository be the best it can be.
## License
This repository largely falls under the [MPL-2 license](https://www.mozilla.org/en-US/MPL/2.0/).
The `Remote.Resources/Fonts` directory is subject to a [separate license](https://github.com/Emik03/Remote/blob/main/Remote.Resources/Fonts/LICENSE), being a redistribution of [Fira Code](https://github.com/tonsky/FiraCode).