Skip to content
This repository has been archived by the owner on Jan 14, 2025. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Vahaz authored Jan 14, 2025
1 parent a95db81 commit 683c10e
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,29 @@
# social-friends-plugin
A social plugin to allow a player to add / remove friends on Minecraft using Plugins feature.
# social-friends-plugin (1.21)
A plugin to allow a player to add / remove friends on Minecraft 1.21 using Plugins feature.

This plugin save player's friends and friends request into a "[player's UUID].yml" file in player_data directory.
It also save player's last connection date.
In game you can use various commands such as : /friends add <player> | /friends

This is my first public plugin, this serves more of a display project rathen than a commercial project.

Use this plugin at your own risk, the plugin might encounter bugs. It should work tho.

## Permission
| Permission Node | Default | Description |
| ------------------------- | ---------- | ---------------- |
| social.friends | Everyone | Allows use of all Social-Friends commands. |

## Commands
| Commands | Description |
| ------------------------- | ---------------- |
| /friends add <player> | Send a friend request to a player. |
| /friends remove <player> | Remove a friend. |
| /friends accept <player> | Accept a friend request, if it exist. |
| /friends deny <player> | Deny a friend request, if it exist. |
| /friends list | Show all player's friends with the last time they log in. |
| /friends | Show the list of all commands. |

## Tools

Tools used to make and test this plugin: Java IDE 'IntelliJ IDEA Community Edition' by JetBrains, Maven, Spigot, Minecraft and MultiMC.

0 comments on commit 683c10e

Please sign in to comment.