gw2toolbelt / gw2ml Goto Github PK

The uiTick field is currently undocumented. The documentation should contain information about what the field means and how it is used by the game.

The instance field is currently undocumented. The documentation should contain information about what the field means and how it is used by the game.

 Bit 1 = IsMapOpen,
 Bit 2 = IsCompassTopRight,
 Bit 3 = DoesCompassHaveRotationEnabled
 Bit 4 = Game has focus
 Bit 5 = Is in Competitive game mode

According to a dev on the community dev discord those are the bits currently in the game.

In 3.0.0, the permissions used to open a view were reduced which caused one particular issue that was not caught during testing: The permissions used when creating a file mapping are incorrectly configured, which prevents writing.

When calling clear(), an attempt is made to write to a section of memory without the required permissions, and an EXCEPTION_ACCESS_VIOLATION is raised (and crashes the JVM).

The last pc belongs to native method entry point (kind = native) (printed below).
Java frames: (J=compiled Java code, j=interpreted, Vv=VM code)
j  jdk.internal.misc.Unsafe.setMemory0(Ljava/lang/Object;JJB)V+0 java.base@22
j  jdk.internal.misc.Unsafe.setMemory(Ljava/lang/Object;JJB)V+25 java.base@22
j  jdk.internal.misc.ScopedMemoryAccess.setMemoryInternal(Ljdk/internal/foreign/MemorySessionImpl;Ljava/lang/Object;JJB)V+17 java.base@22
j  jdk.internal.misc.ScopedMemoryAccess.setMemory(Ljdk/internal/foreign/MemorySessionImpl;Ljava/lang/Object;JJB)V+8 java.base@22
j  jdk.internal.foreign.AbstractMemorySegmentImpl.fill(B)Ljava/lang/foreign/MemorySegment;+30 java.base@22
j  com.gw2tb.gw2ml.MumbleLink.clear()V+9 com.gw2tb.gw2ml

The shardID field is currently undocumented. The documentation should contain information about what the field means and how it is used by the game.

The uiVersion field is currently undocumented. The documentation should contain information about what the field means and how it is used by the game.

The mapType field is currently undocumented. The documentation should contain information about what the field means and how it is used by the game.

Publishing seems to have failed with no proper error twice now. I'll try to resolve this ASAP but I'm not sure how much I can do.

https://jitpack.io/ may be used as a workaround for now.

The description field is currently undocumented. The documentation should contain information about what the field means and how it is used by the game.

All fields related to avatar and camera position are currently undocumented. The documentation of those fields should contain information about how Mumble uses those and how those may be used in the context of the game (e.g. how to map them to GW2 coordinate systems).

While this library is still in experimental phase, its API is fairly stable and unlikely to change. Though, due to the lack of detailed documentation, a "stable release" (1.0.0) will not be published for now.

Some sections of the library are still undocumented due to my lack of knowledge (and/or experience) in how to interpret the data exposed by the game (e.g. coordinate transforms). Until I find some time to experiment with those or until information is contributed, they will remain undocumented.

Alongside this issue, the issue tracker contains multiple issues to keep track of which sections of the documentation require what changes. (See the 1.0.0 milestone.)