Compare commits
23 Commits
compat-1.4.6
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
| 23e696e141 | |||
| 83367549c4 | |||
| e3d2dc1034 | |||
| 6aab69a116 | |||
| 0853d3854c | |||
| 682e843d0e | |||
| 71569928b5 | |||
| c6e924493b | |||
| 1f130dd5b5 | |||
| 010b2da105 | |||
| 1871cd6e1d | |||
| d9a40f18e6 | |||
| d36dbd5ca5 | |||
| 6f41c63922 | |||
| e19fdc0460 | |||
| 8ed0dbc1ad | |||
| fec171302c | |||
| 1d2cd4069c | |||
| 2a6599ac9e | |||
| 87e59c24da | |||
| 62d4024b7e | |||
| b4fc752b4e | |||
| b22361f758 |
@@ -0,0 +1,63 @@
|
||||
# TurtleMail 1.4.5 — Compatibility audit
|
||||
|
||||
Target: Turtle WoW 1.18.x / Octo client.
|
||||
|
||||
## Fixed in 1.4.6
|
||||
|
||||
- **Horizontal mail bar crash:** the upstream code creates `MailHorizontalBarLeft/Right` and then assumes the textures are exported as globals. Some client/UI combinations return the textures without the expected global, causing `attempt to index field 'MailHorizontalBarLeft' (a nil value)`. The compatibility layer guarantees valid texture references before setup and updates.
|
||||
- **Autocomplete SavedVariables crash:** `TurtleMail_AutoCompleteNames` and its realm/faction table are used without schema validation. The patch initializes/repairs missing or malformed SavedVariables before `ADDON_LOADED`, `PLAYER_LOGIN`, slash commands, and autocomplete.
|
||||
- **Broken sender-learning hook:** upstream `GetInboxHeaderInfo` hook reads `arg[3]`/`arg[12]` from function inputs even though sender/canReply are return values. The patch captures return values first, so received senders can actually populate autocomplete.
|
||||
- **Sent money not logged:** upstream checks the nonexistent `state.send_money` field. The patch records sent money when it is not COD and `sent_money > 0`.
|
||||
- **Inbox bounds/COD safety:** header data is no longer queried/compared unsafely after the inbox index has moved past the last mail; nil COD values are treated as zero.
|
||||
- **Stale inbox icons:** AH/returned icons are explicitly hidden on empty rows/pages.
|
||||
- **Fragile package-button regions:** `MAIL_SHOW` no longer assumes regions 1 and 3 always exist.
|
||||
- **Mailbox frame guards:** bag updates, attachment bookkeeping, inbox locking, and money display tolerate missing/replaced frames instead of immediately throwing Lua errors.
|
||||
- **Locale-safe COD label:** unexpected `COD_AMOUNT` formatting no longer turns the label into nil and causes string concatenation errors.
|
||||
- **Malformed log entries:** logging tolerates missing subjects/participant fields and repairs missing log tables.
|
||||
- **Calendar tooltip:** disabled/empty calendar days no longer concatenate a nil/stale `mails` value.
|
||||
- **OnUpdate rebinding:** `TurtleMail:init()` binds the original `on_update` function before the compatibility file loads; the patch explicitly rebinds the frame script so the safer handler is actually used.
|
||||
|
||||
|
||||
## Fixed in 1.4.8
|
||||
|
||||
- **`MailMailButton` nil crash:** upstream stores the real `SendMailMailButton` in a loose global named `MailMailButton`, then replaces the Blizzard global with a proxy table. If the saved global is missing or another UI addon changes it, `SendMailFrame_CanSend()` and `sendmail_clear()` crash while calling `Enable()` / `Disable()`. The compatibility layer now preserves a strong reference to the real button before the proxy swap, restores it when the mailbox opens, replaces the fragile CanSend hook, and uses a guarded clear routine.
|
||||
- **Paired subject edit-box hardening:** the same proxy pattern is used for `MailSubjectEditBox`; the real edit box is now preserved and restored alongside the send button to avoid the equivalent follow-up failure.
|
||||
|
||||
## Fixed in 1.4.9
|
||||
|
||||
- **Missing `Open Mail` button:** upstream creates `TurtleMailOpenMailButton` only once in `inbox_load()` and assumes it will remain parented, positioned, and visible forever. If that creation path is interrupted or another mailbox/UI addon hides or re-parents the button, TurtleMail never recovers it. The compatibility layer now uses an idempotent inbox loader and an `ensure_open_mail_button()` recovery path that recreates the button if needed and restores its parent/anchor/text/click handler/frame level.
|
||||
|
||||
## Fixed in 1.4.10
|
||||
|
||||
- **First mailbox-open freeze/stutter after the 1.4.9 recovery fix:** 1.4.9 called `ensure_open_mail_button()` on every `MAIL_INBOX_UPDATE`. Initial inbox population can emit a burst of those events, so the button was repeatedly re-parented, re-anchored, re-labeled, resized, and given a new frame level. 1.4.10 removes that work from `MAIL_INBOX_UPDATE` and makes `ensure_open_mail_button()` state-aware, so it only mutates the UI when the button is missing, hidden, moved, re-parented, or otherwise incorrect.
|
||||
|
||||
## Fixed in 1.4.11
|
||||
|
||||
- **Residual mailbox hitch / excessive garbage generation:** the upstream `GetContainerItemInfo` hook used `pack()` + `unpack()` for every bag query, allocating a temporary table each time. Bag/mailbox refreshes can call this path very frequently and trigger avoidable garbage collection pauses. 1.4.11 replaces the installed hook after login with a fixed-local wrapper that performs no per-call table allocation. The native return count is detected once and the exact arity is preserved for signatures of up to 12 return values; unusual signatures fall back to the previous hook.
|
||||
|
||||
## Fixed in 1.4.12
|
||||
|
||||
- **Open Mail recovery overhead on mailbox open:** 1.4.11 still called the full `ensure_open_mail_button()` routine from `MAIL_SHOW()`. Even when the button was healthy, that path inspected parent, anchor, label, script, size, frame level and visibility. 1.4.12 keeps the normal path Otari-like: if `TurtleMailOpenMailButton` already exists, is parented to `InboxFrame`, and is shown, `MAIL_SHOW()` leaves it completely untouched. The full recovery routine now runs only if the button is missing, hidden, or re-parented. No inbox polling, Open All, sending, logging, or mail-processing logic is changed.
|
||||
|
||||
## Remaining architectural risks upstream
|
||||
|
||||
These are intentionally not rewritten in the compatibility layer because changing them would be much more invasive and could alter mail behavior:
|
||||
|
||||
1. TurtleMail directly replaces global Blizzard functions during `PLAYER_LOGIN` rather than using a cooperative hook system. This makes load order important when another addon also replaces the mail/bag functions.
|
||||
2. `sendmail_load()` temporarily/proxy-replaces global `SendMailMailButton` and `SendMailSubjectEditBox`. This is a clever Vanilla-era workaround but can conflict with UI replacements.
|
||||
3. Several layouts rely on specific Blizzard frame names and region ordering. The compatibility layer protects the confirmed/high-risk cases, but a full mail-frame replacement can still be incompatible.
|
||||
4. The pfUI skin accesses pfUI internals (`MailFrame.backdrop`, `pfUI_config`, specific widget members). A future pfUI layout change can therefore break the skin even when core TurtleMail remains functional.
|
||||
5. Inbox polling is frame-count based (`200` OnUpdate ticks), so the interval changes with FPS. It is not a correctness bug but is less predictable than elapsed-time polling.
|
||||
6. The addon has no automated runtime test harness for Turtle WoW mail APIs; future changes still need in-game validation with representative mail/send scenarios.
|
||||
|
||||
## Compatibility context
|
||||
|
||||
The upstream repository already had a Turtle WoW 1.18.1 report where `MailFrame` became nil; that report was ultimately traced to MoveAnything. This reinforces that TurtleMail is sensitive to addons that replace or re-parent the mail UI.
|
||||
|
||||
## Validation
|
||||
|
||||
The compatibility build was tested in-game on Turtle WoW 1.18.x and the reported setup produced no Lua errors after the fixes were applied. Because mailbox behavior can be affected by other UI addons, future changes should still be checked with normal mail, item mail, gold, COD, AH/returned mail, multi-attachment send, autocomplete, logging, and pfUI when applicable.
|
||||
|
||||
## Status
|
||||
|
||||
**1.4.12 is the current test build pending in-game validation.** The fixes remain isolated in `TurtleMailFix.lua` so upstream code stays easy to compare and future upstream changes remain easier to merge.
|
||||
@@ -0,0 +1,55 @@
|
||||
# TurtleMail asset provenance
|
||||
|
||||
Audit date: 2026-08-31
|
||||
|
||||
No visual asset was modified during this documentation pass.
|
||||
|
||||
A software or repository-level notice does not by itself establish ownership or
|
||||
relicensing authority for every visual asset. This file records what can be
|
||||
verified without making broader ownership claims.
|
||||
|
||||
## Bundled visual assets
|
||||
|
||||
| File | Git blob SHA-1 | Immediate upstream | Status |
|
||||
| --- | --- | --- | --- |
|
||||
| `TurtleMail-AH.blp` | `29727e7334dac8891f1483e2a07f8e53d0bae3d5` | `sica42/TurtleMail` | exact upstream Git blob match |
|
||||
| `TurtleMail-RetArrow.blp` | `ac2279ad04168c03e12d693e0056da843d2f3079` | `sica42/TurtleMail` | exact upstream Git blob match |
|
||||
| `TurtleMail-DownArrow.tga` | `fb6c3b2ca14cc6c4f612711a62184c270e329d3f` | `sica42/TurtleMail` | exact upstream Git blob match |
|
||||
|
||||
## Immediate upstream history
|
||||
|
||||
`TurtleMail-AH.blp` and `TurtleMail-RetArrow.blp` were introduced in
|
||||
`sica42/TurtleMail` by commit:
|
||||
|
||||
`814a322b87d3262181e78bbdd1f2e6418ac14f8d`
|
||||
"Add icons for returned & AH mails" — 2025-03-17
|
||||
|
||||
`TurtleMail-DownArrow.tga` appears in the upstream logging work including
|
||||
commit:
|
||||
|
||||
`91142ac27c8fabd651b8e8db6c3d30baa31a604e`
|
||||
"New logging feature" — 2025-03-23
|
||||
|
||||
## Provenance status
|
||||
|
||||
The immediate source is verified. The ultimate creator/source and any separate
|
||||
underlying asset license were not established during this audit.
|
||||
|
||||
Therefore:
|
||||
|
||||
- no claim is made that Dusk-92 created these assets;
|
||||
- no claim is made that sica42 necessarily owned every underlying visual
|
||||
element;
|
||||
- no additional license is asserted for these assets;
|
||||
- the files are retained with documented provenance.
|
||||
|
||||
## Screenshots
|
||||
|
||||
The README references externally hosted screenshots. They are not bundled as
|
||||
repository files.
|
||||
|
||||
## Trademark and game-asset boundary
|
||||
|
||||
World of Warcraft, Warcraft, Blizzard Entertainment, and associated names,
|
||||
marks, artwork, and game assets remain the property of their respective rights
|
||||
holders.
|
||||
@@ -0,0 +1,74 @@
|
||||
# TurtleMail code provenance
|
||||
|
||||
Audit date: 2026-08-31
|
||||
|
||||
## Known fork chain
|
||||
|
||||
1. `shirsig/Mail`
|
||||
- https://github.com/shirsig/Mail
|
||||
- original known Vanilla mail addon source
|
||||
2. `sica42/TurtleMail`
|
||||
- https://github.com/sica42/TurtleMail
|
||||
- immediate upstream fork with TurtleMail features and later maintenance
|
||||
3. `Dusk-92/TurtleMail`
|
||||
- https://github.com/Dusk-92/TurtleMail
|
||||
- current maintained compatibility fork
|
||||
|
||||
GitHub repository metadata confirms that `sica42/TurtleMail` is a fork of
|
||||
`shirsig/Mail`, and `Dusk-92/TurtleMail` is a fork of
|
||||
`sica42/TurtleMail`.
|
||||
|
||||
## Immediate-upstream identity
|
||||
|
||||
The following current files are byte-identical at Git blob level to
|
||||
`sica42/TurtleMail`:
|
||||
|
||||
| File | Git blob SHA-1 |
|
||||
| --- | --- |
|
||||
| `Calendar.lua` | `1a5e918bd4b6bf74f1c4a3372a60e944c5e1dcb8` |
|
||||
| `TurtleMail.lua` | `009463c946c47f9fbf44c666005c5b95468cba97` |
|
||||
| `TurtleMail.xml` | `e0ccb3ca6db13f999468a0eef9a91c564c8adae8` |
|
||||
| `localization.lua` | `2ff7c48bd9c8ee555c7e2e0111bedce86e3e01bc` |
|
||||
| `localization.de.lua` | `40227ed5306eafd43b97189967459a65487b32a9` |
|
||||
| `localization.es.lua` | `3f181ba3dc36d8539e8eb6adb91b68f30ec37b75` |
|
||||
| `localization.fr.lua` | `a72708fd39c212f4478779fa9e73200347495d51` |
|
||||
| `localization.ru.lua` | `732e204b50c88eb410f48a835da3f5874d48c312` |
|
||||
|
||||
The three visual assets are documented separately in
|
||||
`Docs/ASSET_PROVENANCE.md`.
|
||||
|
||||
## Dusk-92-specific maintenance
|
||||
|
||||
The current fork adds an isolated compatibility layer in
|
||||
`TurtleMailFix.lua` and updates addon metadata/documentation around the
|
||||
1.4.6 maintenance release.
|
||||
|
||||
The current `TurtleMail.toc` differs from the immediate upstream version and
|
||||
includes the compatibility layer.
|
||||
|
||||
`AUDIT.md` documents the technical compatibility pass.
|
||||
|
||||
## Calendar provenance
|
||||
|
||||
`Calendar.lua` is unchanged from the immediate upstream.
|
||||
|
||||
Relevant upstream history:
|
||||
|
||||
- commit `91142ac27c8fabd651b8e8db6c3d30baa31a604e`
|
||||
("New logging feature", 2025-03-23)
|
||||
- commit `2a8cc7204c93dd83b54ea95009fbc6c6075d7573`
|
||||
("Fix bug in calendar dropdown", 2025-04-02)
|
||||
|
||||
This establishes the immediate development history without asserting a license
|
||||
that is not present in the upstream repository.
|
||||
|
||||
## Licensing boundary
|
||||
|
||||
Neither `shirsig/Mail` nor `sica42/TurtleMail` exposed an explicit
|
||||
project-wide LICENSE file during this audit.
|
||||
|
||||
A public GitHub repository or fork relationship is not, by itself, proof of a
|
||||
permissive license.
|
||||
|
||||
For that reason, the current fork records provenance rather than assigning an
|
||||
invented license to inherited code.
|
||||
@@ -0,0 +1,30 @@
|
||||
TurtleMail mixed-origin copyright and license notice
|
||||
|
||||
This repository contains material from multiple origins.
|
||||
|
||||
1. Original modifications and documentation authored by Dusk-92
|
||||
Copyright (c) 2026 Dusk-92.
|
||||
All rights reserved unless a specific file states otherwise.
|
||||
|
||||
2. Historical and upstream TurtleMail / Mail code
|
||||
Significant portions of this repository descend from:
|
||||
- https://github.com/shirsig/Mail
|
||||
- https://github.com/sica42/TurtleMail
|
||||
|
||||
No explicit project-wide license was identified in either upstream
|
||||
repository during the 2026-08-31 provenance audit.
|
||||
|
||||
This file does NOT relicense inherited code and does not grant rights that
|
||||
the applicable original copyright holders did not grant.
|
||||
|
||||
3. Visual assets, trademarks, and game-facing material
|
||||
These remain subject to their respective rights holders. The presence of a
|
||||
file in this repository does not by itself establish ownership or a right to
|
||||
relicense any underlying third-party or game-derived asset.
|
||||
|
||||
World of Warcraft, Warcraft, Blizzard Entertainment, Turtle WoW, and associated
|
||||
names, marks, artwork, and game assets remain the property of their respective
|
||||
rights holders.
|
||||
|
||||
See THIRD_PARTY_NOTICES.md, PROJECT_IDENTITY.md, and Docs/ for provenance and
|
||||
scope details.
|
||||
@@ -0,0 +1,20 @@
|
||||
# License and provenance records
|
||||
|
||||
No explicit project-wide LICENSE file was identified in either known upstream
|
||||
repository during the 2026-08-31 audit:
|
||||
|
||||
- https://github.com/shirsig/Mail
|
||||
- https://github.com/sica42/TurtleMail
|
||||
|
||||
For that reason, this directory does not contain an invented upstream license
|
||||
text.
|
||||
|
||||
The repository root `LICENSE` is a **mixed-origin scope notice**. It applies
|
||||
only to original Dusk-92 material where stated and explicitly does not
|
||||
relicense inherited code or assets.
|
||||
|
||||
See:
|
||||
|
||||
- `../THIRD_PARTY_NOTICES.md`
|
||||
- `../Docs/CODE_PROVENANCE.md`
|
||||
- `../Docs/ASSET_PROVENANCE.md`
|
||||
@@ -0,0 +1,48 @@
|
||||
# TurtleMail project identity
|
||||
|
||||
## Canonical project
|
||||
|
||||
The canonical repository designated by the current maintainer is:
|
||||
|
||||
- https://github.com/Dusk-92/TurtleMail
|
||||
|
||||
Mirrors, package caches, downstream forks, repackaged copies, and modified
|
||||
versions hosted elsewhere are independent unless the canonical project
|
||||
explicitly states otherwise.
|
||||
|
||||
## Independent community project
|
||||
|
||||
TurtleMail is an independent community-maintained fork.
|
||||
|
||||
It is not affiliated with, sponsored by, approved by, or endorsed by Blizzard
|
||||
Entertainment, Turtle WoW, OctoWoW-like projects, shirsig, sica42, or any other
|
||||
referenced project unless explicitly stated by that party.
|
||||
|
||||
Compatibility with World of Warcraft 1.12-compatible clients, Turtle WoW-like
|
||||
environments, Octo-like environments, or pfUI does not imply affiliation,
|
||||
endorsement, partnership, or ownership.
|
||||
|
||||
World of Warcraft, Warcraft, Blizzard Entertainment, and associated names,
|
||||
marks, artwork, and game assets remain the property of their respective rights
|
||||
holders.
|
||||
|
||||
## Upstream relationship
|
||||
|
||||
The known fork chain is:
|
||||
|
||||
- https://github.com/shirsig/Mail
|
||||
- https://github.com/sica42/TurtleMail
|
||||
- https://github.com/Dusk-92/TurtleMail
|
||||
|
||||
The current fork preserves upstream attribution and maintains its compatibility
|
||||
changes independently.
|
||||
|
||||
Nothing in this repository should be read as a statement that upstream authors
|
||||
or compatibility-target projects endorse, support, or are responsible for this
|
||||
fork or its releases.
|
||||
|
||||
## Support boundary
|
||||
|
||||
Dusk-92 is responsible only for changes and releases published by the canonical
|
||||
fork. Upstream authors and compatibility-target projects are not responsible
|
||||
for this fork's modifications or current behavior.
|
||||
@@ -1,22 +1,183 @@
|
||||
# TurtleMail - WoW 1.12 addOn
|
||||
# 📬 TurtleMail — Turtle WoW
|
||||
|
||||
An extension to the Blizzard mail interface which
|
||||
- **Automatically opens mail, very rapidly**
|
||||
- **Mails multiple items at once, very rapidly**
|
||||
- **Autocompletes recipient names**
|
||||
- **Icons to show if mail was returned or is from AH**
|
||||
- **Shows collected gold from opened mails**
|
||||
- **Apply COD to 1st or all mails**
|
||||
- **Logging of all sent and received mails**
|
||||
A lightweight mailbox enhancement for **World of Warcraft 1.12**, maintained for **Turtle WoW 1.18.x / Octo-like environments**.
|
||||
|
||||
**\<Right Click>** on inbox items to loot the gold, loot the item and destroy the letter, in that order, if any.<br/>
|
||||
**\<Right Click>** or **\<Left Drag>** to add inventory items to the attachments.<br/>
|
||||
**\<Right Click>** to add inventory items to the trade frame.
|
||||
TurtleMail improves the Vanilla mail interface with faster mail handling, multiple attachments, recipient autocomplete, mail logging and useful Auction House / returned-mail indicators.
|
||||
|
||||
Note that COD is always ignored when opening, both automatically as well as by **\<Right Click>**.
|
||||
> This fork keeps the original TurtleMail workflow while adding a compatibility and safety layer for modern Turtle WoW 1.12 environments.
|
||||
|
||||
Logging is disabled by default. Enable with `/tm log` command
|
||||
## 📦 Installation
|
||||
|
||||

