# wap
[](https://github.com/t-mart/wap/actions/workflows/ci.yml)
[](https://pypi.org/project/wow-addon-packager/)
A developer-friendly World of Warcraft addon packager.
## Features
- [Builds](https://t-mart.github.io/wap/commands/build/) Retail, Classic,
Vanilla addons (or all three!)
- [Publishes](https://t-mart.github.io/wap/commands/publish/) your addons to CurseForge
- [Generates valid TOC files](https://t-mart.github.io/wap/toc-gen/) automagically
- [Continuously rebuilds](https://t-mart.github.io/wap/commands/build/#-watch) your addon during
development
- Sets up new addon projects quickly, ready to go with one
[command](https://t-mart.github.io/wap/commands/new-project/)
- Consolidates all configuration in
[one easy-to-edit file](https://t-mart.github.io/wap/configuration)
- Supports and is tested on Windows, macOS, and Linux
- Has awesome [documentation](https://t-mart.github.io/wap/)
## wap in 5 minutes
These instructions create and upload a working addon without editing a single line of code!
1. Download and install [Python 3.11](https://www.python.org/downloads/).
2. Install `wap`:
```console
pip install --upgrade --user wow-addon-packager
```
3. Create a new a project:
```console
wap new-project
```
And then, answer the prompts. Don't worry too much about your answers -- you can always change
them later in your configuration file.
4. Change to your new project's directory. For example, if you named it `MyAddon` in the last step,
you'd type:
```console
cd MyAddon
```
5. Build your addon package and link it to your local World of Warcraft installation:
```console
wap build --link
```
At this point, **you can play the game with your addon**.
6. Upload your addon to CurseForge with your
[API token](https://authors.curseforge.com/account/api-tokens) so that others can use it:
```console
wap publish --curseforge-token "<api-token>"
```
## Project Information
- License: MIT
- PyPI: <https://pypi.org/project/wow-addon-packager/>
- Source Code: <https://github.com/t-mart/wap>
- Documentation: <https://t-mart.github.io/wap/>
- GitHub Action: <https://github.com/t-mart/wap-action>
- Supported Python Versions: 3.11 and later
- Badge: [](https://github.com/t-mart/wap)
- Contribution Guide: <https://t-mart.github.io/wap/contributing>
Raw data
{
"_id": null,
"home_page": "https://github.com/t-mart/wap",
"name": "wow-addon-packager",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": "World of Warcraft, WoW, Addons",
"author": "Tim Martin",
"author_email": "tim@timmart.in",
"download_url": "https://files.pythonhosted.org/packages/83/8e/d91752f234b828d44e438f8b40c5c7f02c95c585df0673bb0920dea73869/wow_addon_packager-0.12.0.tar.gz",
"platform": null,
"description": "# wap\n\n[](https://github.com/t-mart/wap/actions/workflows/ci.yml)\n[](https://pypi.org/project/wow-addon-packager/)\n\nA developer-friendly World of Warcraft addon packager.\n\n\n\n## Features\n\n- [Builds](https://t-mart.github.io/wap/commands/build/) Retail, Classic,\n Vanilla addons (or all three!)\n- [Publishes](https://t-mart.github.io/wap/commands/publish/) your addons to CurseForge\n- [Generates valid TOC files](https://t-mart.github.io/wap/toc-gen/) automagically\n- [Continuously rebuilds](https://t-mart.github.io/wap/commands/build/#-watch) your addon during\n development\n- Sets up new addon projects quickly, ready to go with one\n [command](https://t-mart.github.io/wap/commands/new-project/)\n- Consolidates all configuration in\n [one easy-to-edit file](https://t-mart.github.io/wap/configuration)\n- Supports and is tested on Windows, macOS, and Linux\n- Has awesome [documentation](https://t-mart.github.io/wap/)\n\n## wap in 5 minutes\n\nThese instructions create and upload a working addon without editing a single line of code!\n\n1. Download and install [Python 3.11](https://www.python.org/downloads/).\n\n2. Install `wap`:\n\n ```console\n pip install --upgrade --user wow-addon-packager\n ```\n\n3. Create a new a project:\n\n ```console\n wap new-project\n ```\n\n And then, answer the prompts. Don't worry too much about your answers -- you can always change\n them later in your configuration file.\n\n4. Change to your new project's directory. For example, if you named it `MyAddon` in the last step,\n you'd type:\n\n ```console\n cd MyAddon\n ```\n\n5. Build your addon package and link it to your local World of Warcraft installation:\n\n ```console\n wap build --link\n ```\n\n At this point, **you can play the game with your addon**.\n\n6. Upload your addon to CurseForge with your\n [API token](https://authors.curseforge.com/account/api-tokens) so that others can use it:\n\n ```console\n wap publish --curseforge-token \"<api-token>\"\n ```\n\n## Project Information\n\n- License: MIT\n- PyPI: <https://pypi.org/project/wow-addon-packager/>\n- Source Code: <https://github.com/t-mart/wap>\n- Documentation: <https://t-mart.github.io/wap/>\n- GitHub Action: <https://github.com/t-mart/wap-action>\n- Supported Python Versions: 3.11 and later\n- Badge: [](https://github.com/t-mart/wap)\n- Contribution Guide: <https://t-mart.github.io/wap/contributing>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A developer-friendly World of Warcraft addon packager",
"version": "0.12.0",
"project_urls": {
"Documentation": "https://t-mart.github.io/wap/",
"Homepage": "https://github.com/t-mart/wap",
"Repository": "https://github.com/t-mart/wap"
},
"split_keywords": [
"world of warcraft",
" wow",
" addons"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aec9bde03db85f0aae5acb8535e63889e0189f686a0b2fc3b44c17afb24a2ee5",
"md5": "983c5c60247b005c4337655d3523026b",
"sha256": "99b183346c097bd10c61d6ce33a2fa0f972020754f54a1f1a14c2be23b85e45d"
},
"downloads": -1,
"filename": "wow_addon_packager-0.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "983c5c60247b005c4337655d3523026b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 30465,
"upload_time": "2024-05-28T21:23:48",
"upload_time_iso_8601": "2024-05-28T21:23:48.130301Z",
"url": "https://files.pythonhosted.org/packages/ae/c9/bde03db85f0aae5acb8535e63889e0189f686a0b2fc3b44c17afb24a2ee5/wow_addon_packager-0.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "838ed91752f234b828d44e438f8b40c5c7f02c95c585df0673bb0920dea73869",
"md5": "dc62c496c230dbe842fb6c83ec2fced4",
"sha256": "e2ffd295623ed631254e199b0bb80baa7a9f06b87fe21bff66f1ec913075338c"
},
"downloads": -1,
"filename": "wow_addon_packager-0.12.0.tar.gz",
"has_sig": false,
"md5_digest": "dc62c496c230dbe842fb6c83ec2fced4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 25026,
"upload_time": "2024-05-28T21:23:49",
"upload_time_iso_8601": "2024-05-28T21:23:49.351081Z",
"url": "https://files.pythonhosted.org/packages/83/8e/d91752f234b828d44e438f8b40c5c7f02c95c585df0673bb0920dea73869/wow_addon_packager-0.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-28 21:23:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "t-mart",
"github_project": "wap",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "wow-addon-packager"
}
JSON
