tickgym 1.0.0__tar.gz

tickgym-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 the TICK authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tickgym-1.0.0/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: tickgym
+Version: 1.0.0
+Summary: Drive Trackmania 2020 physics from Python through TICK: gyms for training agents on exact, restorable simulation.
+License-Expression: MIT
+Project-URL: Documentation, https://tm.achepta.com/tickgym/
+Project-URL: TICK, https://github.com/trackmania-input-control-kit/TickTasTool
+Keywords: trackmania,tas,reinforcement-learning,gym,tick
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.26
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Dynamic: license-file
+
+# TICKGYM
+
+Drive Trackmania 2020 physics from Python through TICK
+
+Open as many gyms as you want
+and run them in parallel.
+
+Documentation: <https://tm.achepta.com/tickgym/>
+
+## Install
+
+```
+pip install tickgym
+```
+
+TICK 3.0 must be installed and have been run once with the game. Python 3.11+
+
+## A first race
+
+```python
+from tickgym import Client, TelemetryGroup
+
+# TICK on this machine opens the map as a session.
+with Client().open_map(r"C:\Maps\Example.Map.Gbx") as session:
+    # One connection is one gym.
+    with session.connect(TelemetryGroup.RACE | TelemetryGroup.VEHICLE) as gym:
+        telemetry = gym.reset(seed=1)
+        telemetry = gym.step(200, accelerate=True)
+        print(telemetry.vehicle.speed, telemetry.vehicle.position)
+```
+
+The [quickstart](https://tm.achepta.com/tickgym/quickstart.html) continues from here: a control loop, snapshots,
+exact inputs, saving and replaying a race, etc.

tickgym-1.0.0/README.md

@@ -0,0 +1,33 @@
+# TICKGYM
+
+Drive Trackmania 2020 physics from Python through TICK
+
+Open as many gyms as you want
+and run them in parallel.
+
+Documentation: <https://tm.achepta.com/tickgym/>
+
+## Install
+
+```
+pip install tickgym
+```
+
+TICK 3.0 must be installed and have been run once with the game. Python 3.11+
+
+## A first race
+
+```python
+from tickgym import Client, TelemetryGroup
+
+# TICK on this machine opens the map as a session.
+with Client().open_map(r"C:\Maps\Example.Map.Gbx") as session:
+    # One connection is one gym.
+    with session.connect(TelemetryGroup.RACE | TelemetryGroup.VEHICLE) as gym:
+        telemetry = gym.reset(seed=1)
+        telemetry = gym.step(200, accelerate=True)
+        print(telemetry.vehicle.speed, telemetry.vehicle.position)
+```
+
+The [quickstart](https://tm.achepta.com/tickgym/quickstart.html) continues from here: a control loop, snapshots,
+exact inputs, saving and replaying a race, etc.

tickgym-1.0.0/pyproject.toml

@@ -0,0 +1,36 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tickgym"
+version = "1.0.0"
+description = "Drive Trackmania 2020 physics from Python through TICK: gyms for training agents on exact, restorable simulation."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+dependencies = ["numpy>=1.26"]
+keywords = ["trackmania", "tas", "reinforcement-learning", "gym", "tick"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX :: Linux",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+
+[project.urls]
+Documentation = "https://tm.achepta.com/tickgym/"
+TICK = "https://github.com/trackmania-input-control-kit/TickTasTool"
+
+[project.optional-dependencies]
+dev = ["pytest>=8"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+tickgym = ["py.typed"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

tickgym-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tickgym-1.0.0/src/tickgym/__init__.py

@@ -0,0 +1,65 @@
+from ._generated.enums import (
+    Effect,
+    ErrorCode,
+    GearShiftState,
+    HeldInput,
+    InputActionKind,
+    LidarHitFlag,
+    RaceFlag,
+    RayFrame,
+    TelemetryGroup,
+    VehicleType,
+    WaypointKind,
+    WheelFlag,
+)
+from .actions import Action
+from .client import (
+    Client,
+    Endpoint,
+    GameResourcePaths,
+    HostStatus,
+    GymSummary,
+    MapSummary,
+    Session,
+    SessionDetail,
+    SessionInfo,
+    SessionSummary,
+)
+from .errors import (
+    BadActionError,
+    BadEntryError,
+    CapacityError,
+    TickError,
+    GymError,
+    InternalError,
+    ProtocolError,
+    ProtocolVersionError,
+    SchemaMismatchError,
+    SessionUnknownError,
+    SnapshotLimitError,
+    SnapshotUnknownError,
+    TickGymError,
+    TransportError,
+)
+from .gym import Checkpoint, ExportedRace, Gym, GymInfo, MapInfo, Snapshot, Waypoint
+from .input_text import InputText, InputTextError
+from .lidar import Lidar, Ray
+from .telemetry import Drivetrain, Effects, Ellipsoid, LidarScan, Race, Runtime, Telemetry, Vehicle, Wheels
+from .types import BoolArray, FloatArray, IntArray, Quat, Vec3
+
+__version__ = "1.0.0"
+
+__all__ = [
+    "Client", "Session", "Gym", "GymInfo", "MapInfo", "Waypoint", "Checkpoint", "Snapshot", "ExportedRace",
+    "Endpoint", "MapSummary", "SessionInfo", "SessionSummary", "SessionDetail", "GymSummary", "HostStatus",
+    "GameResourcePaths",
+    "Telemetry", "Race", "Vehicle", "Drivetrain", "Wheels", "Effects", "Ellipsoid", "Runtime", "LidarScan",
+    "Vec3", "Quat", "FloatArray", "IntArray", "BoolArray",
+    "Action", "InputText", "InputTextError",
+    "Lidar", "Ray",
+    "TelemetryGroup", "RayFrame", "VehicleType", "InputActionKind", "Effect", "GearShiftState", "HeldInput", "RaceFlag",
+    "WheelFlag", "LidarHitFlag", "WaypointKind", "ErrorCode",
+    "TickGymError", "ProtocolError", "TransportError", "TickError", "GymError", "SessionUnknownError",
+    "ProtocolVersionError", "SchemaMismatchError", "CapacityError", "SnapshotUnknownError", "SnapshotLimitError",
+    "BadEntryError", "BadActionError", "InternalError",
+]

tickgym-1.0.0/src/tickgym/_generated/enums.py

@@ -0,0 +1,121 @@
+from enum import IntEnum, IntFlag
+
+
+class MessageKind(IntEnum):
+    OPEN = 1
+    RESET = 2
+    STEP = 3
+    SNAPSHOT = 4
+    RESTORE = 5
+    DISCARD = 6
+    QUERY = 7
+    EXPORT = 8
+    CHECKPOINTS = 9
+    HELLO = 128
+    TELEMETRY = 129
+    SNAPSHOTTED = 130
+    LIDAR_SCAN = 131
+    EXPORTED = 132
+    ACK = 133
+    ERROR = 134
+    CHECKPOINT_LIST = 135
+
+
+class ErrorCode(IntEnum):
+    SESSION_UNKNOWN = 1
+    PROTOCOL_VERSION = 2
+    SCHEMA_MISMATCH = 3
+    CAPACITY = 4
+    SNAPSHOT_UNKNOWN = 5
+    SNAPSHOT_LIMIT = 6
+    BAD_ENTRY = 7
+    BAD_ACTION = 8
+    INTERNAL = 9
+    BAD_MESSAGE = 10
+
+
+class TelemetryGroup(IntFlag):
+    NONE = 0
+    RACE = 1
+    VEHICLE = 2
+    DRIVETRAIN = 4
+    WHEELS = 8
+    EFFECTS = 16
+    SHAPE = 32
+    RUNTIME = 64
+    LIDAR = 128
+    ALL = 255
+
+
+class HeldInput(IntFlag):
+    NONE = 0
+    ACCELERATE = 1
+    BRAKE = 2
+
+
+class RaceFlag(IntFlag):
+    NONE = 0
+    FINISHED = 1
+    ENTERED_OFF_ZONE = 2
+
+
+class WheelFlag(IntFlag):
+    NONE = 0
+    CONTACT = 1
+
+
+class LidarHitFlag(IntFlag):
+    NONE = 0
+    HIT = 1
+
+
+class WaypointKind(IntEnum):
+    CHECKPOINT = 1
+    FINISH = 2
+    MULTILAP = 3
+
+
+class RayFrame(IntEnum):
+    CAR = 0
+    WORLD = 1
+
+
+class InputActionKind(IntEnum):
+    ACCELERATE = 1
+    BRAKE = 2
+    STEER = 3
+    SEED = 4
+    RESPAWN = 5
+    FLAGS = 6
+    STANDING_RESPAWN = 7
+    GAME_SPEED = 8
+
+
+class VehicleType(IntEnum):
+    STADIUM = 0
+    SNOW = 1
+    RALLY = 2
+    DESERT = 3
+
+
+class GearShiftState(IntEnum):
+    TAKE_OFF = 0
+    TAKE_OFF_SETTLING = 1
+    SHIFTING = 2
+    TRACKING = 3
+    REVERSE_TAKE_OFF = 4
+    BURNOUT_OVERRIDE = 5
+
+
+class Effect(IntEnum):
+    REACTOR_BOOST_UP = 0
+    REACTOR_BOOST_DOWN = 1
+    TURBO = 2
+    SUPER_TURBO = 3
+    ENGINE_OFF = 4
+    FRAGILE = 5
+    NO_STEERING = 6
+    NO_BRAKES = 7
+    NO_GRIP = 8
+    SLOW_MOTION = 9
+    CRUISE_CONTROL = 10