Skip to content

ixnoahlive/Coffee

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation




☕ Coffee

ChatTriggers Utility Library


Coffee is a ChatTriggers library with many utilities.

With Coffee, you can write your modules faster and stop wasting time porting your utility functions. Maybe some of the functions can even give you some inspiration on things you can do with your module. If you've got anything urgent ping @ixNoah#5701 in the ChatTriggers Discord Server.

Installation

If you want to install the module's latest stable release you can simply head here or type /ct import Coffee in Minecraft with the ChatTriggers mod to import it. After this is done, you're all set to use Coffee in your projects using this magical one liner.

Please keep in mind you should also add it as a dependency in your project's metadata.json file.

import Coffee from 'Coffee'

You can now use Coffee and it's functions using the Coffee object. Simply type something like Coffee.functionName() and it'll run perfectly fine. If you prefer to keep it short, you can instead do import { cf } from 'Coffee' to import a shorter version.

Examples

You can find examples on how to use Coffee in examples.js. But here's one anyway. Keep in mind it may be outdated.

Add this line to your metadata.json file to import the latest stable release from Coffee.

"requires":["Coffee"]

You can now use Coffee's functions like in the code below. If these functions don't exist, you may have to do some debugging or open an issue.

import Coffee from 'Coffee'

const Messages = [
    'Hello World',
    'Foobar',
    'Bingus'
]

function runOnWorldLoad() {
    ChatLib.chat(Coffee.pickRandom(Messages)) // Pseudorandom message from array
}

Coffee.runOnTrue(World.isLoaded, runOnWorldLoad, 1000) // Check if world is loaded every 1000ms (1s) and if it is run the function

If you're experiencing a problem with these examples you should open an issue and we'll help you out. Please make sure to tag it as "documentation" and use a good title and description to describe it.

Useful Links

License

  • The codebase for Coffee is licensed under MIT.

  • The Coffee Logo & other branding materials are not licensed under MIT and may not be used outside of their assigned purpose.

Releases

No releases published

Packages

No packages published