Git Product home page Git Product logo

forthebadge
ChatTriggers is always in development. Although we try to follow standard version conventions and deprecate old methods before removing them, there may be times where we need to restructure something to the point where deprecation is impossible. Modules can and will break at any time.

About

ChatTriggers is a framework for Minecraft that allows for 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 without the proper wrapper, you can still use exposed Minecraft methods and variables but you will need knowledge of FML mappings. The entire ChatTriggers engine is built on Rhino using Java 8 so you have access to any Rhino methods and functions. Rhino supports some ES6 features, as can be seen here.

The basic premise of ChatTriggers is that everything is based around Triggers. From a modding standpoint, Triggers can be thought of as event listeners. These can range from a chat Trigger that runs on a specific chat event matching criteria to a render overlay Trigger that runs when the crosshair is being rendered. We are constantly adding more Triggers and Trigger types as the mod evolves for more integration with Minecraft.

register("chat", function(name, message, event) {
  cancel(event);
  ChatLib.chat(name + ": " + message);
}).setCriteria("<${name}> ${message}");

register("renderCrosshair", function(event) {
  cancel(event);
  Renderer.drawRect(
    0x50ffffff,
    Renderer.screen.getWidth() / 2 - 1,
    Renderer.screen.getHeight() / 2 - 1,
    2, 2
  );
});

You can learn the basics of scripting with ChatTriggers from the Slate tutorial and once you get the basics, check out the JavaDocs for a more in depth look at all of the available methods.

Releases

The ChatTriggers website will always be kept up to date with the latest release. As of beta version 0.6.4, we have started to move the release changelog along with a .jar download (mirror of the website) to the GitHub releases page.

Feature changes

Any major features are moved to separate branches before being merged into master. This will avoid the issue of waiting after a release to fix bugs when we want to be working on new features. Any contributors will have to abide by the same standard. New features get their own branch and bug fixes require a pull request on the master branch.

Issues

Any issue can be opened using the normal GitHub issue page. Issues can be anything from bug reports to feature requests. For us to consider an issue to be valid, it needs a simple but effective title that conveys the problem in a few words and a well thought out and well written description.

Bug Report

  • Should be reproducible
  • Needs a step by step guide on how to reproduce
  • Any evidence of the bug occurring (e.g. images or video) is welcome

Feature Request

  • Needs a general description of the feature requests
  • Specifics on what is being requested (e.g. what class you want it in or what it should do) is highly recommended

Duplicate issues will be merged to avoid too much clutter. If an issue is moved to "next" we will usually comment on it to explain how we expect to implement or fix that issue.

Special Thanks To

jProfiler The Java Profiler jProfiler

ChatTriggers's Projects

chattriggers icon chattriggers

A framework for Minecraft Forge that allows for client modifications to be scripted in JavaScript

compatibilitytester icon compatibilitytester

Compatibility tester for ChatTriggers. Attempts to use all available methods to test cross version support.

ctjs icon ctjs

An in-progress rewrite of the ChatTriggers mod for Fabric 1.20

forgegradle icon forgegradle

Minecraft mod development framework used by Forge and FML for the gradle build system

kodiak icon kodiak

Wrappers around code documentation CLI tools to produce JSON models, usable as libraries

koffee icon koffee

Java bytecode assembler as a Kotlin DSL

rhino icon rhino

Rhino is an open-source implementation of JavaScript written entirely in Java

slate icon slate

Beautiful static documentation for your API

tutorials icon tutorials

A group of open sourced video tutorials for ChatTriggers

website icon website

An in-progress rewrite of the ChatTriggers website

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.