From 3d191282479a7c3cd86ff3725ee71830e3fda713 Mon Sep 17 00:00:00 2001 From: coooookies <1164557342@qq.com> Date: Tue, 3 May 2022 06:09:11 +0800 Subject: [PATCH] reset readme --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8199c68 --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +![Group 148.jpg](https://s2.loli.net/2022/05/03/5ZPG2neTlrMW6Az.jpg) +# MeaMailPlus - Grasscutter Mail enhancements +MeaMailPlus is a plugin of [Grasscutter](https://github.com/Grasscutters/Grasscutter), you can use this plugin to send your mail conveniently. + +English | 简体中文 (正在写) + +## 💡Feature + +- [x] **Birthday Mail** - Send birthday emails to players on their birthdays. +- [X] **Daily Bonus** Players will receive rewards when they join the server. +- [X] **Newbie Gift Mail** Players will receive rewards when they first joined. +- [X] **Scheduled Mail push** You can limit the level threshold of players to receive the mail. +- [X] **Command support** Support sending Mails by command. +- [ ] **RESTful API** Send Mail via third-party API. +- [ ] **MORE** Comming soon... + +## 🍗Setup +### Install +1. [Download Plugin Jar](https://github.com/Coooookies/MeaNotice/releases). +2. Put plugins into `plugins` folder of your grasscutter server. +3. Start your server, then the plugin will create `MeaMailPlus` folder in your server plugin folder. +``` +Root +│ lib +│ keys +│ resources +│ ... +└───plugins + │ ... + └───MeaMailPlus + │ template // template files + └───config.json // plugin config file +``` + +### How to use? + +🤔 Comming soon... + +### Command & Permission +Command: +``` +Send Mail: + /meamail send + /meamail sendall + /meamail sendallonline +Other: + /meamail reload + /meamail help +``` + +Permission: +``` +meo.mail | Control plugin functions +``` \ No newline at end of file