Info Display enhancement : Rotation, Rotation Speed, TimeDifference, Oriented Speed. #57

Blounard · 2023-12-24T18:25:33Z

Oriented Speed is the XZ speed, but instead of decomposing it as X and Z, it's decomposed as Forward and Sideway (relative to your facing angle)
This PR also contain the advanced ghost comp, but the implementation might change in the future.

1st attempt at adding rotation to infodisplay. Unfinished. Mainly a test of using github

Added rotation and rotation speed to the infodisplay. Should be ready to use.

Fixed an issue in race manager : RaceState is 4 when the race is finished, not 3. (atleast for TTs). It was previously causing the info display to turn off on the race finish state, despite the code not aiming to do that. Fixed the Rotation speed calculation to not trigger error while not in a race. (It wasn't a big issue, it was just spamming the python log)

Added time difference to info display Changed some code for the rotation speed. Added a class to store data from previous frames. Added Oriented speed to infodisplay

Small changes to TimeDiff, to make the code more clean, and do less computations. Added Advanced Ghost Comp. (might still change a bit) Added a Bruteforcer (still wip)

ximk

Writing a pre-test review to make sure these comments are addressed prior to merge.

ximk · 2023-12-26T21:40:50Z

.gitignore

+scripts/Modules/test_del_me_later.py
+scripts/Modules/test.bit
+scripts/Modules/test_del_me_later.py
+scripts/Modules/test_del_me_later.py


Should be deleted prior to merge.

ximk · 2023-12-26T21:42:50Z

scripts/Modules/infodisplay.ini

@@ -0,0 +1,39 @@
+[DEBUG]
+debug = True


Entire file should be taken out of this PR prior to merge to avoid conflict.

ximk · 2023-12-26T21:44:28Z

scripts/Modules/mkw_utils.py

+# TODO: Time difference display helper functions
+"""The time difference functions.
+time_difference_[name](P1, S1, P2, S2) is a function that takes as arguments
+P1,S1 : Player1's Position and Speed vec3.
+P2,S2 : Player2's Position and Speed vec3
+Return the time it would take for Player1 to catch Player2 (not always symmetric)
+
+get_time_difference_[name](Player1, Player2) takes as arguments
+Player1 : Player1 ID
+Player2 : Player2 ID
+Return the time it would take for Player1 to catch Player2 (not always symmetric)
+It's the function called in draw_infodisplay.py
+"""


Is this WIP?

Dolphin will do this already, no need to clutter the PR with this.

ximk

These changes should appease the linter.

scripts/Modules/agc_lib.py

scripts/Modules/mkw_utils.py

scripts/RMC/Adv. Ghost Comp/Load_data.py

scripts/RMC/Adv. Ghost Comp/Save_to_file.py

scripts/RMC/_draw_info_display.py

scripts/Modules/agc_lib.py

vabold · 2023-12-27T15:46:05Z

scripts/AGC_Data/save your AGC data here.txt

If the purpose of this is to have a placeholder file to keep the folder, .gitkeep is the preferred name. Otherwise, messages or notes are best done in .txt or .md file bodies.

That's the only purpose of that text file, delete it if it's not needed

vabold · 2023-12-27T15:46:36Z

.gitignore

@@ -1 +1,2 @@
 /scripts/MKW_Inputs/*.csv
+scripts/AGC_Data/ghost.data


Consistency.

Suggested change

scripts/AGC_Data/ghost.data

/scripts/AGC_Data/ghost.data

vabold · 2023-12-27T15:48:20Z

scripts/Modules/TimeDifference information.txt

Avoid spaces in filenames. TimeDifferenceInfo.txt would be my pick.

Optionally, this can be improved via markdown.

vabold · 2023-12-27T15:49:38Z

scripts/Modules/agc_lib.py

+def float_to_str(f):
+    ms = round((f % 1)*1000)
+    s = math.floor(f) % 60
+    m = math.floor(f)//60
+    return f"{m},{s},{ms}"
+
+
+def floats_to_str(fs):
+    return f"{float_to_str(fs[0])};{float_to_str(fs[1])};{float_to_str(fs[2])}"


Old functions that i forgot to remove when I changed the implementation of TimerData. You can delete

vabold · 2023-12-27T15:54:33Z

scripts/Modules/agc_lib.py

+    return [(a+0x68, 12),  # Position
+            (a+0xF0, 16),  # Rotation
+            (a+0x74, 12),  # EV
+            (a+0x14C, 12),  # IV
+            (b+0x18, 4),  # MaxEngineSpd
+            (b+0x20, 4),  # EngineSpd
+            (b+0x9C, 4),  # OutsideDriftAngle
+            (b+0x5C, 12)]  # Dir


The problem is that these are blindly referenced (e.g. addr[0], addr[1], etc). There are two alternatives to solve this:

Return a dict with key-value pairs, where the keys are these comments

Create a dataclass with a static read method

I didn't know about static read method was a thing when i wrote that, that's why some init functions are a mess.
This class will probably be rewritten and merged with mkw_utils.FrameData at some point

vabold · 2023-12-27T15:59:16Z

scripts/Modules/mkw_classes/common.py

+    def __mul__(self, other):
+        """ vec3 * vec3 -> float (dot product)
+            vec3 * float -> vec3 (scalar multiplication)"""
+        if type(other) == vec3:
+            return self.x * other.x + self.y * other.y + self.z * other.z
+        else:
+            return vec3(self.x * other, self.y * other, self.z * other)


I'm not a fan of the ambiguous type return. It would likely be better to have a designated dot method.

if type(other) == vec3: return vec3(self.x * other.x, self.y * other.y, self.z * other.z) else: return vec3(self.x * other, self.y * other, self.z * other)

There are 3 types of vector multiplications useful in different context.
The dot product, which takes two vec3 and return a number (float typically)
The cross product, which takes two vec3 and return a vec3
The scalar multiplication, which takes a vec3 and a number, and return a vec3
But I knew only 2 multiplicatives token for python class (being "" and "@")
So I used "" for the dot product and the scalar multiplication, and "@" for the cross product and scalar multiplication.
If the ambiguous return type is really a problem, i'd rather have "*" for dot product, "@" for cross product, and a "scalarmult" method for the scalar multiplication.
But I don't mind this ambiguity personally, as it allow for some code very simple to read imo.

vabold · 2023-12-27T16:00:33Z

scripts/Modules/mkw_classes/common.py

+    def __matmul__(self, other):
+        """ vec3 @ vec3 -> vec3 (cross product)
+            vec3 @ float -> vec3 (scalar multiplication)"""        
+        if type(other) == vec3:
+            x = self.y*other.z - self.z*other.y
+            y = self.z*other.x - self.x*other.z
+            z = self.x*other.y - self.y*other.x
+            return vec3(x,y,z)
+        else:
+            return vec3(self.x * other, self.y * other, self.z * other)


Similarly, a designated cross method would also likely be better.

Out of curiosity, what is __matmul__?

The type ambiguity is less of a problem here since matmul always return a vec3 in this context

matmul is a class method, just like add or mul. It uses the token "@".
So you write a@b and it's interpreted as a.matmul(b)
Here it design the cross product

vabold · 2023-12-27T16:02:22Z

scripts/Modules/mkw_classes/common.py

+    @staticmethod
+    def from_bytes(bts) -> "vec3":
+        return vec3(*struct.unpack('>' + 'f'*3, bts))
+
+    def to_bytes(self) -> bytearray:
+        return bytearray(struct.pack('>fff', self.x, self.y, self.z))


Optional:

Suggested change

@staticmethod

def from_bytes(bts) -> "vec3":

return vec3(*struct.unpack('>' + 'f'*3, bts))

def to_bytes(self) -> bytearray:

return bytearray(struct.pack('>fff', self.x, self.y, self.z))

@staticmethod

def unpack(bts) -> "vec3":

return vec3(*struct.unpack('>' + 'f'*3, bts))

def pack(self) -> bytearray:

return bytearray(struct.pack('>' + 'f'*3, self.x, self.y, self.z))

vabold · 2023-12-27T16:04:10Z

scripts/Modules/mkw_utils.py


 # These are helper functions that don't quite fit in common.py
 # This file also contains getter functions for a few global variables.

 # NOTE (xi): wait for get_game_id() to be put in dolphin.memory before clearing
 #  these commented-out lines:

+
+class FrameData:


Could this potentially conflict with agc_lib.py?

It can conflict if you import both class with the same name.
Currently it's not an issue, but if soemone makes some script using both agc_lib and mkw_utils, it could be.
I'll eventually merge both class into the same class (currently, agc_lib.FrameData store values you can read in the memory, and mkw_utils.FrameData is more messy, but can store function from values you can read in the memory, and only used for the draw_info_display.)

vabold · 2023-12-27T16:05:44Z

scripts/RMC/Adv. Ghost Comp/Load_data.py

Please rename the folder to exclude non-alphanumeric characters (e.g. AdvGhostComp).

First attempt at implementing TTK with 7 columns

Blounard added 6 commits December 12, 2023 00:01

Rotation

69f600f

1st attempt at adding rotation to infodisplay. Unfinished. Mainly a test of using github

Rotation + Rotation speed

4617d83

Added rotation and rotation speed to the infodisplay. Should be ready to use.

info_display timediff

379a4e4

Added time difference to info display Changed some code for the rotation speed. Added a class to store data from previous frames. Added Oriented speed to infodisplay

TimeDiff Update + AGC + Bruteforcer

5059268

Small changes to TimeDiff, to make the code more clean, and do less computations. Added Advanced Ghost Comp. (might still change a bit) Added a Bruteforcer (still wip)

Added doc and removed personal files

d13686a

ximk requested changes Dec 26, 2023

View reviewed changes

Remove compiled code from PR.

dcc7f4c

Dolphin will do this already, no need to clutter the PR with this.

ximk force-pushed the main branch from 2e76bdd to dcc7f4c Compare December 26, 2023 22:03

ximk requested changes Dec 26, 2023

View reviewed changes

Appease linter

3215e26

ximk force-pushed the main branch from e2da46f to 3215e26 Compare December 26, 2023 22:58

ximk added 3 commits December 26, 2023 17:59

Update scripts/RMC/Adv. Ghost Comp/Load_data.py

5eea673

Appease linter

d7ddb70

github is being silly

2620cf6

ximk force-pushed the main branch from 9fc9aea to 2620cf6 Compare December 26, 2023 23:20

Final touches

70086c4

ximk approved these changes Dec 26, 2023

View reviewed changes

vabold requested changes Dec 27, 2023

View reviewed changes

Blounard added 2 commits April 8, 2024 01:53

Implemented the 7 column version of TTK

ffbfb20

First attempt at implementing TTK with 7 columns

Merge branch 'main' of https://github.com/Blounard/mkw-scripts

dc1cd2c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Info Display enhancement : Rotation, Rotation Speed, TimeDifference, Oriented Speed. #57

Info Display enhancement : Rotation, Rotation Speed, TimeDifference, Oriented Speed. #57

Blounard commented Dec 24, 2023 •

edited

Loading

ximk left a comment

ximk Dec 26, 2023

ximk Dec 26, 2023

ximk Dec 26, 2023

ximk left a comment

vabold Dec 27, 2023

Blounard Dec 27, 2023

vabold Dec 27, 2023

vabold Dec 27, 2023

vabold Dec 27, 2023

Blounard Dec 27, 2023

vabold Dec 27, 2023

Blounard Dec 27, 2023

vabold Dec 27, 2023

Blounard Dec 27, 2023

vabold Dec 27, 2023

Blounard Dec 27, 2023

vabold Dec 27, 2023

vabold Dec 27, 2023

Blounard Dec 27, 2023

vabold Dec 27, 2023

		@@ -1 +1,2 @@
		/scripts/MKW_Inputs/*.csv
		scripts/AGC_Data/ghost.data

Info Display enhancement : Rotation, Rotation Speed, TimeDifference, Oriented Speed. #57

Are you sure you want to change the base?

Info Display enhancement : Rotation, Rotation Speed, TimeDifference, Oriented Speed. #57

Conversation

Blounard commented Dec 24, 2023 • edited Loading

ximk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ximk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Blounard commented Dec 24, 2023 •

edited

Loading