|
||||
1. Download the addon.
|
||||
2. Make sure the addon folder is named `TurtleMail`.
|
||||
3. Copy it to:
|
||||
|
||||

|
||||
`World of Warcraft\Interface\AddOns\TurtleMail`
|
||||
|
||||
4. Restart the game.
|
||||
5. Make sure **TurtleMail** is enabled in the AddOns menu.
|
||||
|
||||
No additional addon is required for the core functionality.
|
||||
|
||||
## ✨ Features
|
||||
|
||||
- Quickly open multiple mails.
|
||||
- Quickly send multiple item attachments.
|
||||
- Recipient name autocomplete.
|
||||
- Automatically learns names from received mail.
|
||||
- Auction House mail indicators.
|
||||
- Returned-mail indicators.
|
||||
- Displays the amount of gold collected while opening mail.
|
||||
- Apply **Cash on Delivery (COD)** to the first attachment or all outgoing mails.
|
||||
- Optional logging for sent and received mail.
|
||||
- Dedicated mail log interface.
|
||||
- Multiple localization support.
|
||||
- Vanilla-style mailbox integration.
|
||||
|
||||
## 🖱️ Mail controls
|
||||
|
||||
### Inbox
|
||||
|
||||
**Right-click** an inbox entry to automatically:
|
||||
|
||||
1. Loot attached gold.
|
||||
2. Loot the attached item.
|
||||
3. Delete the empty letter.
|
||||
|
||||
COD mail is intentionally ignored by automatic opening and right-click collection.
|
||||
|
||||
### Attachments
|
||||
|
||||
- **Right-click** an inventory item to add it to an outgoing mail.
|
||||
- **Left-drag** an inventory item to add it to the attachment list.
|
||||
- **Right-click** an inventory item to add it to the trade frame.
|
||||
|
||||
## 📝 Mail logging
|
||||
|
||||
Mail logging is disabled by default.
|
||||
|
||||
Enable or disable it with:
|
||||
|
||||
`/tm log`
|
||||
|
||||
When enabled, TurtleMail records sent and received mail information in its dedicated log.
|
||||
|
||||
## ⚙️ Commands
|
||||
|
||||
| Command | Description |
|
||||
|---|---|
|
||||
| `/tm` | Display TurtleMail help |
|
||||
| `/turtlemail` | Long version of `/tm` |
|
||||
| `/tm help` | Display TurtleMail commands |
|
||||
| `/tm log` | Toggle mail logging |
|
||||
| `/tm clear sent` | Clear the sent-mail log |
|
||||
| `/tm clear received` | Clear the received-mail log |
|
||||
| `/tm clear names` | Clear saved autocomplete recipient names |
|
||||
|
||||
## 🔧 Turtle WoW compatibility
|
||||
|
||||
Version **1.4.12** extends the compatibility, safety, and performance layer for Turtle WoW 1.18.x environments.
|
||||
|
||||
The compatibility work is isolated in `TurtleMailFix.lua` so the original TurtleMail code remains easier to compare with upstream versions.
|
||||
|
||||
### Main fixes
|
||||
|
||||
- Fixed `MailHorizontalBarLeft` / `MailHorizontalBarRight` nil crashes.
|
||||
- Added validation and repair for malformed autocomplete SavedVariables.
|
||||
- Fixed learning sender names for recipient autocomplete.
|
||||
- Fixed persistent autocomplete timestamp aging across client restarts.
|
||||
- Fixed sent-money logging.
|
||||
- Added safer inbox index and COD handling.
|
||||
- Prevented stale Auction House and returned-mail icons.
|
||||
- Added guards for missing or replaced mailbox frames.
|
||||
- Improved package-frame safety.
|
||||
- Added safer handling for malformed log entries.
|
||||
- Fixed calendar tooltip nil/stale-value cases.
|
||||
- Rebound the safer `OnUpdate` handler correctly after loading the compatibility layer.
|
||||
- Prevented the send queue from remaining stuck when an attachment becomes unavailable during sending.
|
||||
- Fixed `MailMailButton` nil crashes while enabling/disabling or clearing the send form, and hardened the paired subject edit-box reference.
|
||||
- Restored the missing **Open Mail** button with an idempotent recovery path.
|
||||
- Reduced first-open mailbox stutter by removing Open Mail layout repair from `MAIL_INBOX_UPDATE` and only changing the button when its state is actually wrong.
|
||||
- Made Open Mail recovery fully lazy on mailbox open: normal openings now leave the existing button completely untouched, matching Otari-style behavior; full repair only runs if the button is missing, hidden, or re-parented.
|
||||
|
||||
The complete technical audit is available in [`AUDIT.md`](AUDIT.md).
|
||||
|
||||
## 🛡️ Compatibility notes
|
||||
|
||||
TurtleMail directly interacts with several Blizzard mailbox functions and frames.
|
||||
|
||||
Most standard Turtle WoW setups should work normally, but addons that heavily replace or re-parent the default mail interface may conflict with TurtleMail.
|
||||
|
||||
The compatibility layer keeps the upstream workflow intact where possible and only replaces fragile paths when needed for compatibility or safety.
|
||||
|
||||
## 🌍 Localization
|
||||
|
||||
TurtleMail includes localization support for:
|
||||
|
||||
- English
|
||||
- French
|
||||
- German
|
||||
- Spanish
|
||||
- Russian
|
||||
|
||||
## 🔧 Compatibility
|
||||
|
||||
- World of Warcraft 1.12
|
||||
- Interface version `11200`
|
||||
- Turtle WoW 1.18.x
|
||||
- Octo-like Vanilla environments
|
||||
- Vanilla Blizzard mailbox UI
|
||||
- Optional pfUI integration
|
||||
|
||||
## 📜 Version
|
||||
|
||||
Current test version:
|
||||
|
||||
**1.4.11**
|
||||
|
||||
Based on upstream **TurtleMail 1.4.5**.
|
||||
|
||||
Version 1.4.10 keeps the **Open Mail** recovery from 1.4.9 but makes it lightweight: the button is repaired on load/mailbox open only when needed, instead of being re-parented and re-anchored on every inbox refresh. This avoids repeated layout work during the initial mailbox update burst.
|
||||
|
||||
Version 1.4.11 also removes the per-call `pack()`/`unpack()` allocation from TurtleMail's `GetContainerItemInfo` hook. The native return count is detected once at login and preserved exactly (up to 12 values), while normal bag queries use fixed local values. This reduces garbage collection pressure during bag/mailbox refreshes without changing mail behavior.
|
||||
|
||||
## 🖼️ Screenshots
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
## 📜 Project identity & licensing
|
||||
|
||||
TurtleMail is an independent community-maintained fork with this known source
|
||||
chain:
|
||||
|
||||
- [shirsig/Mail](https://github.com/shirsig/Mail)
|
||||
- [sica42/TurtleMail](https://github.com/sica42/TurtleMail)
|
||||
- this maintained fork
|
||||
|
||||
No explicit project-wide license was identified in the two known upstream
|
||||
repositories during the provenance audit, so this fork does **not** claim to
|
||||
relicense inherited code.
|
||||
|
||||
Compatibility with **World of Warcraft**, **Turtle WoW / Octo-like
|
||||
environments**, or **pfUI** does not imply affiliation, endorsement, or
|
||||
sponsorship.
|
||||
|
||||
For details, see:
|
||||
|
||||
- [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md)
|
||||
- [PROJECT_IDENTITY.md](PROJECT_IDENTITY.md)
|
||||
- [Docs/CODE_PROVENANCE.md](Docs/CODE_PROVENANCE.md)
|
||||
- [Docs/ASSET_PROVENANCE.md](Docs/ASSET_PROVENANCE.md)
|
||||
- [LICENSES/](LICENSES/)
|
||||
|
||||
## 🙏 Credits
|
||||
|
||||
Original TurtleMail addon by **shirsig / sica**.
|
||||
|
||||
Upstream maintenance by **sica42**.
|
||||
|
||||
Turtle WoW compatibility fixes and additional maintenance by **Dusk-92**.
|
||||
|
||||
This fork aims to preserve the original TurtleMail experience while improving compatibility and stability on modern Vanilla server environments.
|
||||
|
||||
@@ -0,0 +1,125 @@
|
||||
# TurtleMail third-party notices
|
||||
|
||||
Audit date: 2026-08-31
|
||||
|
||||
This file records known upstream sources, inherited code, assets, compatibility
|
||||
references, and unresolved licensing for the Dusk-92 TurtleMail fork.
|
||||
|
||||
Existing source comments, Git history, upstream repository metadata, and README
|
||||
credits remain part of the provenance trail.
|
||||
|
||||
## Historical source: shirsig/Mail
|
||||
|
||||
The original known source repository is:
|
||||
|
||||
- https://github.com/shirsig/Mail
|
||||
|
||||
It provides the earlier Vanilla WoW mail addon from which TurtleMail ultimately
|
||||
descends.
|
||||
|
||||
No explicit project-wide LICENSE file was present in that repository during
|
||||
this audit.
|
||||
|
||||
## Immediate upstream: sica42/TurtleMail
|
||||
|
||||
The immediate upstream repository is:
|
||||
|
||||
- https://github.com/sica42/TurtleMail
|
||||
|
||||
That repository is itself a fork of `shirsig/Mail`.
|
||||
|
||||
No explicit project-wide LICENSE file was present in the immediate upstream
|
||||
repository during this audit.
|
||||
|
||||
Accordingly, this fork does **not** claim that inherited TurtleMail or Mail code
|
||||
is MIT, GPL, public domain, or otherwise freely relicensed. The root `LICENSE`
|
||||
notice is intentionally limited in scope and does not override upstream rights.
|
||||
|
||||
## Dusk-92 compatibility layer
|
||||
|
||||
The current fork adds and maintains Turtle WoW / Octo-like compatibility and
|
||||
safety work.
|
||||
|
||||
Notably:
|
||||
|
||||
- `TurtleMailFix.lua` is maintained in this fork as an isolated compatibility
|
||||
layer.
|
||||
- `AUDIT.md` documents the compatibility/stability audit.
|
||||
- `TurtleMail.toc` and `README.md` include fork-specific maintenance and
|
||||
compatibility changes.
|
||||
|
||||
Historical Git commits remain the authoritative record for individual changes.
|
||||
|
||||
## Unchanged immediate-upstream files
|
||||
|
||||
At the time of this audit, the following runtime files in the Dusk-92 fork were
|
||||
byte-identical at Git blob level to `sica42/TurtleMail`:
|
||||
|
||||
- `Calendar.lua`
|
||||
- `TurtleMail.lua`
|
||||
- `TurtleMail.xml`
|
||||
- `localization.lua`
|
||||
- `localization.de.lua`
|
||||
- `localization.es.lua`
|
||||
- `localization.fr.lua`
|
||||
- `localization.ru.lua`
|
||||
- `TurtleMail-AH.blp`
|
||||
- `TurtleMail-RetArrow.blp`
|
||||
- `TurtleMail-DownArrow.tga`
|
||||
|
||||
This establishes immediate provenance, not a new license grant.
|
||||
|
||||
## Calendar
|
||||
|
||||
`Calendar.lua` is inherited unchanged from `sica42/TurtleMail`.
|
||||
|
||||
The immediate upstream history shows the calendar as part of the 2025 logging
|
||||
work, with a later calendar dropdown bug fix by Sica.
|
||||
|
||||
No separate license for that file was identified, so it remains documented as
|
||||
upstream-derived material under unresolved project-wide licensing.
|
||||
|
||||
## Visual assets
|
||||
|
||||
The three bundled visual assets are tracked in
|
||||
`Docs/ASSET_PROVENANCE.md`.
|
||||
|
||||
Their immediate upstream source is verified, but their ultimate artistic source
|
||||
or underlying asset license was not established during this audit.
|
||||
|
||||
No additional ownership or relicensing claim is made.
|
||||
|
||||
## pfUI integration
|
||||
|
||||
TurtleMail includes optional compatibility/integration behavior for pfUI.
|
||||
|
||||
Compatibility or API integration does not imply that pfUI is bundled, nor does
|
||||
it imply affiliation or endorsement.
|
||||
|
||||
## Turtle WoW / Octo-like compatibility
|
||||
|
||||
This fork targets Turtle WoW 1.18.x and Octo-like Vanilla environments.
|
||||
|
||||
Compatibility, naming, testing, or behavioral reference does not create an
|
||||
affiliation, endorsement, partnership, or ownership relationship with those
|
||||
projects or their maintainers.
|
||||
|
||||
## Project identity and trademarks
|
||||
|
||||
Canonical maintained fork:
|
||||
|
||||
- https://github.com/Dusk-92/TurtleMail
|
||||
|
||||
World of Warcraft, Warcraft, Blizzard Entertainment, and associated names,
|
||||
marks, artwork, and game assets remain the property of their respective rights
|
||||
holders.
|
||||
|
||||
See `PROJECT_IDENTITY.md`.
|
||||
|
||||
## Preservation rule
|
||||
|
||||
Do not remove historical attribution, source comments, upstream references, or
|
||||
provenance records merely because inherited code is later modified.
|
||||
|
||||
When replacing or substantially rewriting inherited material, update the
|
||||
provenance record rather than erasing the historical chain.
|
||||
+4
-3
@@ -1,10 +1,11 @@
|
||||
|
||||
## Interface: 11200
|
||||
## Title: |cffabd473Turtle|cffffffffMail
|
||||
## Author: shirsig/sica
|
||||
## Version: 1.4.5
|
||||
## Notes: Mailbox enhancement
|
||||
## Author: shirsig/sica, Dusk-92 (compatibility fixes)
|
||||
## Version: 1.4.12
|
||||
## Notes: Mailbox enhancement - Turtle WoW 1.18.x compatibility
|
||||
## SavedVariables: TurtleMail_AutoCompleteNames
|
||||
## SavedVariablesPerCharacter: TurtleMail_To TurtleMail_Point TurtleMail_Log
|
||||
|
||||
TurtleMail.xml
|
||||
TurtleMailFix.lua
|
||||
|
||||
+1003
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user