brawlgym 0.1.0__tar.gz

brawlgym-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 chrisrca
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

brawlgym-0.1.0/MANIFEST.in

@@ -0,0 +1 @@
+include LICENSE

brawlgym-0.1.0/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: brawlgym
+Version: 0.1.0
+Summary: A python API that can be used to treat the game Brawlhalla as an OpenAI Gym-like environment for Reinforcement Learning projects.
+Home-page: https://github.com/chrisrca/brawlgym
+Author: chrisrca
+License: Apache 2.0
+Keywords: brawlhalla,gym,reinforcement-learning
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Python: ==3.11.*
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.19
+Requires-Dist: py7zr>=0.20
+Requires-Dist: pycaw>=20220416
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# The Brawlhalla Gym
+
+This is a python API that can be used to treat the game [Brawlhalla](https://www.brawlhalla.com) as
+though it were an [OpenAI Gym](https://gym.openai.com)-style environment for Reinforcement Learning
+projects. It is heavily inspired by [RLGym](https://rlgym.org/), and the component model will be
+familiar if you have used it.
+
+## Requirements
+* A Windows 10 or 11 PC
+* Brawlhalla (Steam)
+* Python 3.9 or newer
+* `brawlgym_core`, the engine bridge — **not yet available**
+
+## Installation
+Install the library via pip:
+```
+pip install brawlgym
+```
+
+## Usage
+Wiki coming soon...

brawlgym-0.1.0/README.md

@@ -0,0 +1,21 @@
+# The Brawlhalla Gym
+
+This is a python API that can be used to treat the game [Brawlhalla](https://www.brawlhalla.com) as
+though it were an [OpenAI Gym](https://gym.openai.com)-style environment for Reinforcement Learning
+projects. It is heavily inspired by [RLGym](https://rlgym.org/), and the component model will be
+familiar if you have used it.
+
+## Requirements
+* A Windows 10 or 11 PC
+* Brawlhalla (Steam)
+* Python 3.9 or newer
+* `brawlgym_core`, the engine bridge — **not yet available**
+
+## Installation
+Install the library via pip:
+```
+pip install brawlgym
+```
+
+## Usage
+Wiki coming soon...

brawlgym-0.1.0/brawlgym/__init__.py

@@ -0,0 +1,81 @@
+"""
+brawlgym - a reinforcement-learning environment for Brawlhalla.
+
+Match drives a live game instance in deterministic lockstep, and you plug
+in your own ObsBuilder / RewardFunction / TerminalCondition / ActionParser / StateSetter.
+
+    import brawlgym
+
+    env = brawlgym.make()
+    env.connect()                # game running, match started
+    obs = env.reset()
+    while True:
+        obs, rewards, done, state = env.step(actions)
+        if done:
+            obs = env.reset()
+
+Package layout:
+    brawlgym.envs                       Match
+    brawlgym.utils.gamestates           GameState, PlayerData, ItemData
+    brawlgym.utils.obs_builders         ObsBuilder, DefaultObs
+    brawlgym.utils.reward_functions     RewardFunction, common rewards
+    brawlgym.utils.terminal_conditions  TerminalCondition, TeamWipe/Timeout
+    brawlgym.utils.action_parsers       ActionParser, DefaultAction, LookupAction
+    brawlgym.utils.state_setters        StateSetter, Default/Random
+"""
+from .envs import Match
+from .utils.action_parsers import ActionParser, DefaultAction, LookupAction
+from .utils.gamestates import GameState, ItemData, PlayerData
+from .utils.obs_builders import DefaultObs, ObsBuilder
+from .utils.reward_functions import CombinedReward, ConstantReward, DamageDealtReward, DamageTakenPenalty, KOReward, RewardFunction
+from .utils.state_setters import DefaultStateSetter, RandomStateSetter, StateSetter
+from .utils.terminal_conditions import TeamWipeCondition, TerminalCondition, TimeoutCondition
+from .version import __version__
+
+
+def make(**kwargs) -> Match:
+    """
+    Create a Match with default components (override any via kwargs).
+    """
+    return Match(**kwargs)
+
+
+def inject(game_dir=None, refresh=False):
+    """
+    Patch the local Brawlhalla install with the hook built for its exact game build,
+    fetching it if not already cached. Run once before launching the game for training.
+    """
+    from . import patcher
+    return patcher.inject(game_dir=game_dir, refresh=refresh)
+
+
+def set_map(name):
+    """
+    Lock the game to one map. Written to disk; takes effect at the next launch.
+    """
+    from .envs.match import brawlgym_core
+    return brawlgym_core.set_map(name)
+
+
+def restore_maps():
+    """
+    Undo set_map and put the pristine map set back.
+    """
+    from .envs.match import brawlgym_core
+    return brawlgym_core.restore_maps()
+
+
+def list_maps():
+    """
+    [(level_id, level_name)] - every map usable as make(map_name=...).
+    """
+    from .envs.match import brawlgym_core
+    return brawlgym_core.list_maps()
+
+
+def list_legends():
+    """
+    [(hero_id, hero_name, bio_name)] - every legend usable in make(legends=[...]).
+    """
+    from .envs.match import brawlgym_core
+    return brawlgym_core.list_legends()

brawlgym-0.1.0/brawlgym/core/__init__.py

@@ -0,0 +1,3 @@
+"""
+Compiled engine bridge (brawlgym_core). Closed-source binary from brawlgym-core.
+"""

brawlgym-0.1.0/brawlgym/envs/__init__.py

@@ -0,0 +1 @@
+from .match import Match

brawlgym-0.1.0/brawlgym/envs/match.py

@@ -0,0 +1,216 @@
+"""
+Drives a live Brawlhalla instance in deterministic lockstep: every `step()` advances the
+simulation exactly `tick_skip` frames with inputs applied, then returns the resulting
+state.
+
+Requires the `brawlgym_core` engine module and a running, injected game instance.
+"""
+from __future__ import annotations
+
+import time
+from typing import Any, List, Optional, Sequence
+
+from ..utils.action_parsers import ActionParser, DefaultAction
+from ..utils.gamestates import GameState
+from ..utils.obs_builders import DefaultObs, ObsBuilder
+from ..utils.reward_functions import CombinedReward, DamageDealtReward, KOReward, RewardFunction
+from ..utils.state_setters import DefaultStateSetter, StateSetter
+from ..utils.terminal_conditions import TeamWipeCondition, TerminalCondition, TimeoutCondition
+
+try:
+    from ..core import brawlgym_core      # engine bridge, shipped inside the package
+except ImportError:                       # pragma: no cover
+    try:
+        import brawlgym_core              # dev: built alongside, found on sys.path
+    except ImportError as _e:
+        brawlgym_core = None
+        _core_import_error = _e
+
+
+# TODO: constants file
+DEFAULT_MAP = "SmallBrawlhaven"   # every match needs a locked map to start
+DEFAULT_TURBO_FPS = 30.0          # render-frame rate used when realtime=False; steps run between
+                                  # frames, so a low rate leaves the most room for them
+
+
+class Match:
+    """
+    Gym style match over a live game instance.
+    """
+
+    def __init__(self,
+                 obs_builder: Optional[ObsBuilder] = None,
+                 reward_function: Optional[RewardFunction] = None,
+                 terminal_conditions: Optional[Sequence[TerminalCondition]] = None,
+                 action_parser: Optional[ActionParser] = None,
+                 state_setter: Optional[StateSetter] = None,
+                 tick_skip: int = 8,
+                 realtime: bool = False,
+                 render_fps: Optional[float] = None,
+                 fps: float = 60.0,
+                 n_players: int = 2,
+                 legends: Optional[Sequence[Any]] = None,
+                 map_name: Optional[str] = None,
+                 auto_minimize: bool = False,
+                 auto_mute: bool = False,
+                 host: str = "127.0.0.1",
+                 port: int = 8790):
+        if brawlgym_core is None:
+            raise ImportError(
+                "brawlgym requires the brawlgym_core engine module; install it and ensure it is importable") from _core_import_error
+        self.obs_builder = obs_builder or DefaultObs()
+        self.reward_function = reward_function or CombinedReward(
+            [DamageDealtReward(), KOReward(ko_reward=200.0, death_penalty=200.0)])
+        self.terminal_conditions: List[TerminalCondition] = list(
+            terminal_conditions if terminal_conditions is not None
+            else [TeamWipeCondition(), TimeoutCondition(1200)])
+        self.action_parser = action_parser or DefaultAction()
+        self.state_setter = state_setter or DefaultStateSetter()
+        self.tick_skip = int(tick_skip)
+        self.realtime = bool(realtime)
+        self.render_fps = render_fps
+        self.fps = float(fps)   # native sim rate for wall-clock pacing
+        self.n_players = int(n_players)
+        # per-slot legends (HeroIDs or names)
+        # team 1: 0,2,4,6
+        # team 2: 1,3,5,7
+        # None = the engine's default roster.
+        self.legends: Optional[List[int]] = self._resolve_legends(legends) if legends else None
+        # A match cannot start without a locked map
+        # map_name=None uses small brawlhaven
+        self.map_name = map_name or DEFAULT_MAP
+        self.auto_minimize = bool(auto_minimize)
+        self.auto_mute = bool(auto_mute)
+        self.map_info = brawlgym_core.get_map_geometry(self.map_name)
+        for comp in (self.obs_builder, self.state_setter):
+            if hasattr(comp, "set_map_info"):
+                comp.set_map_info(self.map_info)
+        # NOTE: the engine's internal `framems` stays at 25ms regardless of fps - it is the
+        # forced-step owed-time, chosen so exactly ONE 60fps frame runs per step (floor math
+        # needs it in [16.7, 33.3)); it does not affect game speed.
+
+        self._bridge = brawlgym_core.HookBridge(host, port)
+        self._state: Optional[GameState] = None
+        self._prev_actions: Optional[Sequence[Any]] = None
+
+    @staticmethod
+    def _resolve_legends(legends: Sequence[Any]) -> List[int]:
+        """
+        Resolve a mixed list of HeroIDs and legend names to HeroIDs.
+        """
+        ids: List[int] = []
+        table = None
+        for item in legends:
+            if isinstance(item, str):
+                if table is None:
+                    if not hasattr(brawlgym_core, "list_legends"):
+                        raise ValueError("cannot resolve legend names pass numeric HeroIDs instead")
+                    table = {}
+                    for hid, hero_name, bio_name in brawlgym_core.list_legends():
+                        table[str(hero_name).lower()] = int(hid)
+                        if bio_name:
+                            table[str(bio_name).lower()] = int(hid)
+                key = item.lower()
+                if key not in table:
+                    raise ValueError("unknown legend %r" % item)
+                ids.append(table[key])
+            else:
+                ids.append(int(item))
+        return ids
+
+    def connect(self, timeout: float = 300.0) -> GameState:
+        """
+        Wait for the game, then for a running match; enable sit-out-on-death.
+
+        The game must be launched and a match started. Returns the first observed state.
+        """
+        print("[brawlgym] waiting for the game ...", flush=True)
+        self._bridge.wait_for_hook(timeout)
+        # roster size + legends for the auto-started match specified before the party forms
+        self._bridge.set_player_count(self.n_players)
+        if self.legends:
+            self._bridge.set_legends(self.legends)
+        st = self._wait_for_match(timeout)
+        if self.realtime:
+            self._bridge.configure(1, 25.0)     # 1x speed, rendered (native 60fps free-run)
+        else:
+            self._bridge.configure(max(16, self.tick_skip * 2), 25.0)
+        target = self.render_fps
+        if target is None and not self.realtime:
+            target = DEFAULT_TURBO_FPS
+        if target:
+            self._bridge.set_render_fps(float(target))
+            print("[brawlgym] render fps -> %g" % target, flush=True)
+        self._bridge.set_sitout(True)           # deaths sit out until reset()
+        self._state = st
+        print("[brawlgym] match up: %d fighters" % len(st.players), flush=True)
+        from ..gamelaunch import window         # matches by window title / process name (single instance)
+        if self.auto_minimize:
+            window.minimize_title("Brawlhalla")
+        if window.pycaw_available():
+            window.mute_name("Brawlhalla.exe", mute=self.auto_mute)
+        elif self.auto_mute:
+            print("[brawlgym] pycaw not installed - cannot mute (pip install pycaw)")
+        return st
+
+    def _wait_for_match(self, timeout: float) -> GameState:
+        """
+        Poll until fighters exist.
+        """
+        t_end = time.time() + timeout
+        while time.time() < t_end:
+            try:
+                st = GameState(self._bridge.get_state())
+                players = st.players
+                if len(players) >= 2 and all(p.x > -5000 for p in players):
+                    return st
+            except Exception:
+                try:
+                    self._bridge.wait_for_hook(30)
+                except Exception:
+                    pass
+            time.sleep(1.0)
+        raise TimeoutError("no running match detected - start a match in the game")
+
+    def close(self) -> None:
+        self._bridge.close()
+
+    @property
+    def n_agents(self) -> int:
+        return len(self._state.players) if self._state else 0
+
+    def reset(self) -> List[Any]:
+        """
+        Revive + reposition every fighter, reset all components, return initial obs.
+        """
+        if self._state is None:
+            self.connect()
+        n = len(self._state.players)
+        positions = [(int(round(x)), int(round(y)))
+                     for x, y in self.state_setter.build_positions(n)]
+        st = GameState(self._bridge.reset(positions))
+        self._state = st
+        self._prev_actions = None
+        self.obs_builder.reset(st)
+        self.reward_function.reset(st)
+        for tc in self.terminal_conditions:
+            tc.reset(st)
+        # noop previous action
+        zero_act = [0.0] * self.action_parser.get_action_space_size()
+        return [self.obs_builder.build_obs(p, st, zero_act) for p in st.players]
+
+    def step(self, actions: Sequence[Any]):
+        """
+        Advance tick_skip frames with the given per-agent actions.
+
+        Returns (observations, rewards, terminated, game_state).
+        """
+        masks = self.action_parser.parse_actions(actions, self._state)
+        st = GameState(self._bridge.step(masks, self.tick_skip))
+        self._state = st
+        self._prev_actions = actions
+        obs = [self.obs_builder.build_obs(p, st, a) for p, a in zip(st.players, actions)]
+        rewards = [self.reward_function.get_reward(p, st, a)
+                   for p, a in zip(st.players, actions)]
+        terminated = any(tc.is_terminal(st) for tc in self.terminal_conditions)
+        return obs, rewards, terminated, st

brawlgym-0.1.0/brawlgym/gamelaunch/__init__.py

@@ -0,0 +1,6 @@
+"""
+brawlgym.gamelaunch - boot Brawlhalla instances for training.
+"""
+from .launch import DEFAULT_BASE_PORT, find_brawlhalla_dir, launch_instances
+
+__all__ = ["launch_instances", "find_brawlhalla_dir", "DEFAULT_BASE_PORT"]