From 0bf49bf25137ef55af4ed2cb2f79c5cb106b2a0e Mon Sep 17 00:00:00 2001 From: Lucy Poulton Date: Tue, 27 Dec 2022 10:30:44 +0000 Subject: [PATCH] add readme --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 40 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b4bf1d0..3e3e668 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,40 @@ -# ProNouns v3 -A WIP full rewrite of [ProNouns](https://github.com/lucypoulton/pronouns) but this time it's actually good \ No newline at end of file +# ProNouns +This is a work-in-progress rewrite of my plugin [ProNouns](https://github.com/lucypoulton/pronouns). + +## THIS IS PRE-RELEASE SOFTWARE +I assume absolutely no responsibility if this plugin breaks anything - use at your own risk. + +# Installation + +### Paper +Download the Paper jarfile and place it into your `plugins` folder. Restart your server. + +### Fabric +*N.B. this is a server-side mod. While it technically will work on the client, using the integrated server, it won't really achieve a lot!* +Download the Fabric jarfile and place it into your `mods` folder. Restart your server. + +### Sponge, Velocity, BungeeCord +Support for these three platforms is planned but not yet implemented. + +# Commands +`/pronouns get [username]` - Gets a player's pronouns, or your own if no username is given.
+`/pronouns set ` - Sets your pronouns.
+`/pronouns set --player ` - Sets another player's pronouns.
+`/pronouns clear [username` - Clears your pronouns, or your own if no username is given.
+ +# Pronoun stores +The plugin stores pronouns using a store. There are different types of store: +- **NBT** - stores pronouns in the server's world data. +- **Flat file** - stores pronouns in a dedicated file. +- **MySQL** - stores pronouns in a MySQL database. +- **In-memory** - does not save pronouns anywhere. All data is lost on restart. This is used for testing. + +Currently platforms can use the following types of store: + +- **Bukkit** - NBT (through `PersistentDataContainer`) +- **Fabric** - NBT + +This will be configurable in the future. + +# Configuration +Not yet implemented.