update readme, license

LICENSE

@@ -1,12 +1,13 @@
+
 The file textures/mail_button.png was created by bas080 and is licensed under the WTFPL.
 
+Webmail component:
+WTFPL
+
 All other files:
 
 Copyright (c) 2016 Carter Kolwey ("Cheapie Systems")
-
-
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and/or any 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.
+

README

@@ -1,26 +0,0 @@
-Mail mod for Minetest
-=====================
-
-This mod adds a system to Minetest that allows players to send each other messages within the game. Unlike chat messages or /msgs, these can be sent to an offline player and will still be present the next time they join.
-
-License: See the "LICENSE" file
-
-Dependencies: None, but will integrate with unified_inventory if it is present.
-
-Crafting: N/A
-
-Instructions:
-
-The inbox can be accessed by using the /mail command or by pressing the "Mail" button in unified_inventory if that mod is installed. In that window, all messages that the player currently has have the sender and subject (truncated if necessary) shown in a list. Unread messages are shown in red, while read messages are shown in white. The "Mark Read" and "Mark Unread" buttons will change this status, as well as viewing the message.
-
-To view a message, either single-click on it and press "Read", or just double-click on it. A window will then open showing the sender, subject, and body of the message, with buttons to return to the inbox, reply to the message, forward it, or delete it.
-
-Single-clicking a message and pressing the "delete" button will remove the message from the inbox.
-
-The compose window can be opened by pressing the "New Message" button in the inbox. This opens a window where the recipient, subject, and body can be entered, along with buttons to cancel or send the message. Since messages can be sent to any name, including ones that have not yet joined the server for the first time, there is no validation to ensure that the recipient exists.
-
-If a message is sent to a player that is currently online, they will see a notification in the chat that a message has arrived, along with the sender and subject (truncated if necessary) of the message and a brief reminder that they can use the /mail command (or the mail button, if applicable) to view the message.
-
-If a player has unread messages in their inbox when they join, a notification will appear to notify them of this. It offers the option to either go to the inbox now, or not. If they choose not to, a reminder is shown in the chat to remind them that they can use the /mail command (or the mail button, if applicable) to view the message(s) later.
-
-All activity (sending messages, marking them as read/unread, deleting them, etc.) is immediately saved to a file called "mail.db" in the world directory. This file is then read at server startup. If an error occurs while saving this file, a message is printed in the server logs.

README.md

@@ -0,0 +1,77 @@
+Mail mod for Minetest
+======
+
+This is a fork of cheapies mail mod
+
+It adds a mail-system that allows players to send each other messages in-game and via webmail (optional)
+
+# Screenshots
+
+Ingame mail
+![](pics/ingame.png?raw=true)
+
+Webmail
+![](pics/webmail.png?raw=true)
+
+
+# Installation
+
+## In-game mail mod
+
+Install it like any other mod: copy the directory to your "worldmods" folder
+
+## Webmail
+
+The webmail component runs as webservice and provides the api for the minetest server
+and the website for the webmail componentc
+
+Prerequisites:
+* node and npm (on ubuntu: apt install nodejs npm)
+
+To install and run the webmail server:
+* Copy the "webmail" folder to your desired location (or keep it where it is)
+* Change to the webmail directory: (cd ./webmail)
+* run "npm install" to install the node dependencies
+* generate a secret key for yourself, can be anything string-like, i suggest one from https://www.random.org/passwords/?num=5&len=16&format=html&rnd=new
+* Edit the "start.sh" file and insert the secret key in place of "myserverkey"
+* run "./start.sh"
+
+To set up your minetest installation to communicate with the webmail server, edit your "minetest.conf":
+```
+# enable curl/http on that mod
+secure.http_mods = mail
+# the url to the webmail server
+webmail.url = http://127.0.0.1:8080
+# the secret key previously generated (same as in "webmail/start.sh")
+webmail.key = myserverkey
+```
+
+# Commands/Howto
+
+To access your mail click on the inventory mail button or use the "/mail" command
+Mails can be deleted, marked as read or unread, replied to and forwarded to another player
+
+# Dependencies
+* None
+
+# Roadmap
+
+My current roadmap:
+* Enhance ingame UI
+* Better ingame notification
+* Enhance webmail component
+* Allow sending attachments
+
+# Bugs
+
+Let me know if there are any (there are for sure:)
+
+# License
+
+See the "LICENSE" file
+
+
+# Old/Historic stuff
+* Old forum topic: https://forum.minetest.net/viewtopic.php?t=14464
+* Old mod: https://cheapiesystems.com/git/mail/
+