# AoE2ScenarioParser
`AoE2ScenarioParser` is a [Python] library that allows you to edit `aoe2scenario` files from **every** version of
**Age of Empires 2 Definitive Edition**.
[Python]: https://www.python.org/
# Getting Started
Installing using `pip`:
```sh
pip install AoE2ScenarioParser
```
More documentation about installing etc. can be found below.
## Documentation
Documentation for installation, usage, examples, cheatsheets and API docs can be found on **[GitHub Pages]**.
[GitHub Pages]: https://ksneijders.github.io/AoE2ScenarioParser/
## Quick links
- **[Installing]** → A quick guide on how to install `AoE2ScenarioParser`
- **[Hello World Example]** → Step-by-step guide to get you going
- **[Discord Server]** → For questions about `AoE2ScenarioParser`, [Python] or scenarios in general.
- **[API Docs]** → Technical documentation for all exposed functions & classes
[Installing]: https://ksneijders.github.io/AoE2ScenarioParser/installation/
[Hello World Example]: https://ksneijders.github.io/AoE2ScenarioParser/hello_world/
[Discord Server]: https://discord.gg/DRUtmugXT3
[API Docs]: https://ksneijders.github.io/AoE2ScenarioParser/api_docs/aoe2_scenario/
# Discord
If you have any questions regarding `AoE2ScenarioParser`? [Join the discord]!
[Join the discord]: https://discord.gg/DRUtmugXT3
# Support
**Every Single Scenario Version from Age of Empires 2 Definitive Edition is SUPPORTED!**
> Support: `1.36` _Version at Release (November 14th, 2019)_ → `1.54` _Current Version (Since: October 14, 2024)_
Every single version of **Age of Empires 2 Definitive Edition** is supported!
If a new version of **Age of Empires 2 Definitive Edition** just released it can take a bit for it to be able to be read.
Check the [Discord Server] for more up-to-date information if this is the case.
If you find a scenario which can be opened by the game itself, but results in an error when using `AoE2ScenarioParser`,
please report it as an issue or in the **#bug‑reports** channel in the [Discord Server].
> ⚠️ To view the full-blown support table previously shown in this README, visit: [support].
[support]: https://github.com/KSneijders/AoE2ScenarioParser/blob/master/resources/md/support.md
# Progress
Every related change to the library is documented and can be found in the [CHANGELOG].
[changelog]: https://github.com/KSneijders/AoE2ScenarioParser/blob/dev/CHANGELOG.md
## Features:
`AoE2ScenarioParser` allows you to edit **anything** inside a scenario.
For general usability "managers" have been created to make working with the files easier.
These managers allow you to quickly change aspects of units, triggers, the map, player data and more!
Below is a simplified overview of some of the features:
| | Inspect | Add | Edit | Remove |
|------------|-------------------|-----|------|--------|
| Triggers | ✔️ | ✔️ | ✔️ | ✔️ |
| Conditions | ✔️ | ✔️ | ✔️ | ✔️ |
| Effects | ✔️ | ✔️ | ✔️ | ✔️ |
| Units | ✔️ | ✔️ | ✔️ | ✔️ |
| Map | n/a *<sup>1</sup> | ✔️ | ✔️ | ✔️ |
| Players | n/a *<sup>1</sup> | ✔️* | ✔️ | ✔️* |
| Messages | n/a | ✔️ | ✔️ | ✔️ |
*: You can disable or enable players like in the in-game editor (min 1, max 8).
*<sup>1</sup>: There's no specific inspection function. Though, they can still be printed with clean formatting.
# Authors
- [Kerwin Sneijders](https://github.com/KSneijders) (Main Author)
- [Alian713](https://github.com/Divy1211) (Dataset Wizard)
# License
MIT License: Please see the [LICENSE file].
[license file]: https://github.com/KSneijders/AoE2ScenarioParser/blob/dev/LICENSE
Raw data
{
"_id": null,
"home_page": null,
"name": "AoE2ScenarioParser",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Kerwin Sneijders <ksneijders-dev@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/14/59/988070be6393ff0dccddd7ccd6f8c7a6e596b8a8df0c1614dbb8ad18d68e/aoe2scenarioparser-0.2.14.tar.gz",
"platform": null,
"description": "# AoE2ScenarioParser\n\n`AoE2ScenarioParser` is a [Python] library that allows you to edit `aoe2scenario` files from **every** version of \n **Age of Empires 2 Definitive Edition**.\n\n[Python]: https://www.python.org/\n\n# Getting Started\n\nInstalling using `pip`:\n\n```sh\npip install AoE2ScenarioParser\n```\n\nMore documentation about installing etc. can be found below.\n\n## Documentation\n\nDocumentation for installation, usage, examples, cheatsheets and API docs can be found on **[GitHub Pages]**.\n\n[GitHub Pages]: https://ksneijders.github.io/AoE2ScenarioParser/\n\n## Quick links\n\n- **[Installing]** \u2192 A quick guide on how to install `AoE2ScenarioParser`\n- **[Hello World Example]** \u2192 Step-by-step guide to get you going\n- **[Discord Server]** \u2192 For questions about `AoE2ScenarioParser`, [Python] or scenarios in general. \n- **[API Docs]** \u2192 Technical documentation for all exposed functions & classes\n\n[Installing]: https://ksneijders.github.io/AoE2ScenarioParser/installation/\n[Hello World Example]: https://ksneijders.github.io/AoE2ScenarioParser/hello_world/\n[Discord Server]: https://discord.gg/DRUtmugXT3\n[API Docs]: https://ksneijders.github.io/AoE2ScenarioParser/api_docs/aoe2_scenario/\n\n# Discord\n\nIf you have any questions regarding `AoE2ScenarioParser`? [Join the discord]!\n\n[Join the discord]: https://discord.gg/DRUtmugXT3\n\n# Support\n\n**Every Single Scenario Version from Age of Empires 2 Definitive Edition is SUPPORTED!** \n\n> Support: `1.36` _Version at Release (November 14th, 2019)_ \u2192 `1.54` _Current Version (Since: October 14, 2024)_\n\nEvery single version of **Age of Empires 2 Definitive Edition** is supported! \nIf a new version of **Age of Empires 2 Definitive Edition** just released it can take a bit for it to be able to be read. \nCheck the [Discord Server] for more up-to-date information if this is the case.\n\nIf you find a scenario which can be opened by the game itself, but results in an error when using `AoE2ScenarioParser`, \nplease report it as an issue or in the **#bug\u2011reports** channel in the [Discord Server].\n\n> \u26a0\ufe0f To view the full-blown support table previously shown in this README, visit: [support]. \n\n[support]: https://github.com/KSneijders/AoE2ScenarioParser/blob/master/resources/md/support.md\n\n# Progress\n\nEvery related change to the library is documented and can be found in the [CHANGELOG].\n\n[changelog]: https://github.com/KSneijders/AoE2ScenarioParser/blob/dev/CHANGELOG.md\n\n## Features:\n\n`AoE2ScenarioParser` allows you to edit **anything** inside a scenario. \nFor general usability \"managers\" have been created to make working with the files easier. \nThese managers allow you to quickly change aspects of units, triggers, the map, player data and more!\n\nBelow is a simplified overview of some of the features:\n\n| | Inspect | Add | Edit | Remove |\n|------------|-------------------|-----|------|--------|\n| Triggers | \u2714\ufe0f | \u2714\ufe0f | \u2714\ufe0f | \u2714\ufe0f |\n| Conditions | \u2714\ufe0f | \u2714\ufe0f | \u2714\ufe0f | \u2714\ufe0f |\n| Effects | \u2714\ufe0f | \u2714\ufe0f | \u2714\ufe0f | \u2714\ufe0f |\n| Units | \u2714\ufe0f | \u2714\ufe0f | \u2714\ufe0f | \u2714\ufe0f |\n| Map | n/a *<sup>1</sup> | \u2714\ufe0f | \u2714\ufe0f | \u2714\ufe0f |\n| Players | n/a *<sup>1</sup> | \u2714\ufe0f* | \u2714\ufe0f | \u2714\ufe0f* |\n| Messages | n/a | \u2714\ufe0f | \u2714\ufe0f | \u2714\ufe0f |\n\n*: You can disable or enable players like in the in-game editor (min 1, max 8). \n*<sup>1</sup>: There's no specific inspection function. Though, they can still be printed with clean formatting.\n\n# Authors\n\n- [Kerwin Sneijders](https://github.com/KSneijders) (Main Author)\n- [Alian713](https://github.com/Divy1211) (Dataset Wizard)\n\n# License\n\nMIT License: Please see the [LICENSE file].\n\n[license file]: https://github.com/KSneijders/AoE2ScenarioParser/blob/dev/LICENSE\n",
"bugtrack_url": null,
"license": null,
"summary": "This is a project for editing parts of an 'aoe2scenario' file from Age of Empires 2 Definitive Edition",
"version": "0.2.14",
"project_urls": {
"API Docs": "https://ksneijders.github.io/AoE2ScenarioParser/api_docs/aoe2_scenario/",
"Bug Tracker": "https://github.com/KSneijders/AoE2ScenarioParser/issues",
"Changelog": "https://github.com/KSneijders/AoE2ScenarioParser/blob/master/CHANGELOG.md",
"Documentation": "https://ksneijders.github.io/AoE2ScenarioParser/",
"Homepage": "https://github.com/KSneijders/AoE2ScenarioParser"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "93e63da75e2ddd548c0365be5ebc38b7848f1bf1752b67e10c2e67882d96172c",
"md5": "92b94b89c679d7f9b531dbb64e73a573",
"sha256": "a3e1bb914683d7e79bf781b9912794524e2935db7ebdc25dee418f74ade6d08b"
},
"downloads": -1,
"filename": "AoE2ScenarioParser-0.2.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "92b94b89c679d7f9b531dbb64e73a573",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 415430,
"upload_time": "2025-01-11T13:10:54",
"upload_time_iso_8601": "2025-01-11T13:10:54.929955Z",
"url": "https://files.pythonhosted.org/packages/93/e6/3da75e2ddd548c0365be5ebc38b7848f1bf1752b67e10c2e67882d96172c/AoE2ScenarioParser-0.2.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1459988070be6393ff0dccddd7ccd6f8c7a6e596b8a8df0c1614dbb8ad18d68e",
"md5": "dd02e7a080a62448206e87241b121dca",
"sha256": "31f2d7b5b11083603853e63f670f8b4a530a719eb7cf44b1180dd40ca2790d1c"
},
"downloads": -1,
"filename": "aoe2scenarioparser-0.2.14.tar.gz",
"has_sig": false,
"md5_digest": "dd02e7a080a62448206e87241b121dca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 341117,
"upload_time": "2025-01-11T13:10:57",
"upload_time_iso_8601": "2025-01-11T13:10:57.533322Z",
"url": "https://files.pythonhosted.org/packages/14/59/988070be6393ff0dccddd7ccd6f8c7a6e596b8a8df0c1614dbb8ad18d68e/aoe2scenarioparser-0.2.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-11 13:10:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "KSneijders",
"github_project": "AoE2ScenarioParser",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "deprecation",
"specs": [
[
"==",
"2.1.0"
]
]
},
{
"name": "typing_extensions",
"specs": [
[
"==",
"4.12.2"
]
]
},
{
"name": "ordered-set",
"specs": [
[
"==",
"4.1.0"
]
]
}
],
"lcname": "aoe2scenarioparser"
}
JSON
