Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/chatty/chatty

Twitch Chat Client written in Java
https://github.com/chatty/chatty

chat java standalone twitch

Last synced: 3 months ago
JSON representation

Twitch Chat Client written in Java

Lists

README 

        
Chatty

======



Chatty is a Twitch Chat Client for Desktop written in Java featuring many

Twitch specific features.



* Website: https://chatty.github.io

* E-Mail: [email protected]

* Twitter: @ChattyClient (https://twitter.com/ChattyClient)

* Mastodon: https://mstdn.social/@chattyclient

* YouTube: https://www.youtube.com/user/chattyclient

* Discord: https://discord.gg/WTuqGeJ



I learned about most of the Java techniques and APIs used in this during

development, so many things won't be designed ideally. I also never

released such a project as opensource before, so if I missed anything or

didn't adhere to some license correctly, please tell me.



Download

========



Go to the [website](https://chatty.github.io) for ready to use downloads

and more information on the features.



Contributions

=============



Contributions to Chatty under the terms of the GPLv3 License (or compatible) are

welcome.



If you're contributing code that you didn't write yourself, make sure to adhere

to whatever license terms it is under (like retaining copyright notices) and to

detail that in the Pull Request.



Obviously, I won't be able to accept all contributions, for example I may

already be working on something similar. If you plan to put more than a little

effort into a Pull Request, consider asking first if what you're doing has a

chance of being added.



License Information

===================



Chatty, as a whole, is released under the GPLv3 or later (see included

`LICENSE` file).



    Copyright (C) 2017-2023  tduva and contributors



    This program is free software: you can redistribute it and/or modify

    it under the terms of the GNU General Public License as published by

    the Free Software Foundation, either version 3 of the License, or

    (at your option) any later version.



    This program is distributed in the hope that it will be useful,

    but WITHOUT ANY WARRANTY; without even the implied warranty of

    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    GNU General Public License for more details.



    You should have received a copy of the GNU General Public License

    along with this program.  If not, see .



Partly based on source code (most files located in the `src/chatty/` directory

and subdirectories) licensed under the MIT license.



    Copyright (c) 2014-2017  tduva and contributors



    Permission is hereby granted, free of charge, to any person obtaining a

    copy of this software and associated documentation files (the "Software"),

    to deal in the Software without restriction, including without limitation

    the rights to use, copy, modify, merge, publish, distribute, sublicense,

    and/or sell copies of the Software, and to permit persons to whom the

    Software is furnished to do so, subject to the following conditions:



    The above copyright notice and this permission notice shall be included in

    all copies or substantial portions of the Software.



    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER

    DEALINGS IN THE SOFTWARE.



External Libraries

------------------



* JSON-Simple:

  * Files under `assets/lib/`: `json-simple-*.jar`, `json-simple-tag_release_1_1_1.zip`

  * Website: 

  * License: "Apache License 2.0"

	(for the license text see the APACHE_LICENSE file

	or ).



* JKeyMaster (modified):

  * Files under `assets/lib/`: `jkeymaster-*`

  * Website: 

  * License: "LGPL-3.0 License"

  * Using JNA () under "Apache License 2.0"



* JTattoo by MH Software-Entwicklung:

  * Files under `assets/lib/`: `JTattoo-*.jar`, `JTattoo-*-sources.zip`

  * Website: 

  * License: GPLv2 or later (see )

  * Based on v1.6.12 with some modifications by tduva



* FlatLaf by FormDev:

  * Website: https://www.formdev.com/flatlaf/

  * License: "Apache License 2.0"

    (see )



* Java-Websocket:

  * Files under `assets/lib/`: `JavaWebsocket-*.jar`

  * Website: 

  * License: "MIT"

	(see )

  * Requires SLF4J (http://www.slf4j.org/, MIT, `slf4j-*.jar`)



* Txtmark:

  * Files under `assets/lib/`: `txtmark-0.13.jar`, `txtmark-txtmark-0.13.zip`

  * Website: 

  * License: "Apache License 2.0"

	(for the license text see the APACHE_LICENSE file

	or ).



* Apache HttpComponents Client:

  * Files under `assets/lib/`: `httpclient*.jar`, `httpcore*.jar`, `commons-codec*.jar`

  * Website: 

  * License: "Apache License 2.0"

    (for the license text see the APACHE_LICENSE file

	or ).



* WebPDecoderJN:

  * Files under `assets/lib/`: `WebPDecoderJN-*.jar`

  * Website: 

  * License: "3-Clause BSD"

    (see )

  * Requires JNA



* Additional external/modified libraries integrated under `src/chatty/` have license/source

  information in the file header



Images / Other

--------------



* Favorites Icon by Everaldo Coelho:

  * File (in various folders): `star.png`

  * Source: 

  * License: LGPL

	(for the license text see the LGPL file or

	)



* Misc Icons from the Tango Icon Theme:

  * Files (in various folders): `list-add.png, list-remove.png, view-refresh.png,

		help-browser.png, preferences-system.png, search.png,

		dialog-warning.png, go-down.png, go-up.png, go-next.png,

		go-previous.png, go-home.png, go-web.png,

		image-icon.png, commandline.png, edit-copy.png, sort.png,

		edit-all.png (edited), reply.png (edited)`

  * Source: 

  * License: Released into the Public Domain



* Misc Icons from NUVOLA ICON THEME for KDE 3.x

		by David Vignoni:

  * Files (in various folders): `edit.png, ok.png, no.png, colorpicker.png,

		warning.png, download.png, game.png`

  * Source: 

  * License: LGPL

	(for the license text see the LGPL file or

	http://www.gnu.org/licenses/lgpl.html)



* Robot Icon by Yusuke Kamiyamane:

  * File (in various folders): `icon_bot.png`

  * Source: 

  * License: CC-BY 3.0

	()



* Announcement Icon Material Design (slightly modified):

  * Files: `announcement*.png`

  * Source: 

  * License: Apache 2.0

    ()



* Twitter Emoji Images:

  * Files: `gui/emoji/twemoji/*`

  * Source: 

  * License: CC-BY 4.0

	(https://creativecommons.org/licenses/by/4.0/)



* Emoji One Images:

  * Files: `gui/emoji/e1/*`

  * Source: 

  * License: CC-BY 4.0

	()

  * Old version (seems no longer available), not updated since newer

    versions are not under a free license



* Emoji Metadata based on:

  * Source: https://github.com/github/gemoji/blob/master/db/emoji.json

  * License: MIT

	()



* Emoji Metadata supplemented by:

  * Source: https://github.com/joypixels/emojione/blob/master/emoji.json

  * License: MIT

	()

  * Now outdated, seems to be no longer updated



* Emoji Metadata supplemented by:

  * Source: 

  * License: 



* Example Sounds by tduva:

  * Files: `assets/sounds/*`

  * Source: Recorded myself

  * License: CC-BY 4.0

	()



Notes on building the program yourself

======================================



The project is compiled using Gradle. Once you've checked it out, you can run

`gradlew build` to compile and run the tests, and `gradlew release` to package

the release artifacts.



If you modified Chatty you should set your own client id in `Chatty.java`. You

may also want to disable the Version Checker.



Main release tasks

------------------



* `release` - Just the regular JAR version Zip

* `releaseWindows` - Regular and Windows Standalone Zip

* `releaseWinSetups` - Everything, including Windows Standalone and Windows setups



Build parameters

----------------



* Windows Standalone (one of these required for the Windows Standalone tasks)

  * `javapackagerPath` - Path to the `javapackager.exe` in the Java 8 JDK

    * `jrePath` - Adds `-Bruntime=` option for javapackager (optional, will use

      default JRE otherwise)

  * `jpackagePath` - Path to the `jpackage.exe` in the Java 14+ JDK (if you

    specify this one, it will use jpackage instead of javapackager)

  * `mtPath` - Path to Microsoft's `mt.exe` (see e.g.

    ),

    used to add `assets-bundle/Chatty.exe.manifest` to the `Chatty.exe`/

    `ChattyPortable.exe` (optional)

* `innosetupPath` - Path to InnoSetup's `iscc.exe` (required for the Windows

  installer tasks)



These build parameters must be specified like this:

`gradlew windowsZip -PjavapackagerPath="/javapackager.exe"`



Full example:

`gradlew -Dorg.gradle.java.home="C:/Program Files (x86)/Java/jdk1.8.0_201" releaseWinSetups --console=verbose -PjavapackagerPath="C:/Program Files (x86)/Java/jdk1.8.0_201/bin/javapackager.exe" -PjrePath="C:\Program Files (x86)\Java\jre1.8.0_201" -PinnosetupPath="C:\Program Files (x86)\Inno Setup 6\ISCC.exe"`