Code Monkey home page Code Monkey logo

coloredglowlib's Introduction

ColoredGlow Lib

fabric fabric-api forge GitHub Workflow Status Modrinth

This library enables you to make entities glow different colors other than plain white or based on their team color.

coloredglowlib-with-player

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!)

Commands & Configuration

Every command begins with /cgl , short for ColoredGlowLib. 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>

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. It is not recommended to use @e, @a and stuff that targets a lot of entities. If you want you can use it anyway, for ~1000ish entities it should run just fine, maybe even a lot more. At around 4k tho it starts to complain so don't push it.

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 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:

/cgl config set overrideTeamColors <true/false>

It is recommended to leave this on false, since you may have some other mod/datapack/modpack that sets a team color to an entity, and it can get confusing.

You can also get the current value of the setting, like so:

/cgl config get overrideTeamColors

More of this in the wiki!

For developers:

Fabric

Include this library into your build.gradle as a dependency

repositories {
    maven {
        name = "Modrinth"
        url = "https://api.modrinth.com/maven"
        content {
            includeGroup "maven.modrinth"
        }
    }
}

dependencies {
    modImplementation "maven.modrinth:coloredglowlib:<version>"
}

Forge

Include this library into your build.gradle as a dependency

repositories {
    maven {
        name = "Modrinth"
        url = "https://api.modrinth.com/maven"
        content {
            includeGroup "maven.modrinth"
        }
    }
}

dependencies {
    implementation "maven.modrinth:coloredglowlib:<version>+forge"
}

You can find the correct version in the versions page on Modrinth.

You can find more information on the wiki!

You can find examples of this lib being used in my FoxGlow and Glowful World mod.

luma-shaders-coloredglowlib

License

This mod is available under the GNU LGPL3 License.

Support me

If you would like to offer me a coffee, here you go.

ko-fi

For modpack devs: You are permitted to use this mod without directly asking, but please credit me somewhere, it would help! (Also, I'm kind of a curious person so maybe send me a message when you include it into your modpack, and I'd like to check it out)

coloredglowlib's People

Contributors

emafire003 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.