chattrigger / ctjs Goto Github PK

ChatTriggers (CT) is a framework for Minecraft that enables live scripting and client modification using JavaScript. We provide libraries, wrappers, objects, and more to make your life as a modder as easy as possible. Even if we don't support something you need, you can still access any Java classes and native fields/methods.

With CT, you have all the power of a modding environment with the benefit of an easy-to-use language and the ability to reload your scripts without restarting the game. CT also provides a way to define your own Mixins!

CT is currently written for Fabric 1.19. See this repo for the deprecated Forge 1.8.9 version.

Want to hide an annoying server message that you see every time you join a world?

register('chat', event => {
    cancel(event);
}).setCriteria("Check out our store at www.some-mc-server.com for 50% off!");

How about automating a series of common commands into one?

register('command', () => {
    ChatLib.command('command1');
    ChatLib.command('command2');
    ChatLib.command('command3');
}).setName('commandgroup');

Or even something silly like a calculator command

register('command', (...args) => {
    // Evaluate all args the user gives us...
    const result = new Function('return ' + args.join(' '))();

    // ...and show the result is a nice green color
    ChatLib.chat(`&aResult: ${result}`);
}).command('calc');

With CT's register system, you can listen to custom events that we emit and react to them. For example, we emit events when you switch worlds, click on a GUI, hit a block, hover over an item and see its tooltip, and much more! You can even provide custom events for other module authors to use.

To begin, download and install Fabric for one of the supported versions, then head over to our releases page and download the latest version. The mod is installed like any mod; just drag it into your mods folder. Once installed, you can import modules in-game by typing /ct import <moduleName>, where <moduleName> is the name of the module. You can browse the available modules on our website.

If you can't find any modules on the website that do exactly what you want, which is quite likely, you'll have you write your own! Here are the steps you'll want to take:

1. Navigate to the .minecraft/config/ChatTriggers/modules folder. If you don't know where this is, you can also execute /ct files, which will open the correct directory automatically.

2. Create a new directory with the name of your module

3. Inside the directory, create a file called metadata.json, and inside of that, put the following text:

   {
       "name": "<module name>",
       "entry": "index.js"
   }

   This means that when our module first runs, CT will run the index.js file

   Note that <module name> must match the name of your folder exactly!

4. Create the index.js file, and put some code in there. What exactly you write will depend on what you want CT to do. To learn more about the available APIs, take a look at the Slate.

   • Some things on the Slate may be outdated, we are working on improving this

• Slate, a guided tutorial that covers the basics
• Javadocs, a technical reference for all public APIs in the mod
• MIGRATION.md, a guide for upgrading modules from CT 2.X to 3.0
• CONTRIBUTING.md (TODO)