Update readme

HOW_TO_PLAY.md

@@ -0,0 +1,138 @@
+# How To Play
+
+When starting a new world you're given the choice of which tribe to join. One of Unicorn, Pegasus, Earth, Bat, or Changeling.
+
+Depending on which race you pick, you're given different abilities, displayed on your HUD in a series of circular elements.
+To activate an ability, simply press and hold the key corresponding to that ability. Some take longer than others, and certain abilities
+also respond to quick, short single-taps, or double-taps.
+
+## Abilitis By Species
+
+### Unicorns
+
+ - Magic
+
+   For unicorns, casting spells is done through gems, which you can obtain whilst mining. You first need to craft a spellbook using a gem, and then
+   in the spellbook you can discover the magical traits of different items and recipes to combine them to create different spells, as well
+   as modify existing one.
+
+   Once you have a gem with a spell you want to use, you can equip it to your main-hand or off-hand slot by right-clicking with a gem in
+   one of either hand, then to activate it you us your primary ability. You can also cast spells directly from a gem by using the ability
+   whilst holding the gem in your hand.
+
+ - Teleporting
+   
+   Unicorns can teleport long distances, and occasionally through floors and walls up to 2 blocks. They can also take others with them by giving out signed
+   bangles of comradery.
+   
+   By sneaking, unicorns can switch between teleporting to the nearest face of the block they're looking at, and the farthest. To teleport and take others
+   with you, they can switch pages in their hud using Page Up/Page Down.
+
+### Earth Ponies
+ - Kicking & Stomping
+
+   Earth ponies kick good.
+
+   If Mine Little Pony is installed, and you have the appearance of a pony, kicking will target the block behind you, so twirl that rump!
+   Kicking blocks will incrementally mine them, and kicing trees will shake items loose from their branches. Kicking a tree _too much_ might destroy it,
+   so be careful!
+
+ - Stomping
+   Stomping is the downwards version of kicking. Activate the ability whilst in the air to land a crushing blow against the ground and push
+   other mobs away. Doing this will also gradually mine the affected blocks.
+
+ - Bracing
+
+   Earth ponies can brace themselves by sneaking! It, uh, makes you harder to push! yeah!
+
+### Pegasi / Bat Ponies
+
+ - Picking Up Mobs/Players
+
+   Pegasi can pick up mobs and carry them on their back. It's great for getting around! Just use the ability to grab an entity you're looking at,
+   and use it again to drop them.
+
+ - Avian Flight
+
+   Pegasi can fly either by getting a running start and jumping into the air, or by using their tertiary ability to open or close their wings.
+   Once in the sky you have to flap your wings (Space) to propel yourself forward and upwards, and glide (by sneaking/holding shift).
+   You can navigate and hover using the arrow keys and by slowing down and adjusting your position to stay in one spot.
+   
+   
+### Pegasi (only)
+ - Ranbooms / Dashing
+   
+   Using the ability whilst flying will allow pegasi to perform a sonic rainboom that deafens the ears of your enemies and shatters glass!
+   It may take some practice, but the results are most satisfying.
+
+ - Capturing Storms
+   
+   Give a pegasuscloud, and they'll have water for a day, give a pegasus a bottle, and they'll capture the clouds and make it rain all
+   summer. I think that's how the saying goes? Anywho, you can right-click with bottles to capture rain in a bottle during storms.
+
+   Doing this will both stop it from raining and store the weather in the bottle for later use.
+   
+   Dropping bottles on the ground during a thunder storm is also the only way to obtain lightning in a bottle.
+
+### Bat Ponies
+ - Screeching
+ 
+   Eeee! Eee-Eeee! Eeee!
+   
+   Bat ponies can screeeeEEeeeeEEEEech!
+   
+   Besides annoying other players, they also deal some awesome knockback and a tiny bit of damage to anypony or anything that's caught off-guard by
+   your terrifying howl. It's so scary you might just scare yourself!
+
+ - Night Vision
+   Bat Ponies have night vision. They can see in the dark, like true sisters of the night! The drawback of this is you can't look at the sun, or be
+   anywhere near sunlight in general. Luckily uou can craft some really cool sunglasses to protect your precious assets!
+   
+   Or wear a pumpkin. That works too.
+   
+   (Bat Ponies also respawn in dark places)
+   
+ - Hanging of Ceilings
+
+   Ever just want to hang out? Well bat ponies can, _literally_! All the cool kids are doing.
+
+### Changelings
+
+ - Insectoid Flight
+
+   Flying as a changeling is somewhat simpler. It's closer to creative flight.
+   
+ - Draining Love
+
+   Love is the primary source of nutrition for Changelings. They can't eat a lot else, so they have to seek out hostile mobs and certain livestock to
+   sustain themselves. Alternatively, love can also be 'stolen' in-transit from the crystal heart if a changeling drops a bucket, bottle, or mug
+   anywhere nearby.
+   
+ - Shapeshifting
+   
+   Changelings can turn into damn near anything, even other players! And blocks! And hostile mobs!
+   Careful about turning into skeletons, though, because they hate the sun even more than bat ponies.
+
+## Special Items, Plants, Tools
+
+### Polearms
+
+Polearms function like a combination of a spear and a sword. They have longer cooldown and a minor knockback, but will grant the user extra reach distance
+when equipped. Perfect for farming those unusual, magical blocks from a safer distance.
+
+Fighting too close together with them may cause you some knockback.
+
+### Zap Apples
+
+Zap Apple Trees occur naturally in the world and are the only way to obtain zap apples in survival. They can appear in one of several different states:
+
+Hybernating, Flowering, Fruiting, or Withering
+
+They cycle through these states throughout the lunar cycle, so if you find one and it's not in the state you want, wait around another few days and it
+will eventually bear fruit, but don't try to harvest the apples before they're ripe, because they will zap you!
+
+If you're able to obtain the wood and leaves, it also make the perfect deterant to griefers.
+
+### Muffins
+
+They're bouncy and delicious, and pigs absolutely love them!

