Update README with examples

Author: VirxEC

README.md

@@ -6,6 +6,75 @@ A Python module implemented in Rust for serializing and deserializing RLBot's fl
 
 To provide a fast, safe, and easy to use Python module for serializing and deserializing RLBot's flatbuffers.
 
-A majority of the code is generated in the `build.rs` upon first compile and thrown into `src/`.
+A majority of the code is generated in the `build.rs` upon first compile and thrown into `src/python`.
 
-This includes the code generated by `flac`, the Python wrapper binds to the generated Rust code, and the Python type hints.
+This includes the code generated by `flatc` (living in `src/generated`), the Python wrapper binds to the generated Rust code, and the Python type hints (`rlbot_flatbuffers.pyi`).
+
+### Basic usage
+
+All classes and methods should have types hints readable by your IDE, removing the guesswork of common operations.
+
+#### Creating
+
+```python
+import rlbot_flatbuffers as flat
+
+desired_ball = flat.DesiredBallState(
+    physics=flat.Physics(
+        location=flat.Vector3Partial(z=200),
+        velocity=flat.Vector3Partial(x=1500, y=1500),
+        angular_velocity=flat.Vector3Partial(),
+    ),
+)
+
+desired_game_info = flat.DesiredGameInfoState(
+    world_gravity_z=-100,
+    game_speed=2,
+)
+
+desired_game_state = flat.DesiredGameState(
+    ball_state=desired_ball,
+    game_info_state=desired_game_info,
+)
+```
+
+In the above code, we:
+
+- Set the ball to:
+  - Location (0, 0, 200)
+  - Velocity (1500, 1500, 0)
+  - Angular velocity of (0, 0, 0)
+- Don't set the car states
+- Set the game info state:
+  - World gravity to -100
+  - Game speed to 2x default
+  - Don't set end match or paused
+- Don't set any console commands
+
+All values are optional when creating a class and have the proper defaults.
+
+#### Reading values
+
+```python
+def handle_packet(packet: flat.GameTickPacket):
+    if packet.game_info.game_state_type not in {
+        flat.GameStateType.Active,
+        flat.GameStateType.Kickoff,
+    }:
+        # Return early if the game isn't active
+        return
+
+    # Print the ball's location
+    print(packet.ball.physics.location)
+
+    for car in packet.players:
+        # Print the every car's location
+        print(car.physics.location)
+```
+
+The goal of the above was to feel familiar to RLBot v4 while providing a more Pythonic interface.
+
+- All enum types are hashable and can be used in a set, allowing for easy checks against them.
+- Every class implements `__str__`, `__repr__`, and `__hash__` methods.
+  - All enums also implement `__int__` and `__richcmp__`.
+- Lists no longer have `num_x` fields accompanying them, they are just Python lists of the appropriate length.

build.rs

@@ -1364,16 +1364,18 @@ fn pyi_generator(type_data: &[(String, String, Vec<Vec<String>>)]) -> io::Result
                 }
             }
 
-            file_contents.push(Cow::Borrowed(""));
-
-            if is_enum {
+            if types.is_empty() {
+                file_contents.push(Cow::Borrowed("    def __init__(self): ..."));
+            } else if is_enum {
+                file_contents.push(Cow::Borrowed(""));
                 file_contents.push(Cow::Borrowed("    def __init__(self, value: int = 0):"));
                 file_contents.push(Cow::Borrowed("        \"\"\""));
                 file_contents.push(Cow::Borrowed(
                     "        :raises ValueError: If the `value` is not a valid enum value",
                 ));
-                file_contents.push(Cow::Borrowed("        \"\"\""));
+                file_contents.push(Cow::Borrowed("        \"\"\"\n"));
             } else {
+                file_contents.push(Cow::Borrowed(""));
                 file_contents.push(Cow::Borrowed("    def __init__("));
                 file_contents.push(Cow::Borrowed("        self,"));
 
@@ -1407,7 +1409,7 @@ fn pyi_generator(type_data: &[(String, String, Vec<Vec<String>>)]) -> io::Result
                     };
 
                     let python_type = &python_types[i];
-                    file_contents.push(Cow::Owned(format!("        {variable_name}: {python_type}={default_value},")));
+                    file_contents.push(Cow::Owned(format!("        {variable_name}: {python_type} = {default_value},")));
 
                     i += 1;
                 }

pytest.py

@@ -21,7 +21,7 @@ def __add__(self, other):
     print()
 
     dgs = DesiredGameState(
-        game_info_state=DesiredGameInfoState(game_speed=Float(1), end_match=Bool())
+        game_info_state=DesiredGameInfoState(game_speed=2, end_match=Bool())
     )
     dgs.game_info_state.world_gravity_z = Float(-650)
     dgs.game_info_state.end_match.val = True