jokolay

An Overlay for Guild Wars 2 in Rust

Well, technically, this contains a family of crates related to jokolay.

jokolink: This is what you will run from the wine prefix of gw2 . it reads the official shared memory of gw2 to get live player data and copy into a shared memory file under /dev/shm for linux native apps (like Jokolay) to use.
jokoapi: API bindings for gw2 api in rust. if anyone wants to contribute, this is the best place. its just copy pasting api endpoints and filling out all the required fields of structs, writing tests to verify.
jokolay: this is the actual overlay.
joko_marker_format: deals with marker packs.

Minimum Requirements

Requires Vulkan. most GPUs after gtx 750 should be okay.
X11. Wayland is NOT supported. (does not apply to windows obviously).
no HDR support. I have no idea how it works.
A few braincells. because this is beta software and you need to provide me info/logs to debug stuff.

Compiling

for now, just look at the github workflow file.

dependencies: cmake,
linux deps: gtk, xorg,

Installing

Linux

You can download the jokolink.dll and jokolay from the latest releases https://github.com/coderedart/jokolay/releases/latest
You need to get jokolink working. Go to Jokolink's README and follow those instructions
Just start jokolay binary.

Window Managers

compositing must be turned on or transparency won't work. you will just see a black window other wise.
lutris can disable compositing when game launches, so turn that feature off in lutris game options.

Officially supported

KDE.

I will primarily be testing Jokolay on Endeavour (Arch) OS / KDE Plasma latest. need more guinea pigs to test things on other DEs.