Added readme and license

This commit is contained in:
bepis
2026-09-30 23:30:18 +10:00
parent a1869feff6
commit 87b0f54968
2 changed files with 95 additions and 0 deletions
+21
View File
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2026 Drink_Bepis
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.
+74
View File
@@ -0,0 +1,74 @@
# Quest Expand All
A small World of Warcraft addon that adds an **expand/collapse all** button to the quest log, so you can open or close every zone header in one click instead of only getting the zone you're currently in.
Built for **World of Warcraft Forever** using the retail UI API. Interface version `16001`.
<!-- Add screenshots here, e.g.:
![Quest log with the +/- All button](docs/button.png)
-->
## Features
- **Toggle button** next to the quest counter: `+ All` expands every zone header, `- All` collapses them.
- **Configurable startup behaviour**, applied each time the map/quest log opens:
- **Default**: Blizzard's standard behaviour (only the current zone is expanded)
- **Always collapsed**
- **Always expanded**
- **Right-click the button** for a quick context menu to change the mode.
- **Options panel** under *Options → AddOns → Quest Expand All* with the same setting.
- Resizes the quest log search box so the button fits alongside it.
## Installation
1. Download or clone this repository.
2. Make sure the folder is named `QuestExpandAll` (it must match the `.toc` file name).
3. Copy it into your game's addons directory:
```
<WoW install>/Interface/AddOns/QuestExpandAll/
```
4. Fully restart the game (or at least fully log out/in). This is required for a first-time run.
Your folder should look like this:
```
QuestExpandAll/
├── QuestExpandAll.toc
├── QuestExpandAll.lua
└── README.md
```
## Usage
| Action | Result |
| --- | --- |
| Left-click the button | Expand or collapse all zone headers |
| Right-click the button | Open the mode context menu |
| Options → AddOns → Quest Expand All | Choose the startup mode from a dropdown |
## Configuration
Settings are stored per account in the `QuestExpandAllDB` saved variable:
| Key | Values | Description |
| --- | --- | --- |
| `mode` | `default`, `collapsed`, `expanded` | Default quest log header behaviour when the map opens |
## Troubleshooting
**Search box isn't resized / button overlaps it**
The search box is created when the map is first opened. The addon retries on quest log updates until it exists, so open the map once and it should adjust.
**Settings don't persist**
Make sure that you have fully logged out/in or restarted your game.
## Contributing
Issues and pull requests are welcome. When reporting a bug, include your game build, the addon version, and any Lua error text.
## License
Released under the [MIT License](LICENSE).