cleanup inconsistencies and other minor issues in the readme #3
Conversation
| @@ -4,11 +4,7 @@ Beat Saber open replay format. | |||
|
|
|||
| # BSOR V1 | |||
|
|
|||
| - [C# code](https://github.com/BeatLeader/beatleader-mod/blob/master/Source/2_Core/Models/Replay.cs) | |||
| - [JS code](https://github.com/BeatLeader/BeatSaber-Web-Replays/blob/master/src/open-replay-decoder.js) | |||
There was a problem hiding this comment.
Why remove all the non-C# implementations?
README.md
Outdated
| trackingSytem; - string, tracking system type. (OpenVR, Oculus, etc.) | ||
| hmd; - string, headset type. (Oculus Quest, Valve Index, etc.) | ||
| controller; - string, controllers type. (Oculus touch, etc) | ||
| trackingSytem; - string, tracking system type. (OpenVR, Oculus, etc.). |
README.md
Outdated
| {x, y, z} - 3 floats, position. | ||
| {x, y, z, w} - 4 floats, rotation. | ||
| {x, y, z, w} - 4 floats, rotation (in quaternion form). |
There was a problem hiding this comment.
idk if it's necessary to specify when rotation has 4 floats and there are few more quaternions further the file
README.md
Outdated
| { x, y, z } - 3 floats, cut normal vector. | ||
| cutDistanceToCenter - float, distance from center of the cut. | ||
| cutAngle - float, angle of the cut. | ||
| beforeCutRating - float. |
There was a problem hiding this comment.
Angle rating before the cut, with after cut and cut distance forming 115 score. This beforeCutRating is uncapped (can go over 1) 1 means 70 score.
README.md
Outdated
| cutDistanceToCenter - float, distance from center of the cut. | ||
| cutAngle - float, angle of the cut. | ||
| beforeCutRating - float. | ||
| afterCutRating - float. |
There was a problem hiding this comment.
Angle rating after the cut, with before cut and cut distance forming 115 score. This afterCutRating is uncapped (can go over 1) 1 means 30 score.
README.md
Outdated
| cutDirDeviation - float, how far away the cut direction was from the one expected. | ||
| { x, y, z } - 3 floats, point at which the note was cut. | ||
| { x, y, z } - 3 floats, cut normal vector. | ||
| cutDistanceToCenter - float, distance from center of the cut. |
There was a problem hiding this comment.
distance from the center of the note to the cut plane, to get the score 15 * (1 - Clamp01(cutDistanceToCenter / 0.3f)). With before and after cuts forming 115 score
README.md
Outdated
| saberTypeOK - bool, note was hit with correct saber. | ||
| wasCutTooSoon - bool, note was cut too soon. | ||
| saberSpeed - float, speed of the saber. | ||
| { x, y, z } - 3 floats, direction of the saber. |
There was a problem hiding this comment.
Let's preserve the name of the property, as it's more specific and corresponds to the game name
{ x, y, z } - 3 floats, saberDir, direction of the saber.
README.md
Outdated
| saberType - int, type of the saber (0 = left, 1 = right). | ||
| timeDeviation - float, how far away the time hit was from the time expected. | ||
| cutDirDeviation - float, how far away the cut direction was from the one expected. | ||
| { x, y, z } - 3 floats, point at which the note was cut. |
|
regarding removing the non-C# implementations, the C++ link was broken and I assumed the other ones were too without actually checking. I've now reinstated the other implementations and fixed the C++ link. |
No description provided.