| Name | league-of-legends-decoded-replay-packets-gym JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | A Gymnasium environment for League of Legends decoded replay packets, enabling esports research, AI development, and gameplay analysis. |
| upload_time | 2025-09-03 04:06:53 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | 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
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
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.
|
| keywords |
league-of-legends
esports
ai
reinforcement-learning
gymnasium
replay-analysis
gaming
neural-networks
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# League of Legends Decoded Replay Packets Gym 🏋️♀️
# Disclaimer
This work isn’t endorsed by Riot Games and doesn’t reflect the views or opinions of Riot Games or anyone officially involved in producing or managing League of Legends. League of Legends and Riot Games are trademarks or registered trademarks of Riot Games, Inc.
**A Gymnasium Environment for League of Legends Decoded Replay Packets**
[](https://badge.fury.io/py/league-of-legends-decoded-replay-packets-gym)
[](https://www.python.org/downloads/)
[](https://opensource.org/licenses/MIT)
A high-performance **Gymnasium environment** for League of Legends replay analysis, AI development, and esports research. Access decoded replay packets from professional matches with a simple, standardized interface.
## 🚀 Quick Start
```bash
pip install league-of-legends-decoded-replay-packets-gym
```
```python
import league_of_legends_decoded_replay_packets_gym as lol_gym
# Load professional replay data from HuggingFace
dataset = lol_gym.ReplayDataset([
"12_22/" # Download entire patch directory
], repo_id="maknee/league-of-legends-decoded-replay-packets")
# Or specific files
dataset = lol_gym.ReplayDataset([
"12_22/batch_001.jsonl.gz", # Professional matches from patch 12.22
"12_22/batch_002.jsonl.gz"
], repo_id="maknee/league-of-legends-decoded-replay-packets")
dataset.load(max_games=10) # Load first 10 games
# Create Gymnasium environment
env = lol_gym.LeagueReplaysEnv(dataset, time_step=1.0)
obs, info = env.reset()
print(f"🎮 Loaded game {info['game_id']}")
print(f"⏰ Starting at time: {info['current_time']:.1f}s")
# Step through decoded replay packets
for step in range(100):
obs, reward, terminated, truncated, info = env.step(0) # Continue action
game_state = info['game_state']
if game_state.heroes:
print(f"Step {step}: t={game_state.current_time:.1f}s, "
f"heroes={len(game_state.heroes)}, "
f"events={len(game_state.events)}")
# Access decoded packet data
for net_id, hero in list(game_state.heroes.items())[:3]:
pos = game_state.get_position(net_id)
if pos:
print(f" {hero.get('name', 'Hero')}: ({pos.x:.0f}, {pos.z:.0f})")
if terminated or truncated:
print("🏁 Game ended, resetting...")
obs, info = env.reset()
env.close()
```
## 🎯 Features
- **🏃♂️ Gymnasium Interface**: Standard RL environment for easy integration
- **⚡ High Performance**: Rust-accelerated replay parsing with Python fallback
- **📊 Professional Data**: Access to decoded packets from real esports matches
- **🧠 AI Ready**: Includes neural network examples (OpenLeague5)
- **🔧 Flexible Observations**: Minimap, positional, event-based, and custom observations
- **🎮 Real Game Data**: Professional tournament replays from HuggingFace
## 📚 Data Sources
### HuggingFace Dataset (Primary)
The main data source is [maknee/league-of-legends-decoded-replay-packets](https://huggingface.co/datasets/maknee/league-of-legends-decoded-replay-packets):
```python
# Available datasets
dataset = lol_gym.ReplayDataset([
"12_22/", # Entire patch directory
"worlds_2022/", # Entire tournament directory
"13_1/batch_001.jsonl.gz" # Specific file
], repo_id="maknee/league-of-legends-decoded-replay-packets")
# Individual files also supported
dataset = lol_gym.ReplayDataset([
"12_22/batch_001.jsonl.gz", # Pro matches, patch 12.22
"12_22/batch_002.jsonl.gz", # More pro matches
"worlds_2022/semifinals.jsonl.gz", # Championship matches
"worlds_2022/finals.jsonl.gz" # Grand finals
], repo_id="maknee/league-of-legends-decoded-replay-packets")
```
### Local Files
```python
# Use your own replay files
dataset = lol_gym.ReplayDataset(["local_replay.jsonl.gz"])
```
## 🤖 AI Examples
### Champion Movement Visualization
```python
from league_of_legends_decoded_replay_packets_gym.examples.champion_gif_generator import ChampionGifGenerator
# Create animated GIF of champion movements
dataset = lol_gym.ReplayDataset(
["worlds_2022/finals.jsonl.gz"],
repo_id="maknee/league-of-legends-decoded-replay-packets"
)
dataset.load(max_games=1)
generator = ChampionGifGenerator()
generator.create_gif(
dataset=dataset,
output_path="worlds_final_movements.gif",
max_time_minutes=5,
fps=6
)
```
### Action Prediction with OpenLeague5
```python
from league_of_legends_decoded_replay_packets_gym.examples.openleague5 import OpenLeague5Model
# Load professional data
dataset = lol_gym.ReplayDataset(
["12_22/"], # Download entire patch directory
repo_id="maknee/league-of-legends-decoded-replay-packets"
)
dataset.load(max_games=1)
# Create environment and jump to 15 minutes
env = lol_gym.LeagueReplaysEnv(dataset)
obs, info = env.reset()
# Step to 15 minutes (900 seconds)
while info['current_time'] < 900:
obs, reward, terminated, truncated, info = env.step(0)
if terminated or truncated:
break
# AI predicts what players will do next
model = OpenLeague5Model()
game_state = info['game_state']
prediction = model.predict_next_action(game_state, temperature=1.0)
print(f"🔮 AI Prediction: {prediction.get_action_description()}")
print(f" Confidence: {prediction.confidence:.3f}")
```
```bash
🎯 Prediction Results:
==============================
Action: Use W Ability
Confidence: 0.354
State Value: -0.681
Target Position: (7266, 3750) world coords
Coordinate Confidence: X=0.158, Y=0.080
Unit Target: 0
Unit Confidence: 1.000
✅ Prediction completed successfully!
```
## 🔧 Advanced Usage
### Custom Observations
```python
from league_of_legends_decoded_replay_packets_gym.observations import MinimapObservation
# Create 128x128 minimap observation
minimap_obs = MinimapObservation(
resolution=128,
channels=['heroes', 'minions', 'structures']
)
env = lol_gym.LeagueReplaysEnv(dataset, observation_callback=minimap_obs)
obs, info = env.reset()
print(f"Minimap shape: {obs['minimap'].shape}") # [3, 128, 128]
```
### Raw Parser Access
```python
# Direct access to replay parsing
parser = lol_gym.UnifiedLeagueParser()
result = parser.parse_file("replay.jsonl.gz")
print(f"Parsed {result.games_parsed} games")
print(f"Total events: {result.total_events}")
print(f"Method used: {result.method_used}")
```
### Multi-Environment Training
```python
# Multiple parallel environments for RL training
manager = lol_gym.MultiEnvManager(dataset, num_envs=4)
states = manager.reset()
for epoch in range(100):
# Step all environments in parallel
results = manager.step()
for i, (obs, reward, terminated, truncated, info) in enumerate(results):
if terminated or truncated:
print(f"Environment {i} finished game")
```
## 🛠️ Installation Options
```bash
# Basic installation (core gym environment)
pip install league-of-legends-decoded-replay-packets-gym
# With AI examples (includes PyTorch, matplotlib)
pip install league-of-legends-decoded-replay-packets-gym[ai]
# Development installation
pip install league-of-legends-decoded-replay-packets-gym[dev]
# Everything
pip install league-of-legends-decoded-replay-packets-gym[all]
```
## 🎮 Command Line Interface
```bash
# Basic gym environment demo
league-gym env --data "12_22/batch_001.jsonl.gz" --steps 100
# Parse replay files directly
league-gym parse local_replay.jsonl.gz
# AI prediction demo
league-gym ai predict --model openleague5 --time 900 --data "worlds_2022/finals.jsonl.gz"
# Generate champion movement GIF
league-gym viz movement --data "12_22/batch_001.jsonl.gz" --output movements.gif
```
## 📁 Examples
All examples are included in the package and have their own documentation:
### 🎯 [OpenLeague5 AI System](league_of_legends_decoded_replay_packets_gym/examples/openleague5/)
Neural network system for action prediction, inspired by OpenAI Five and AlphaStar.
### 📊 [Champion Movement Visualizer](league_of_legends_decoded_replay_packets_gym/examples/champion_gif_generator/)
Generate animated GIFs showing champion positioning over time.
See [`examples/README.md`](league_of_legends_decoded_replay_packets_gym/examples/README.md) for a complete overview.
## 🏗️ Architecture
### Gymnasium Environment
- **Observation Space**: Configurable (positions, minimap, events, custom)
- **Action Space**: Discrete actions (continue, skip, jump to time)
- **Reward Function**: Customizable based on research needs
- **Info Dict**: Rich game state with decoded packet access
### Game State Access
```python
game_state = info['game_state']
# Core information
game_state.current_time # Game time in seconds
game_state.heroes # All heroes {net_id: hero_info}
game_state.positions # All positions {net_id: Position}
game_state.events # Recent events [GameEvent]
# Convenience methods
game_state.get_heroes_by_team('ORDER') # Team filtering
game_state.get_heroes_in_radius(pos, 1000) # Spatial queries
game_state.get_events_by_type('CastSpellAns') # Event filtering
```
### Packet Types
The environment provides access to decoded packet data including:
- `CreateHero`: Hero spawn events
- `WaypointGroup`: Movement and positioning
- `CastSpellAns`: Ability usage
- `UnitApplyDamage`: Combat events
- `BuyItem`: Item purchases
- `HeroDie`: Elimination events
## 🎓 Research Applications
- **Esports Analytics**: Analyze professional gameplay patterns
- **AI Development**: Train League of Legends playing agents
- **Reinforcement Learning**: Standard gym environment for RL research
- **Behavioral Analysis**: Study decision-making in competitive gaming
- **Meta-game Research**: Track strategic evolution across patches
## 🤝 Contributing
Contributions are welcome! Please see the examples for adding new analysis tools or AI models.
```bash
# Development setup
git clone https://github.com/your-org/league-of-legends-decoded-replay-packets-gym.git
cd league-of-legends-decoded-replay-packets-gym
pip install -e .[dev]
# Run tests
python -m pytest
# Format code
black league_of_legends_decoded_replay_packets_gym/
```
## 📄 License
MIT License - see [LICENSE](LICENSE) file for details.
## 🙏 Acknowledgments
- **Riot Games** for League of Legends
- **Professional Players** for the gameplay data
- **maknee** for decoded replay packet dataset
- **Gymnasium Project** for the RL environment standard
- **OpenAI & DeepMind** for AI research inspiration
---
**Ready to analyze professional League of Legends gameplay?** 🚀
```bash
pip install league-of-legends-decoded-replay-packets-gym
```
Raw data
{
"_id": null,
"home_page": null,
"name": "league-of-legends-decoded-replay-packets-gym",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "league-of-legends, esports, ai, reinforcement-learning, gymnasium, replay-analysis, gaming, neural-networks",
"author": null,
"author_email": "League Parser Team <parser@league.com>",
"download_url": "https://files.pythonhosted.org/packages/6f/c2/62c29a70fc95d243a90e710f57cd358b16c546b6235818d59524a6693156/league_of_legends_decoded_replay_packets_gym-0.1.2.tar.gz",
"platform": null,
"description": "# League of Legends Decoded Replay Packets Gym \ud83c\udfcb\ufe0f\u200d\u2640\ufe0f\n\n# Disclaimer\n\nThis work isn\u2019t endorsed by Riot Games and doesn\u2019t reflect the views or opinions of Riot Games or anyone officially involved in producing or managing League of Legends. League of Legends and Riot Games are trademarks or registered trademarks of Riot Games, Inc.\n\n**A Gymnasium Environment for League of Legends Decoded Replay Packets**\n\n[](https://badge.fury.io/py/league-of-legends-decoded-replay-packets-gym)\n[](https://www.python.org/downloads/)\n[](https://opensource.org/licenses/MIT)\n\nA high-performance **Gymnasium environment** for League of Legends replay analysis, AI development, and esports research. Access decoded replay packets from professional matches with a simple, standardized interface.\n\n## \ud83d\ude80 Quick Start\n\n```bash\npip install league-of-legends-decoded-replay-packets-gym\n```\n\n```python\nimport league_of_legends_decoded_replay_packets_gym as lol_gym\n\n# Load professional replay data from HuggingFace\ndataset = lol_gym.ReplayDataset([\n \"12_22/\" # Download entire patch directory\n], repo_id=\"maknee/league-of-legends-decoded-replay-packets\")\n\n# Or specific files\ndataset = lol_gym.ReplayDataset([\n \"12_22/batch_001.jsonl.gz\", # Professional matches from patch 12.22\n \"12_22/batch_002.jsonl.gz\"\n], repo_id=\"maknee/league-of-legends-decoded-replay-packets\")\n\ndataset.load(max_games=10) # Load first 10 games\n\n# Create Gymnasium environment\nenv = lol_gym.LeagueReplaysEnv(dataset, time_step=1.0)\nobs, info = env.reset()\n\nprint(f\"\ud83c\udfae Loaded game {info['game_id']}\")\nprint(f\"\u23f0 Starting at time: {info['current_time']:.1f}s\")\n\n# Step through decoded replay packets\nfor step in range(100):\n obs, reward, terminated, truncated, info = env.step(0) # Continue action\n \n game_state = info['game_state']\n \n if game_state.heroes:\n print(f\"Step {step}: t={game_state.current_time:.1f}s, \"\n f\"heroes={len(game_state.heroes)}, \"\n f\"events={len(game_state.events)}\")\n \n # Access decoded packet data\n for net_id, hero in list(game_state.heroes.items())[:3]:\n pos = game_state.get_position(net_id)\n if pos:\n print(f\" {hero.get('name', 'Hero')}: ({pos.x:.0f}, {pos.z:.0f})\")\n \n if terminated or truncated:\n print(\"\ud83c\udfc1 Game ended, resetting...\")\n obs, info = env.reset()\n\nenv.close()\n```\n\n## \ud83c\udfaf Features\n\n- **\ud83c\udfc3\u200d\u2642\ufe0f Gymnasium Interface**: Standard RL environment for easy integration\n- **\u26a1 High Performance**: Rust-accelerated replay parsing with Python fallback\n- **\ud83d\udcca Professional Data**: Access to decoded packets from real esports matches\n- **\ud83e\udde0 AI Ready**: Includes neural network examples (OpenLeague5)\n- **\ud83d\udd27 Flexible Observations**: Minimap, positional, event-based, and custom observations\n- **\ud83c\udfae Real Game Data**: Professional tournament replays from HuggingFace\n\n## \ud83d\udcda Data Sources\n\n### HuggingFace Dataset (Primary)\nThe main data source is [maknee/league-of-legends-decoded-replay-packets](https://huggingface.co/datasets/maknee/league-of-legends-decoded-replay-packets):\n\n```python\n# Available datasets\ndataset = lol_gym.ReplayDataset([\n \"12_22/\", # Entire patch directory\n \"worlds_2022/\", # Entire tournament directory \n \"13_1/batch_001.jsonl.gz\" # Specific file\n], repo_id=\"maknee/league-of-legends-decoded-replay-packets\")\n\n# Individual files also supported\ndataset = lol_gym.ReplayDataset([\n \"12_22/batch_001.jsonl.gz\", # Pro matches, patch 12.22\n \"12_22/batch_002.jsonl.gz\", # More pro matches\n \"worlds_2022/semifinals.jsonl.gz\", # Championship matches\n \"worlds_2022/finals.jsonl.gz\" # Grand finals\n], repo_id=\"maknee/league-of-legends-decoded-replay-packets\")\n```\n\n### Local Files\n```python\n# Use your own replay files\ndataset = lol_gym.ReplayDataset([\"local_replay.jsonl.gz\"])\n```\n\n## \ud83e\udd16 AI Examples\n\n### Champion Movement Visualization\n\n\n\n```python\nfrom league_of_legends_decoded_replay_packets_gym.examples.champion_gif_generator import ChampionGifGenerator\n\n# Create animated GIF of champion movements\ndataset = lol_gym.ReplayDataset(\n [\"worlds_2022/finals.jsonl.gz\"],\n repo_id=\"maknee/league-of-legends-decoded-replay-packets\"\n)\ndataset.load(max_games=1)\n\ngenerator = ChampionGifGenerator()\ngenerator.create_gif(\n dataset=dataset,\n output_path=\"worlds_final_movements.gif\",\n max_time_minutes=5,\n fps=6\n)\n```\n\n### Action Prediction with OpenLeague5\n```python\nfrom league_of_legends_decoded_replay_packets_gym.examples.openleague5 import OpenLeague5Model\n\n# Load professional data \ndataset = lol_gym.ReplayDataset(\n [\"12_22/\"], # Download entire patch directory\n repo_id=\"maknee/league-of-legends-decoded-replay-packets\"\n)\ndataset.load(max_games=1)\n\n# Create environment and jump to 15 minutes\nenv = lol_gym.LeagueReplaysEnv(dataset)\nobs, info = env.reset()\n\n# Step to 15 minutes (900 seconds)\nwhile info['current_time'] < 900:\n obs, reward, terminated, truncated, info = env.step(0)\n if terminated or truncated:\n break\n\n# AI predicts what players will do next\nmodel = OpenLeague5Model()\ngame_state = info['game_state']\n\nprediction = model.predict_next_action(game_state, temperature=1.0)\nprint(f\"\ud83d\udd2e AI Prediction: {prediction.get_action_description()}\")\nprint(f\" Confidence: {prediction.confidence:.3f}\")\n```\n\n```bash\n\ud83c\udfaf Prediction Results:\n==============================\nAction: Use W Ability\nConfidence: 0.354\nState Value: -0.681\nTarget Position: (7266, 3750) world coords\nCoordinate Confidence: X=0.158, Y=0.080\nUnit Target: 0\nUnit Confidence: 1.000\n\u2705 Prediction completed successfully!\n```\n\n## \ud83d\udd27 Advanced Usage\n\n### Custom Observations\n```python\nfrom league_of_legends_decoded_replay_packets_gym.observations import MinimapObservation\n\n# Create 128x128 minimap observation\nminimap_obs = MinimapObservation(\n resolution=128, \n channels=['heroes', 'minions', 'structures']\n)\n\nenv = lol_gym.LeagueReplaysEnv(dataset, observation_callback=minimap_obs)\nobs, info = env.reset()\n\nprint(f\"Minimap shape: {obs['minimap'].shape}\") # [3, 128, 128]\n```\n\n### Raw Parser Access\n```python\n# Direct access to replay parsing\nparser = lol_gym.UnifiedLeagueParser()\nresult = parser.parse_file(\"replay.jsonl.gz\")\n\nprint(f\"Parsed {result.games_parsed} games\")\nprint(f\"Total events: {result.total_events}\")\nprint(f\"Method used: {result.method_used}\")\n```\n\n### Multi-Environment Training\n```python\n# Multiple parallel environments for RL training\nmanager = lol_gym.MultiEnvManager(dataset, num_envs=4)\nstates = manager.reset()\n\nfor epoch in range(100):\n # Step all environments in parallel\n results = manager.step()\n \n for i, (obs, reward, terminated, truncated, info) in enumerate(results):\n if terminated or truncated:\n print(f\"Environment {i} finished game\")\n```\n\n## \ud83d\udee0\ufe0f Installation Options\n\n```bash\n# Basic installation (core gym environment)\npip install league-of-legends-decoded-replay-packets-gym\n\n# With AI examples (includes PyTorch, matplotlib)\npip install league-of-legends-decoded-replay-packets-gym[ai]\n\n# Development installation\npip install league-of-legends-decoded-replay-packets-gym[dev]\n\n# Everything\npip install league-of-legends-decoded-replay-packets-gym[all]\n```\n\n## \ud83c\udfae Command Line Interface\n\n```bash\n# Basic gym environment demo\nleague-gym env --data \"12_22/batch_001.jsonl.gz\" --steps 100\n\n# Parse replay files directly\nleague-gym parse local_replay.jsonl.gz\n\n# AI prediction demo\nleague-gym ai predict --model openleague5 --time 900 --data \"worlds_2022/finals.jsonl.gz\"\n\n# Generate champion movement GIF\nleague-gym viz movement --data \"12_22/batch_001.jsonl.gz\" --output movements.gif\n```\n\n## \ud83d\udcc1 Examples\n\nAll examples are included in the package and have their own documentation:\n\n### \ud83c\udfaf [OpenLeague5 AI System](league_of_legends_decoded_replay_packets_gym/examples/openleague5/)\nNeural network system for action prediction, inspired by OpenAI Five and AlphaStar.\n\n### \ud83d\udcca [Champion Movement Visualizer](league_of_legends_decoded_replay_packets_gym/examples/champion_gif_generator/)\nGenerate animated GIFs showing champion positioning over time.\n\nSee [`examples/README.md`](league_of_legends_decoded_replay_packets_gym/examples/README.md) for a complete overview.\n\n## \ud83c\udfd7\ufe0f Architecture\n\n### Gymnasium Environment\n- **Observation Space**: Configurable (positions, minimap, events, custom)\n- **Action Space**: Discrete actions (continue, skip, jump to time)\n- **Reward Function**: Customizable based on research needs\n- **Info Dict**: Rich game state with decoded packet access\n\n### Game State Access\n```python\ngame_state = info['game_state']\n\n# Core information\ngame_state.current_time # Game time in seconds\ngame_state.heroes # All heroes {net_id: hero_info}\ngame_state.positions # All positions {net_id: Position}\ngame_state.events # Recent events [GameEvent]\n\n# Convenience methods\ngame_state.get_heroes_by_team('ORDER') # Team filtering\ngame_state.get_heroes_in_radius(pos, 1000) # Spatial queries \ngame_state.get_events_by_type('CastSpellAns') # Event filtering\n```\n\n### Packet Types\nThe environment provides access to decoded packet data including:\n- `CreateHero`: Hero spawn events\n- `WaypointGroup`: Movement and positioning\n- `CastSpellAns`: Ability usage\n- `UnitApplyDamage`: Combat events\n- `BuyItem`: Item purchases\n- `HeroDie`: Elimination events\n\n## \ud83c\udf93 Research Applications\n\n- **Esports Analytics**: Analyze professional gameplay patterns\n- **AI Development**: Train League of Legends playing agents\n- **Reinforcement Learning**: Standard gym environment for RL research \n- **Behavioral Analysis**: Study decision-making in competitive gaming\n- **Meta-game Research**: Track strategic evolution across patches\n\n## \ud83e\udd1d Contributing\n\nContributions are welcome! Please see the examples for adding new analysis tools or AI models.\n\n```bash\n# Development setup\ngit clone https://github.com/your-org/league-of-legends-decoded-replay-packets-gym.git\ncd league-of-legends-decoded-replay-packets-gym\npip install -e .[dev]\n\n# Run tests\npython -m pytest\n\n# Format code\nblack league_of_legends_decoded_replay_packets_gym/\n```\n\n## \ud83d\udcc4 License\n\nMIT License - see [LICENSE](LICENSE) file for details.\n\n## \ud83d\ude4f Acknowledgments\n\n- **Riot Games** for League of Legends\n- **Professional Players** for the gameplay data\n- **maknee** for decoded replay packet dataset\n- **Gymnasium Project** for the RL environment standard\n- **OpenAI & DeepMind** for AI research inspiration\n\n---\n\n**Ready to analyze professional League of Legends gameplay?** \ud83d\ude80\n\n```bash\npip install league-of-legends-decoded-replay-packets-gym\n```\n",
"bugtrack_url": null,
"license": "Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n \n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n \n 1. Definitions.\n \n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n \n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n \n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n \n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n \n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n \n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n \n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n \n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n \n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n \n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n \n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n \n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n \n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n \n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n \n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n \n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n \n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n \n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n \n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n \n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n \n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n \n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n \n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n \n END OF TERMS AND CONDITIONS\n \n APPENDIX: How to apply the Apache License to your work.\n \n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n \n Copyright [yyyy] [name of copyright owner]\n \n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n ",
"summary": "A Gymnasium environment for League of Legends decoded replay packets, enabling esports research, AI development, and gameplay analysis.",
"version": "0.1.2",
"project_urls": {
"Bug Tracker": "https://github.com/Maknee/league-of-legends-decoded-replay-packets-gym/issues",
"Documentation": "https://github.com/Maknee/league-of-legends-decoded-replay-packets-gym/blob/main/README.md",
"Homepage": "https://github.com/Maknee/league-of-legends-decoded-replay-packets-gym",
"Repository": "https://github.com/Maknee/league-of-legends-decoded-replay-packets-gym"
},
"split_keywords": [
"league-of-legends",
" esports",
" ai",
" reinforcement-learning",
" gymnasium",
" replay-analysis",
" gaming",
" neural-networks"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "31fa94bf9e50abad4bfcd491ec21a5e833ba28ff156509a32c463340b84d581a",
"md5": "9865261e40992cbd2c7cc821491346a0",
"sha256": "66cc5cbe22667ce75bbee42003b9bfa72622558e2ad312f555e9fcbaf0d1e012"
},
"downloads": -1,
"filename": "league_of_legends_decoded_replay_packets_gym-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9865261e40992cbd2c7cc821491346a0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 45754,
"upload_time": "2025-09-03T04:06:52",
"upload_time_iso_8601": "2025-09-03T04:06:52.114879Z",
"url": "https://files.pythonhosted.org/packages/31/fa/94bf9e50abad4bfcd491ec21a5e833ba28ff156509a32c463340b84d581a/league_of_legends_decoded_replay_packets_gym-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6fc262c29a70fc95d243a90e710f57cd358b16c546b6235818d59524a6693156",
"md5": "0e38feee29378dc3048008e6bb1b9782",
"sha256": "a53aa91ba86a0f14141eee771cd66033685ffcb6236e35227336f58bc0f71893"
},
"downloads": -1,
"filename": "league_of_legends_decoded_replay_packets_gym-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "0e38feee29378dc3048008e6bb1b9782",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 47010,
"upload_time": "2025-09-03T04:06:53",
"upload_time_iso_8601": "2025-09-03T04:06:53.102995Z",
"url": "https://files.pythonhosted.org/packages/6f/c2/62c29a70fc95d243a90e710f57cd358b16c546b6235818d59524a6693156/league_of_legends_decoded_replay_packets_gym-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-03 04:06:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Maknee",
"github_project": "league-of-legends-decoded-replay-packets-gym",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "league-of-legends-decoded-replay-packets-gym"
}