OLD-README.md

@@ -0,0 +1,36 @@
+# Unicopia
+
+[![Downloads](https://img.shields.io/github/downloads/Sollace/Unicopia/total.svg?color=yellowgreen)](https://github.com/Sollace/Unicopia/releases/latest)
+![](https://img.shields.io/badge/api-fabric-orange.svg)
+
+Adds abilities and magic for each of the races included in Mine Little Pony.
+
+## Features
+
+ - **Magic!**
+		Ponies with magic such as unicorns and alicorn can cast different spells - currently only the shield is available, and also teleport
+ - **Apples!**
+    More types of apples, including cooked apples and Zap Apples. Earth Ponies can obtain all these types of apples by bucking/kicking trees.
+ - **Earth Ponies!**
+		Earth Ponies are stronger and heavier than the other two tribes.
+ - **Changelings!**
+		Changelings have the unique ability to disguise themselves as any other entity. Sometimes even blocks too!
+		Every disguise somes with its own, unique abilities to that mod.
+    Changelings don't eat normal food, but they _can_ obtain sustenance from feeding off of hostile mobs and other players.
+		They can also fly.
+ - **Bats! EEEEEE!!**
+		Bat ponies, like pegasi, can fly. They can also hang upside-down underneath ledges,
+		and scare enemies with a deafening SCREEEEEEEEEECH!
+ - **Flight!**
+    Ponies with wings, such as pegasi have the ability to fly. Build up momentum or find a convenient cliff to take flight.
+		Flap your wings (SHIFT) to gain extra altitude, or hold space hover and glide (FORWARDS)
+ - **Thunderstorms~**
+		Beware of thunderstorms. Flying in them can become treacherous.
+
+## Some notes for people wondering how the mod works:
+
+Since everything is based on the type of tribe the player selects, obviously I want there to be an easy way to switch, however it can't be anything too obtrusive of immersion breaking (like a gui), or too hard like a magic item you find on a quest.
+
+For now, for easy of development, there is the super simple /race command that anyone can use. (try using the `/help race` command. It's really quite amazing). There are also the `/disguise` and `/gravity` commands for similar purposes, none of which I plan to remove.
+
+If you're a server admin, you can also allow and disallow specific tribes on your server using the `/racelist` command. it works more or less the same as the `/whitelist` command. (Again, `/help` is a gem of a command)

README.md

@@ -3,34 +3,96 @@
 [![Downloads](https://img.shields.io/github/downloads/Sollace/Unicopia/total.svg?color=yellowgreen)](https://github.com/Sollace/Unicopia/releases/latest)
 ![](https://img.shields.io/badge/api-fabric-orange.svg)
 
-Adds abilities and magic for each of the races included in Mine Little Pony.
+Bringing the magic of friendship to Minecraft!
 
-## Features
+What started as a humble utility to make playing as a unicorn a little more emersive has grown into a full-blown pony
+conversion experience that brings new magic, mechanics and experience to the world of Minecraft to make it truly feel like you've
+entered the world of Equestria!
 
- - **Magic!**
-		Ponies with magic such as unicorns and alicorn can cast different spells - currently only the shield is available, and also teleport
- - **Apples!**
-    More types of apples, including cooked apples and Zap Apples. Earth Ponies can obtain all these types of apples by bucking/kicking trees.
- - **Earth Ponies!**
-		Earth Ponies are stronger and heavier than the other two tribes.
- - **Changelings!**
-		Changelings have the unique ability to disguise themselves as any other entity. Sometimes even blocks too!
-		Every disguise somes with its own, unique abilities to that mod.
-    Changelings don't eat normal food, but they _can_ obtain sustenance from feeding off of hostile mobs and other players.
-		They can also fly.
- - **Bats! EEEEEE!!**
-		Bat ponies, like pegasi, can fly. They can also hang upside-down underneath ledges,
-		and scare enemies with a deafening SCREEEEEEEEEECH!
- - **Flight!**
-    Ponies with wings, such as pegasi have the ability to fly. Build up momentum or find a convenient cliff to take flight.
-		Flap your wings (SHIFT) to gain extra altitude, or hold space hover and glide (FORWARDS)
- - **Thunderstorms~**
-		Beware of thunderstorms. Flying in them can become treacherous.
+# Features
 
-## Some notes for people wondering how the mod works:
+## Learn how it feels to play as your favourite species of pony!
 
-Since everything is based on the type of tribe the player selects, obviously I want there to be an easy way to switch, however it can't be anything too obtrusive of immersion breaking (like a gui), or too hard like a magic item you find on a quest.
+Unicorns, Pegasi, Earth Ponies, and even Changelings get their own special abilities
  
-For now, for easy of development, there is the super simple /race command that anyone can use. (try using the `/help race` command. It's really quite amazing). There are also the `/disguise` and `/gravity` commands for similar purposes, none of which I plan to remove.
+ - *Play as a unicorn* and learn to use magic! Craft your first spellbook and experiment, finding the different spells you can
+   make and what they do, or simply delve into the lore to learn more about the past of this mysterious world!
+  
+   Besides casting spells, such as a shield to protect themselves, of fire a bolt of magic to incinerate your foes,
+   Unicorns can also teleport to get around obstacles or simply reach those hard to reach places.   
+ 
+ - *Play as a pegasus* and dominate the skies! Besides the ability to fly, pegasi can also perform rainbooms, control the weather by shoving them into jars,
+   and have a greater reach distance and speed than other races.
+ 
+ - *Play as a a humble background pony*! Earth Ponies are tougher and heavier than the other races. They also have the nify ability to
+   kick trees to get food and hasten the growth of crops. You'll never go hungry if you're an earth pony.
+
+ Feeling like going over to the dark side?
+
+ - *Become one with the hive,* and shapeshift into anything when you play as a Changeling. Hunt and feast on the love gathered from other players
+   and mobs. Some forms may even come with their own unique abilities.
+  
+ - *Embrace the night* as a Bat Pony. Bat Ponies have unlimited screeches, can see in the dark, and can fly! Only downside is you have to wear
+   really cool-cooling sunglasses otherwise the sun will burn your eyes. I think that's a fair price, don't you?
+  
+### Manage your diet
+
+  Playing as a pony isn't all just kicking and zapping, though! As herbivores your food options open up to include
+  a lot of items normal players don't usually get to eat. Feeling peckish? Try for some flowers from the meadow,
+  or some hay! I hear the hay burgers of good, if you can find some oats.
+
+### Ponified Paintings
+  
+  Because what kind of pony mod would this be if it _didn't_ have this? Every race has at least one painting to represent them, so show your pride
+  and fly that flag!
+  
+  Disclaimer: Rainbow flags not included (yet)
+
+### Natural Stuff
+
+  - Airflow is simulated (badly)
+    Pegasi, beware about flying during storms! It can get dangerous out there!
+    If you're playing as a flying species, or just like having nice things, try building a weather vein.
+    It shows the actual, totally real and not simulated badly, wind direction of your minecraft world. Just beware
+    that the direction and strength is situational (and bad), and will be different depending where you are and
+    how high up you are.
+
+  - Hot air Rises
+    No, it's not a bad Star Wars movie, it's an actual mechanic. Sand and lava will give flying species extra lift. Water does the opposite.
+    Try it! Actually don't, I don't want you to drown.
+
+### Magic Items And Artifacts
+  
+  - Craft and build s shrine for the Crystal Heart to provide valuable support to your friends
+  - Or give out bangles of comradery to your non-unicorn buddies so they can share in your powers,
+     or just so you can laugh when you teleport and they end up coming witht
+  - Send and receive items using the Dragon's Breath Scroll
+  - Possibly more I'm forgetting about (or am I? OoOoOooOOoo...Spooky surprise mechanics)
+
+Have feedback on this description? Found issues, or anything missing?
+DM me directly on discord.
+Things are still changing, so this description may always be out of date.
+
+# How To Play
+
+View the HOW_TO_PLAY.md file for more details.
+
+# Dependencies & Building
+
+### 1.19.3 Only
+
+This project uses reach-entity-attributes, which may not be updated at the time of this writing.
+If you building for 1.19.3, you may follow these steps to make sure it's available to git:
+
+`git clone https://github.com/Sollace/reach-entity-attributes`
+`cd reach-entity-attributes`
+`gradlew build publishToMavenLocal`
+
+### Building Unicopia
+
+`git clone https://github.com/Sollace/Unicopia`
+`cd Unicopia` 
+`gradlew build`
+
+Built jars are located in /build/bin` within the Unicopia folder after performing the above two command.
 
-If you're a server admin, you can also allow and disallow specific tribes on your server using the `/racelist` command. it works more or less the same as the `/whitelist` command. (Again, `/help` is a gem of a command)