Skip to content

Latest commit

 

History

History
255 lines (204 loc) · 10 KB

README.md

File metadata and controls

255 lines (204 loc) · 10 KB
Raw

Chatty

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

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 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 <http://www.gnu.org/licenses/>.

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

Images / Other

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. https://stackoverflow.com/questions/54462568/how-to-install-just-mt-exe), 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="<path_to>/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"