Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Emafire003 authored Feb 17, 2024
1 parent 7be84fb commit a20b1c7
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
# ColoredGlow Lib
![Modrinth](https://img.shields.io/modrinth/dt/coloredglowlib?color=green&label=Modrinth%20downloads&style=flat-square)

This library enables you to make entities glow different colors other than plain white or based on their team color.
This library mod enables you to make entities glow different colors other than plain white or Minecraft vanilla's Team colors. You can also add custom color animation, a set of colors that will change overtime, like a rainbow!

![coloredglowlib-with-player](https://user-images.githubusercontent.com/29462910/157507551-dfc4ee7e-66fb-4dae-9578-e17ca64e3b44.png)
For normal users, you can use the commands to set custom colros, and datapacks to add custom animation, while developers can use the API and the javadoc as guide. There is also a wiki.

## Setup
### For normal users (Both Fabric and Forge):
Just drag and drop this mod into your mod folder and enjoy! (Make sure you are downloading the correct file for the correct loader tho!)
TODO change this
![coloredglowlib-with-player](https://user-images.githubusercontent.com/29462910/157507551-dfc4ee7e-66fb-4dae-9578-e17ca64e3b44.png)

#### Commands & Configuration
#### Commands
Every command begins with `/cgl` , short for **C**olored**G**low**L**ib. You can also use `/coloredglowlib`.

You can specify a color to use for an entity/entitytype using the following command:

`/cgl setglowcolor <entity/type> <color>`
`/cgl setglowcolor <entity/type/default> <color>`

The `entity` parameter is the entity you want to target, so @p, Emafire003, the uuid of the entity in front of you etc or it's type such as `minecraft:sheep`.
The `entity/type/defaylt` parameter is what you want to target, so @p, Emafire003, the uuid of the entity in front of you etc or it's type such as `minecraft:sheep`. `default` means that all entites that don't have a specific color will glow the default color.

The `color` parameter is a hexadecimal color code (like #ff85ab, #750711, #abc, #123, #a7e ecc, search "color picker" online to get them) without the `#` since minecraft interprets it as a beginning of a tag (which is not what it should be doing in this case). In alternative you can provide the word `rainbow` that will make the entity glow, you guessed it, rainbow.
The `color` parameter is a hexadecimal color code (like #ff85ab, #750711, #abc, #123, #a7e ecc, search "color picker" online to get them) without the `#` since minecraft interprets it as a beginning of a tag (which is not what it should be doing in this case). In alternative you can provide the word `rainbow` that will make the entity glow, you guessed it, rainbow. You can also use `random` to make an entity glow a different random color every half a second, or another string that represents a custom animation added via datapack!

You can interact with the config directly in game. For example if you want to override the default team colors (the ones minecraft assigns) with the command:

Expand All @@ -32,6 +31,9 @@ More of this in the wiki!

[![bisecthosting](https://www.bisecthosting.com/images/CF/ColoredGlowLib/BH_NU_PROMO.png)](https://www.bisecthosting.com/LightDev)

## Setup
### For normal users:
Just drag and drop this mod into your mod folder and enjoy! (Make sure you are downloading the correct file for the correct loader tho!)

### For developers:
Include this library into your `build.gradle` as a dependency
Expand Down

0 comments on commit a20b1c7

Please sign in to comment.