Create .github/README.md

Based on Marriage's Bukkit Dev listing.
This commit is contained in:
TheFlagCourier 2020-03-22 07:12:45 -05:00
parent 859454cb57
commit ca1966af0d
No known key found for this signature in database
GPG key ID: 2ECFC4321570222C

45
.github/README.md vendored Normal file
View file

@ -0,0 +1,45 @@
![Marriage Reloaded](https://media-elerium.cursecdn.com/attachments/119/347/marriage-banner.png)
## About
Marriage reloaded, Your love comes true.
This is a plugin that allows you to marry in Minecraft to get acces to special features.
Marriage Reloaded was coded in mc 1.2.5 and v1.0 releases on dec 21 2012
This plugin has multiple commands and it is still growing really fast, it has not been developepd for 4 months and then got picked up again, it is
completely recoded and still misses alot of features
## Features
- Marry in Minecraft
- Set homes for you and your partner
- Private chat
- Gift items
- Teleport to your partner
- View all married couples
- Kiss your partner (crouch + right click)
- Suggestions?
- Video
## Commands
- `/marry` - Shows commands, version, authors and info
- `/marry <name>` - Marry a player (also tracks the player if you use a part of the name)
- `/marry list` - Shows all married players
- `/marry divorce` - Divorce with your partner
- `/marry tp` - Teleport to your partner
- `/marry gift` - Gift the current item in your hand to your partner
- `/marry chat` - Private chat with your partner
- `/marry seen` - Shows partner's last login
- `/marry chatspy` - Spy on private messages (required marry.chatspy)
## Permissions
- `marry.*` - Allows all permissions
- `marry.admin` - Allows all admin commands (currently only /marry reload)
- `marry.update` - Shows update notifications on login
- `marry.chatspy` - Allows player to spy on messages
- `marry.default` - Allows all command but marry.reload
- `marry.marry` - Allows the command /marry <user>
- `marry.home` - Allows the command /marry home
- `marry.sethome` - Allows the command /marry sethome
- `marry.tp` - Allwos the command /marry tp
- `marry.gift` - Allows the command /marry gift
- `marry.chat` - Allows the command /marry chat
- `marry.seen` - Allowed the command /marry seen