Skip to content

Document BirdMessenger delivery with full inventories #292

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ryanbarlow97 merged 2 commits into from
Oct 17, 2026
Merged

Document BirdMessenger delivery with full inventories #292

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da34f05
docs: explain pending mail for full inventories
ryanbarlow97 Oct 17, 2026
df33eae
docs: clarify complete letter stack capacity checks
ryanbarlow97 Oct 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions projects/BirdMessenger/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,11 @@ tick between the edit and the save.

In-flight mail belongs to the recipient character and survives character changes.
Delivery needs the stored owner to be playing the stored character. Pending
letters are handed over one at a time, checking the character before each; a
switch part-way leaves the rest queued, and the file is saved once afterwards.
letters also need enough storage space for their complete item stack. A letter
arriving at a full inventory waits in saved pending mail, and BirdMessenger retries online recipients every
second. Pending letters, including unsent and estate returns, are handed over one
at a time, checking the character and space before each; filling the available
space or switching characters leaves the rest queued, and the file is saved once afterwards.
Character IDs match regardless of letter case and are kept as written. Malformed
IDs and mail for another owner stay in the file and are not delivered to the
current character.
Expand Down Expand Up @@ -148,5 +151,9 @@ Before deployment, verify on a test server with ItemsAdder:
the `unsent-returned` message when that character is next played.
- Receive several pending letters, switching during delivery: remaining letters
wait until their stored owner plays their stored character.
- Receive a letter with a full inventory: it stays in pending mail without a
ground drop. Free a slot: it arrives once within a second. With several waiting
letters and one free slot, the rest keep waiting. Repeat across a restart and
with unsent and estate-returned letters.
- Restart with pending and in-flight mail: delivery resumes without changing
recipient opt-out behaviour or stored character IDs.