MTSR/mail
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Mail mod for Minetest
152 Commits 7 Branches 14 Tags 3.4 MiB
Lua 99.3%
Dockerfile 0.5%
Mathematica 0.2%
db2434c8f9
Go to file
Athozus db2434c8f9
Update screenshot
2023-07-16 23:50:50 +02:00
.github/workflows update testing harness / move contact-list function to util (#73) 2023-04-18 22:01:24 +02:00
locale Add a setting for automatic marking read 2023-07-16 22:59:56 +02:00
sounds Add sound notification (#86) 2023-05-06 21:30:18 +02:00
test update testing harness / move contact-list function to util (#73) 2023-04-18 22:01:24 +02:00
textures separated from webmail mod 2019-09-16 08:06:54 +02:00
ui Add a setting for automatic marking read 2023-07-16 22:59:56 +02:00
util Add a tooltip for elapsed time since the delivery 2023-07-16 19:42:08 +02:00
.gitignore Create .gitignore 2023-04-12 17:10:02 +02:00
.luacheckrc declare the translator in every module instead of a global 2023-03-31 18:12:48 +02:00
api.lua Remove subject length limitation 2023-06-18 16:45:52 +02:00
api.md View sent messages (new database, add maillists) (#26) 2023-03-29 17:25:01 +02:00
api.spec.lua View sent messages (new database, add maillists) (#26) 2023-03-29 17:25:01 +02:00
chatcommands.lua Permit start composition of a message by passing receivers into /mail command (close #101) 2023-06-18 15:29:27 +02:00
docker-compose.yml update testing harness / move contact-list function to util (#73) 2023-04-18 22:01:24 +02:00
gui.lua Translate formatted strings 2023-05-05 16:05:07 +02:00
hud.lua Add settings (#85) 2023-05-05 11:38:19 +02:00
init.lua Add a setting for automatic marking read 2023-07-16 22:59:56 +02:00
LICENSE strip down to bare mail mod 2022-08-02 15:03:31 +02:00
mail.hu.tr update german translation (+templates) 2023-06-25 21:27:59 +02:00
migrate.lua Fix luacheck 2023-04-02 09:59:15 +02:00
migrate.spec.lua View sent messages (new database, add maillists) (#26) 2023-03-29 17:25:01 +02:00
mod.conf use canonical_name if it is available; report error when trying to send mail to non-existent players 2023-02-23 13:41:41 -08:00
mtt.lua View sent messages (new database, add maillists) (#26) 2023-03-29 17:25:01 +02:00
onjoin.lua Store colors and use a lighter selection color 2023-06-25 19:12:20 +02:00
README.md Update screenshot 2023-07-16 23:50:50 +02:00
screenshot_1.1.0.png Update README 2023-04-12 17:26:09 +02:00
screenshot_1.2.0.png Update screenshot 2023-07-16 23:50:50 +02:00
screenshot_1.png add screenshot / update readme / prepare for cdb release (#32) 2023-04-02 16:39:38 +03:00
screenshot_2.png add screenshot / update readme / prepare for cdb release (#32) 2023-04-02 16:39:38 +03:00
storage.lua Add a setting for automatic marking read 2023-07-16 22:59:56 +02:00
storage.spec.lua View sent messages (new database, add maillists) (#26) 2023-03-29 17:25:01 +02:00

README.md

Mail mod for Minetest (ingame mod)

ContentDB

This is a fork of @cheapie's mail mod.

It adds a mail-system that allows players to send each other messages in-game and via webmail (optional).

Screenshot

Installation

In-game mail mod

Install it like any other mod: copy the directory mail_mod to your "worldmods" folder or use the ContentDB

Webmail

To provide a web-based interface to receive/send mails you can use the mtui project.

Commands/Howto

To access your mail type /mail command or click on the mail button in your inventory (unified_inventory).

Mails can be deleted, marked as read or unread, replied to and forwarded to another player. You can also manage your contacts and your mailing lists.

Features

  • Inbox page
  • Outbox page
  • Saved drafts
  • Read/unread marks
  • To/Cc/Bcc system
  • Intuitive UI
  • Contacts book
  • Mailing lists
  • Sorters/filters (new in 1.1.0)
  • Multiple selection (new in 1.1.0)
  • Settings
  • Chat, on join, HUD and sound notifications
  • Translated in : English, French, German, Chinese (both traditional and simplified), Spanish, Brazilian Portuguese.

Compatibility / Migration

Overview:

  • v1 all the data is in the <worldfolder>/mails.db file
  • v2 every player has its own (in-) mailbox in the <worldfolder>/mails/<playername>.json file
  • v3 every player has an entry in the <playername> mod_storage/ (inbox, outbox, drafts, contacts, mailing lists, settings)

Dependencies

  • None

License

See the "LICENSE" file

Textures

Contributors / Credits

  • Cheapie (Initial idea/project)
  • Rubenwardy (Lua/UI improvements)
  • BuckarooBanzay (Clean-ups, Refactoring)
  • Athozus (Outbox, Maillists, UI, Drafts, Trash, Settings)
  • SX (Various fixes, UI)
  • fluxionary (Minor fixups)
  • Toby1710 (UX fixes)
  • Peter Nerlich (CC, BCC)
  • Emojigit (Traditional Chinese translation)
  • Niklp09 (German translation)
  • Dennis Jenkins (UX fixes)
  • Thomas Rudin (Maintenance)
  • imre84 (UI fixes)
  • Chache (Spanish translation)
  • APercy (Brazilian Portuguese translation)
  • Nuno Filipe Povoa (mail_notif.ogg - https://invent.kde.org/plasma/oxygen-sounds/-/blob/master/sounds/Oxygen-Im-Nudge.ogg)
  • TheTrueBeginner (Simplified Chinese translation)
  • nyomi (Hungarian translation)
  • whosit (UI fixes)

Contribute

You can contribute by :

  • Reporting an issue : Go to the Issues tab, click on the button New issue and type a short title then give many informations (Minetest version, tab where the bug occured, steps to reproduce the crash, etc.)
  • Give a review on ContentDB : Just write ;)
  • Requesting new features : Open an issue and indicate what you need more in details.
  • Adding those new features : Open a pull request, and if issue(s) are linked, ping them (#number).
  • Fixing an issue : Same as before, open a pull request.
  • Translate into a new language : copy locale/template.txt into locale/mail.<codelang>.tr, and add translated strings (syntax : not translated=translated). Then, open a pull request. We're also working on opening a Weblate (free web interface) to translate strings easier.
  • Add documentation : adds .md (markdown) or .txt files and open a pull request.
  • ...

You're encouraged to create a fork of this repo, then make your changes and create a pull request when it's done. If you do so, please also check "Git branches" section. (obsolete). Request for merging into master, if needed we will push into another branch.

If you don't have a GitHub account, you can also contact maintainers to add manually your contributions.

Git branches

Caution : might be obsolete

  • master : main branch, where are pushed releases and tags
  • dev : for new release works, A.B.C release to A.B+1.0
  • A.B.X : for fix releases (no new features), A.B.C release to A.B.C+1

For a new fix release (A.B.C) : merge A.B.X branch to master For a new release (A.B+1.0) : merge dev to master, with previous A.B.C merges (include fixes in master, prioritize dev branch in case of conflicts)

Old/Historic stuff