diff --git a/README.md b/README.md index 0789347..8e63819 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,42 @@ -# ScoreboardAttributes - A scoreboard library for Gorilla Tag +
+

ScoreboardAttributes

+ + + + + + +
+ +## What is ScoreboardAttributes? +ScoreboardAttributes is a library for Gorilla Tag that gives players that show up on the Scoreboards their own attributes. + +## For Developers +Before you plan on adding or removing any attributes, you must link the library to your Visual Studio project. + +**1. Right click "Dependencies" and then click "Add Project Reference..."**
+ + +**2. Go the the "Browse" tab and then click "Browse..."**
+ + +**3. Locate the library's DLL file, and then click on "OK"** + + +### Adding/Removing attributes +Both adding and removing your own attributes is really simple. + +To add an attribute, you will need the target player and the attribute name.
+```cs +PlayerTexts.RegisterAttribute("Hello world", Photon.Pun.PhotonNetwork.LocalPlayer); +// This gives our local player an attribute. Our attribute is "Hello world". +``` + +To remove an attribute, you will only need the target player.
+**NOTE: This only removes attributes created from the same mod.**
+```cs +PlayerTexts.UnregisterAttribute(Photon.Pun.PhotonNetwork.LocalPlayer); +// This removes our local player's attribute added in this mod. +``` + +#### *This product is not affiliated with Gorilla Tag or Another Axiom LLC and is not endorsed or otherwise sponsored by Another Axiom LLC. Portions of the materials contained herein are property of Another Axiom LLC. © 2021 Another Axiom LLC.*