ChatMate is a helper tool for livestreamers and viewers. It consists of three main parts:
- Server (
/chat-mate/projects/server): Node.js express app that runs the core logic for ChatMate and directly interacts with YouTube (via Masterchat), Twitch (via Twurple), and the MySQL database (via Prisma). Exposes a collection of REST API endpoints. - Studio (
/chat-mate/projects/studio): React web interface for managing streamer and viewer data. It communicates with the server API endpoints. - Client (this repo): Minecraft 1.8.9 mod for viewing and managing livestreams and viewers. Contains additional streamer tools that do not communicate with the server.
Streamers are encouraged to peruse the Streamer Guide for more info on how to use ChatMate.
You might also want to read through the features document or take a look at the custom UI framework documentation.
Want to contribute? Check out the contribution guide for more info.
This project was initialised using the ForgeTemplate repository for 1.8.9. Please excuse the unstructured nature of this section - I have no idea what I'm doing.
Before starting, ensure the latest JRE from https://www.java.com/en/download/ is installed (fixes :applyBinaryPatches error). If, at any point, something goes wrong during setup, the workspace can be reset with gradlew clean cleanCache --refresh-dependencies (fixes :fixMcSources error). Alternatively, the Gradle cache can be manually deleted under C:\Users\<User>\.gradle. If some files are locked for being in use, task-kill "Open JDK Platform Binary" and end the "java.exe" process from the Resource Monitor -> CPU section.
If, at any point, there is a Java version error when running a Gradle task, run the task within IntelliJ instead of CMD.
The Java 8 JDK (for building) and Java 17 JDK (for development) must be installed. https://adoptium.net/archive.html?variant=openjdk8&jvmVariant=hotspot
- Ensure JAVA_HOME is not set in either the user or system environment variables
- Ensure both the Java 17 and Java 8
\binpaths are set in the system environmentPathvariable - Under Project Structure -> Platform Settings -> SDKs add the JDK home path to the Java 17 JDK folder - failing to do so may cause IntelliJ to freeze upon project setup
- Ensure the default IntelliJ Java version is Java 8 (File -> Project Structure -> Project Settings -> Project -> SDK -> Choose 1.8/Java 8).
Once IntelliJ had set up the project workspace, the command gradlew setupDecompWorkspace for setting up the environment (which includes a decompilation of Minecraft - if this is not desired, use gradlew setupDevWorkspace instead). Next, gradlew genIntellijRuns was run for generating the Gradle tasks. Note that the Gradle Java version was manually set in the gradle.properties file by adding the line java.import.gradle.java.home=C:/Program Files/Eclipse Adoptium/jdk-8.0.312.7-hotspot (the same folder as the default Project SDK picked in the step above). Furthermore, the gradle-wrapper.properties distribution URL was set to distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.3-all.zip.
If developing in VSCode, may need to first open the project in IntelliJ to generate all required files. Install the Extension Pack for Java and Gradle for Java extensions and make sure the 1.8/Java 8 folder is set in the org.eclipse.buildship.core.prefs file under java.home.
Ok, so after 12+ hours of trying absolutely everything, here is what I found. I am not sure if anything is missing, or anything in here is not needed.
- Install the Azul Zulu 15 package from https://www.azul.com/downloads-new/?version=java-15-mts&os=linux&architecture=x86-64-bit&package=jre#zulu. For more help, see https://docs.azul.com/core/zulu-openjdk/install/debian#install-deb-package.
- Install the Adoptium OpenJDK 12 (I chose 12 because that's what we use on Github to build chat-mate-client)
- Install the Adoptium JDK 8 (Tumerin)
- https://adoptium.net/temurin/archive/?version=8
sudo tar -xzf /home/rebel/Downloads/OpenJDK8U-jdk_x64_linux_hotspot_8u362b09.tar.gz -C /usr/lib/eclipse-adoptium
- Make sure all three versions are added to Project Structure -> Platform Settings -> SDKs
- No need to modify the
$PATHenvironment variable (the JDK installations should be in the/usr/libfolder, which is already on thePATH) - No need to set the
$JAVA_HOMEenvironment variable - Don't set the SDK in the Project Settings -> Structure. It appears to be automatically set to adopt-12 (JDK 12)
- Use the
setupDevWorkspacetask (thesetupDecompWorkspacedoesn't work and I don't know why), and manually add the MinecraftForge source file in Project Structure -> Libraries. This will need to be copied from a working project.
There is a keyboard bug on Linux that prevents the decimal keys 2 and 6 to be recognised while LShift is held down. To fix this, add this mod to the mods folder: https://github.com/Leo3418/mckeyboardfix
If the MinecraftForge source is not found, manually get the forgeBin and forgeSrc files from a working project and add them to the Gradle cache folder:
.gradle/caches/minecraft/net/minecraftforge/forge/1.8.9-11.15.1.2318-1.8.9/stable/22/
If the startup fails because the GradleStart class can't be found, make sure to first run a setup*Workspace task.
If running the setupCiWorkspace or setupDevWorkspace task fails because a Pack200 class was not found, it means you are using the wrong Java version to build. I think you want to use the version 12 JDK.
In order to allow characters such as '§', Java files must be encoding using UTF8, and the Java VM must be told of this.
- In the IntelliJ settings, set global and project encodings to UTF8
- In the system environment variables, add
JAVA_TOOL_OPTIONSwith value-Dfile.encoding=UTF8(see explanation)
To build the project, use gradlew build -Penv=[local|debug|release]. If the env project property is omitted, it will
default to local.
Environment properties are defined in config.groovy. Currently, there is no known method of setting the environment
when debugging locally - it will default to local. To debug using other environments, the configuration file must be
temporarily modified directly.
Build output: chat-mate-client/build/libs/*.jar.
Debug partial .minecraft folder: chat-mate-client/run/.
GitHub Actions are used for automatically building and testing the Client when pushed.
If the string --skip-tests is included in the commit message, the test project will not be built and unit tests will be skipped on Github.
If the string --skip-deploy is included in the commit message, a new release will not be created, and the built .jar file will not be published. It will still be uploaded as an artifact as part of the action, though.
Use the IntelliJ extension VisualVM Launcher from the Marketplace: https://plugins.jetbrains.com/plugin/7115-visualvm-launcher/.
Start the profiling session by using the "Debug with VisualVM 'Minecraft Client'" configuration at the top. Download and extract
VisualVM and copy the path of the executable in the /bin folder to the empty input field.
On Linux, IntelliJ runs into a permission error when attempting to run the above-mentioned configuration. To get around this, ignore the error and open VisualVM window manually by running the visualvm script in the extracted /bin folder.
Once started, Minecraft can be profiled within VisualVM via the GradleStart application. A partial snapshot can be
recorded within the Sampler tab.
List of unicode emojis that can be printed directly in chat: https://archive.ph/dhIN8
- Punishment events now show who issued the punishment, if known
- Added a colour selector to HUD text elements
- Clicking on a format button will insert the corresponding formatting into the text
- Added new Dashboard section for displaying ChatMate notifications
- Some API errors are displayed and can be dismissed, or the request can be retried
- Some API stores have been refactored into a common class to make this easier
- Fixed dialog content overflowing
- Fixed HUD bugs
- Live reactions are now shown, emerging from the bottom left corner and fading away as they ascend, similar to Youtube's "reaction fountain"
- Added the ability to add custom text elements to the ChatMate HUD
- Accessible via the context menu
- Supports Minecraft formatting via the '§' character
- Improved invalid login behaviour
- Fixed momentary freeze when starting ChatMate
- Connects to the new ChatMate websocket
- Streamer chat and events are now received instantly without the need to poll the REST API
- If the websocket disconnects, data will be retrieved periodically via the REST API, though at a reduced rate compared to what it used to be
- Old Sandbox releases/tags on Github are now automatically cleaned up when a new build with a duplicate major, minor, and patch version is deployed
- Public emojis are now rendered in chat
- This feature is enabled only for chat users with a donator rank
- While fetching the emoji image, a blank placeholder is reserved in the chat window and will be filled in once the emoji has finished loading
- Emojis are cached in the ChatMate data folder for better efficiency
- Custom emojis are now also cached for better efficiency
- There is now an option to only show the livestream-related ChatMate HUD indicators (live status and live viewers) while livestreaming
- Improved the debuggability of Interactive Elements
- The CI build process now automatically creates a release on Github with the built .jar file
- Fixed a crash when logging out
- Improved displayed ChatMate version
- Added customisable chat mentions that can be tested in the Dashboard -> Chat section
- Rank update events are now shown in chat, including, upon hover, a crude summary of applied/failed external actions
- Chat messages that are deleted by a user externally are now marked as deleted in the Minecraft chat
- Caches are now invalidated when the user logs out
- Removed the 5-minute restriction for issuing timeouts
- Updated the donations page in the Dashboard
- Donations can now be manually created
- Donations can now be refunded
- Donations can now be deleted
- If set, custom rank names are displayed as part of a user's chat message
- Added documentation
- Added scrolling to the ranks/punishments list
- Fixed livestream element on the General Dashboard page showing an error when logged-in session is invalid
- First-time chatters are now announced in the chat, and new (<24 hours) channels are highlighted using a star
- Right-clicking a user now allows the option to go to the user's channel
- Logs can now be toggled via the ChatMate Dashboard -> Debug menu
- Unit tests can now be skipped during the CI build
- Some API requests are now retried for improved reliability
- Fixed donation effect not working properly
- Fixed the command status icon not being sized correctly
- Livestream commands now show the current status
- Project is now building on Linux
- Fixed bug where HUD screen would not close when pressing the Escape key
- Major refactor of the internal event system
- Removed the server logs HUD component
- Removed API schemas
- Added verification badges to users that are linked with a registered account
- Command messages can be hidden, greyed out, or shown as normal messages
- Chat pagination now allows multiple rows per item
- Improvements to the Interactive GUI System
- Any element can now easily listen for onClick events
- Generalisation of vertical/horizontal layout of elements in a Container
- Added the ability to log in/out. It is assumed that the logged-in user is also a Streamer
- Login info is stored in the Config file, and ChatMate attempts to automatically log the user in at startup
- API requests now include the loginToken and Streamer name, if available
- Added new HUD element for displaying donation data. It has 3 optional data sources, filtered for this stream or since a custom date:
- Total donation amount
- Latest N donations (username and amount)
- Highest N donations (username and amount)
- Custom emojis are now rendered within donation messages
- Linking donations now respects the linkIdentifier, so that multiple donations may be affected by a single action
- Added "advanced mode" to the counter
- Allows customising the counter text by accepting variables
- Variables are defined in a list using a name-value pair
- The value is a mathematical expression that may depend on other variables
- Supports multiple lines using "\n"
- Fancy syntax highlighting and validation
- Added a button in the Dashboard's HUD section for resetting the HUD
- Graphical bug fixes
- The transform of HUD elements is now persisted
- Added the ability to select multiple HUD elements by holding the left Shift key
- Dragging/scrolling applies to all currently selected items
- Added Debug section in the ChatMate Dashboard
- Bug fixes, some of which were caused by the new FontEngine
- All ChatMate configuration has now been moved to the Dashboard
- More fine-tuned settings for platform separation
- Displaying the YouTube/Twitch icon next to chat messages can now be toggled
- The status indicator and viewer count can now each be separated, with the option of also displaying the respective platform icon
- Chat box improvements
- Scrolling the chat is now animated
- Scrolling positions are no longer clamped to lines, increasing smoothness
- The left scrollbar is now more visible and draggable
- Higher message retainment
- Fixed screen-resizing causing layout issues with some chat components
- Migrated all HUD components to the new Interactive system
- More
Dimification in the codebase. For chat-related calculations, this actually results in higher precision
- Added a fancy Donations section to the ChatMate Dashboard with intuitive and fluent UI
- Lists the donations with some filtering options
- Users can be linked or unlinked
- When requesting to link a user, a text box with a dropdown list appears that can be used to search for users
- Started reworking the HUD system so it re-uses the InteractiveScreen ecosystem
- Donations are received as a ChatMate event and shown by a dropdown card
- A timer bar indicates how much longer the donation card will be visible
- The donation card can be closed or linked to a user via the top-right icon buttons
- Donators receive chat effects whose duration depends on the donation amount and highest donator rank
- For every dollar donated, the effect will stay for another 5, 10, or 15 minutes for Donators, Supporters, or Members, respectively
- The effect duration is counted only while livestreams are live, and is additive among multiple donations
- Donators+ receive a rainbow effect
- Supporters+ receive a wave effect
- Members receive a particle effect
- Many improvements and additions to the InteractiveScreen
- Added ApiStores for smart caching
- Added a FontEngine in place of the Forge FontRenderer for customising the rendering of text and allow for more options
- Added a modal for managing standard ranks, which shares its implementation with the punishment modal
- Chat messages now show the user's current highest rank, instead of the default "VIEWER"
- Improved platform separation to show a little YouTube/Twitch logo, instead of changing the rank text
- Improved API error handling
- Extended the capabilities of the vertical layout algorithm in the container element
- Improved cursor mechanics, and added the "click" cursor to more elements when hovering
- Added downward migrations to the config data
- Makes it easier to jump between a testing and production environment
- Added CI for building and testing the project when pushing to GitHub
- Added ChatMate Dashboard (WIP)
- This will be the one place for administration, configuration, etc
- Added indicators for when the server reports an error or warning
- Heartbeat indicator behind the status indicator
- Time series plot in the top right corner
- Added build configurations for easily injecting different sets of environment variables
- Visual bug fixes related to modals
- Added fancy modal screens for:
- Displaying a list of the user's historic punishments
- Viewing punishment details
- Creating a new punishment
- Modifying an active punishment
- New interactive features such as hover animations, tooltips, a checkbox element, centralised z-index and side effect handling, and many bugfixes
- Added configuration for identifying platform-specific information
- The status indicator and viewer count is split into two
VIEWERranks are split intoYOUTUBEandTWITCHranks
- Bug fixes and visual improvements
- Created a brand new, fully fledged HTML-inspired layout engine
- Automatic layout calculations
- Hierarchical rendering and event propagation
- Beautiful API via abstraction of low-level details
- Impressive visual debugging capabilities
- The modal for modifying experience now uses the new layout engine
- The Counter and Countdown Title are now their own components
- Both support translation, and counters support scaling
- Can be set up via new modals by right clicking the HUD screen and selecting the relevant option from the context menu
- Small visual fixes in chat
- Added Custom Emoji rendering in chat
- Visual fixes and improvements
- Added a huge amount of fancy in-game chat updates
- Minecraft now renders a custom GuiChat and GuiNewChat so we can override things
- PrecisionChatComponentText for exactly determining how a component should be positioned on a chat line
- ContainerChatComponent for holding references to ChatComponents and custom data
- In-place pagination of chat. Formatted nicely, includes a close button
- Added a context menu
- For now, right clicking a user's name will allow the option to bring up their rank, or modify their experience
- Added GUI window for modifying a user's experience
- Added search command for searching for a user. Results are displayed in chat
- Custom cursors that change appearance based on the current context
- API objects now use the standardised PublicObjects and errors
- Added
/cm rankscommand for displaying the leaderboard- If called without arguments, will display the full leaderboard with pagination
- If called with a name argument, will display only a section of the leaderboard that features the specified channel
- Added a migration framework for the config file
- Various small bug fixes, visual fixes, and code improvements
- Minecraft chat entries from ChatMate are now withheld if a chat GUI is not currently visible
- Better logging
- Added live viewer count to the HUD, which nicely animate changes in value
- Added info messages for level-up events using the new events endpoint
- Levelling up a multiple of 5 will display a short static message
- Levelling up a multiple of 20 will display a composite semi-randomly generated message
- Improved implementation of input events
- More fine-tuned dragging of HUD components
- Added the ability to zoom HUD components using the mouse wheel
- Mod settings are now persisted locally
- Added HUD overlay and screen
- Currently displays the status indicator
- Indicator can be dragged when in the HUD screen (hotkey
y)
- Improved appearance of the Mod Config screen
- Added experimental MVC architecture for building custom and reusable GUI components
- Levels are displayed next to the author's name in the same style as Mineplex levels
- Added
/cm countercommand for the charity livestream - Lots of refactoring
- Added
/cm countdowncommand - Added unit tests
- Fixed chat filter exploits involving Minecraft chat formatting
- Added Config option to disable mod sounds
- Improved API response class structure
- Fixed chat filter exploit using Minecraft formatting
- Added chat-mention colour highlight and sound effect, hardcoded for now for only
Rebel_Guyand some variants - Improved filter algorithm to allow for special selectors:
#to comment out a line+to whitelist a word*to match any character[and](for use at the start/beginning of the filtered word) to match the word only if its start/end corresponds to[/]
- Added colour formatting to Minecraft chat messages
- Added button in main menu to enable/disable the mod
- Added simple message filter
- Emojis and other special unicode characters are now displayed directly if the resource pack supports it
- Fixed encoding issues
- Initial release
- Simple fetching and displaying of chat messages