Chatty/chatty.github.io
1
0
Fork 0
mirror of https://github.com/chatty/chatty.github.io.git synced 2024-09-16 21:32:26 +02:00
Code Issues Projects Releases Wiki Activity

More v0.9 files

Browse Source
This commit is contained in:
tduva 2017-12-26 18:26:29 +01:00
parent bcd6eefee7
commit 151ade149b
14 changed files with 1132 additions and 142 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

684
help/GPLv3.html Normal file
View File

@ -0,0 +1,684 @@
<!DOCTYPE html>
<html>
<title>Chatty - About/License</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<body>
<pre>
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. &lt;http://fsf.org/&gt;
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
&lt;one line to give the program's name and a brief idea of what it does.&gt;
Copyright (C) &lt;year&gt; &lt;name of author&gt;
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 &lt;http://www.gnu.org/licenses/&gt;.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
&lt;program&gt; Copyright (C) &lt;year&gt; &lt;name of author&gt;
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
&lt;http://www.gnu.org/licenses/&gt;.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
&lt;http://www.gnu.org/philosophy/why-not-lgpl.html&gt;.
</pre>
</body>
</html>

107
help/help-about.html Normal file
View File

@ -0,0 +1,107 @@
<!DOCTYPE html>
<html>
<title>Chatty - About / License</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<body>
<div id="backlink"><a href="help.html">To main help page</a></div>
<h1><a name="top">About/License</a></h1>
<p>Chatty is released, as a whole, under the <a href="GPLv3.html">GPLv3</a>.
The source code for this program is available on
<a href="https://github.com/chatty/chatty">GitHub</a>.</p>
<pre>
Copyright (C) 2017 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 &lt;http://www.gnu.org/licenses/&gt;.</pre>
<h2>Third-party components</h2>
<p>Chatty wouldn't be as it is today without the work of others.
See the <a href="https://github.com/chatty/chatty">GitHub Repository</a>
for more detailed license information.</p>
<h3>Libraries</h3>
<ul>
<li><a href="https://code.google.com/p/json-simple/">JSON-Simple</a> under <a href="http://www.apache.org/licenses/LICENSE-2.0">"Apache License 2.0"</a></li>
<li>Versions with Windows Global Hotkey support use <a href="https://code.google.com/p/jintellitype/">JIntellitype</a>,
licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">"Apache License 2.0"</a>.</li>
<li><a href="https://tyrus.java.net">Tyrus</a> standalone websocket client library dual-licensed under
<a href="https://tyrus.java.net/license.html">CDDL 1.1 and GPL 2 with CPE</a>.</li>
<li><a href="http://www.jtattoo.net">JTattoo</a> by MH Software-Entwicklung,
under <a href="http://www.gnu.org/licenses/gpl-3.0.txt">GPLv2 or later</a></li>
</ul>
<h3>Images / Other resources</h3>
<ul>
<li><a href="https://www.iconfinder.com/icons/17999/bookmark_favorite_star_icon">Favorite Icon</a>
(Star Icon) by Everaldo Coelho under <a href="http://www.gnu.org/licenses/lgpl.html">LGPL</a>.</li>
<li>Several Icons from the <a href="http://tango.freedesktop.org/Tango_Icon_Library">Tango Icon Theme</a>
(Public Domain).</li>
<li>Edit Icon (Pencil Image), Ok Icon (Green Arrow), Invalid Icon (Cross) from <a href="http://www.icon-king.com/projects/nuvola/">NUVOLA ICON THEME</a> for KDE 3.x by David Vignoni
under <a href="http://www.gnu.org/licenses/lgpl.html">LGPL</a>.</li>
<li>Robot Icon by <a href="http://p.yusukekamiyamane.com">Yusuke Kamiyamane</a> under <a href="http://creativecommons.org/licenses/by/3.0/">CC-BY 3.0</a>.</li>
<li>Emoji:
<ul>
<li>Emoji info (description, category) based on <a href="https://github.com/Ranks/emojione/blob/master/emoji.json">emoji.json by EmojiOne</a>
under the <a href="https://opensource.org/licenses/MIT">MIT License</a></li>
<li><a href="http://emojione.com/">EmojiOne</a> images licensed under
<a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International</a></li>
<li><a href="https://github.com/twitter/twemoji">Twitter Emoji (Twemoji)</a> images licensed under
<a href="https://creativecommons.org/licenses/by/4.0/">CC-BY 4.0</a></li>
</ul>
</li>
</ul>
<h2>
<a name="thanks">Miscellaneous/Thanks</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>Some of the resources that were helpful in the development of this program:</p>
<ul>
<li>Thanks to <a href="http://java-sl.com">java-sl.com</a> for some nice articles.</li>
<li>Thanks to <a href="http://twitchemotes.com">Twitchemotes.com</a> for
their API endpoints providing additional emote information.</li>
<li>Thanks to <a href="https://frankerfacez.com">FrankerFaceZ</a> for
their Emotes/APIs and support.</li>
<li>Thanks to <a href="http://www.nightdev.com">Nightdev</a> for allowing the use
of the <a href="http://www.nightdev.com/betterttv/">BetterTTV</a> emotes.</li>
</ul>
<h2>Other License Information</h2>
<p>Partly based on source code (most files located in the src/chatty/
directory and subdirectories) licensed under the MIT license.</p>
<pre>
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.
</pre>
</body>
</html>

8
help/help-admin.html
View File

@ -32,14 +32,14 @@
<p>Use <code>Select game</code> to open a dialog where you can search for
a game and also add games to the favorites.</p>
<h3>Select a community</h3>
<h3>Select communities</h3>
<p>Communities in Twitch are an additional category you can select for your
stream. If you want to use a Community, you need to select an already
existing one. As with games, you can add favorite Communities. Make sure
to adhere to the rules when selecting a Community.</p>
to adhere to the rules when selecting a Community for your stream.</p>
<h3>Use presets</h3>
<p>Status Presets allow you to store the current title, game and community
<h3>Presets</h3>
<p>Status Presets allow you to store the current title, game and communities
for later use. A status is automatically added every time you press the
<code>Update</code> button (can be disabled in the History settings),
but will be removed after some time of not being used. You can also add

37
help/help-custom_commands.html
View File

@ -26,6 +26,7 @@
<li><a href="#commands-list">Format 1: List Custom Command Names</a></li>
<li><a href="#inline-commands">Format 2: Inline-Commands</a></li>
<li><a href="#submenus">Format 3: Submenus</a></li>
<li><a href="#separators">Separators</a></li>
<li><a href="#shortcuts">Shortcuts</a></li>
<li><a href="#positioning">Positioning</a></li>
<li><a href="#special-commands">Special Commands</a></li>
@ -66,6 +67,13 @@
way to can add variations of commands for specific channels.</p>
<h2><a name="replacements">Replacements</a></h2>
<ul>
<li><a href="#simple-replacements">Simple Replacements</a></li>
<li><a href="#parameters-context">Pre-defined Parameters</a></li>
<li><a href="#functions">Functions</a></li>
<li><a href="#custom-replacements">Custom Replacements</a></li>
</ul>
<p>Anything starting with <code>$</code> in the <code>&lt;what the command
should do&gt;</code> section is treated as some sort of replacement.
Each replacement must contain an <strong>identifier</strong>
@ -303,6 +311,16 @@
<h2><a name="menus">Custom Context Menus / User Dialog Buttons</a></h2>
<ul>
<li><a href="#commands-list">Format 1: List Custom Command Names</a></li>
<li><a href="#inline-commands">Format 2: Inline-Commands</a></li>
<li><a href="#submenus">Format 3: Submenus</a></li>
<li><a href="#separators">Separators</a></li>
<li><a href="#shortcuts">Shortcuts</a></li>
<li><a href="#positioning">Positioning</a></li>
<li><a href="#special-commands">Special Commands</a></li>
</ul>
<p>Under <code>Settings - Commands</code> there are several settings that
allow you to add additional entries/buttons in a few different places:</p>
@ -446,6 +464,25 @@ Spoiler[S]=/timeout $$1 600 No spoilers
command.</p>
<h3><a name="separators">Separators</a></h3>
<p>In <strong>Context menus</strong> you can add separators between entries.
When you use a <a href="#commands-list">commands list</a>, you can add
a vertical bar (<code>|</code>) between entries.</p>
<p>You can also add a separator by adding a single dash (<code>-</code>) on
it's own line.</p>
<p>Example (separator before <code>Timeout</code> menu, before <code>Message</code>
and before <code>Vods</code>):</p>
<div class="codeblock"><pre>
/Ban /Purge
-
@Timeout
.5s 10m
-
/Message /Report | /Vods
</pre></div>
<h3><a name="shortcuts">Shortcuts</a></h3>
<p>You can add a shortcut to the end of a label or command name by enclosing
it with <code>[ ]</code> (square brackets):</p>

3
help/help-guide1.html
View File

@ -23,6 +23,9 @@
with completely different settings, just by using that commandline parameter
and specifying different working directories (e.g. in Windows in the shortcut
settings).</p>
<p>You can also use the <code>-d &lt;dir&gt;</code> parameter to specify the
directory directly.</p>
<p>See also: <a href="help-guide_create_shortcut.html">Create Shortcut</a>.</p>
<h2>Sharing login data</h2>

1
help/help-guide2.html
View File

@ -2,6 +2,7 @@
<html>
<title>Chatty Help</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<meta charset="UTF-8">
<body>
<div id="backlink"><a href="help.html">Back to main help page</a></div>
<h1><a name="top">Guide: What to do when getting login fails</a></h1>

2
help/help-guide_create_shortcut.html
View File

@ -15,7 +15,7 @@
with that.</li>
<li>You can give Chatty
<a href="help.html#launch">launch options</a>, like
<code>-cd</code> to use a different
<code>-cd</code> or <code>-d</code> to use a different
<a href="help-guide_folders.html">settings directory</a>.</li>
<li>You can attach Chatty to the taskbar.</li>
<li>You can give the shortcut the Chatty icon, to replace the Java icon

4
help/help-guide_folders.html
View File

@ -39,6 +39,10 @@
<p>You can use commandline parameters by <a href="help-guide_create_shortcut.html">creating a shortcut</a> and setting the
target to something like <code>javaw.exe -jar "D:\Chatty\Chatty.jar" -cd</code>.</p>
<p>Alternatively, the <code>-d</code> parameter allows you to specify
a settings directory directly: <code>javaw -jar "D:\Chatty\Chatty.jar" -d D:\program settings\Chatty</code>
(the specified directory has to exist already)</p>
<p>Use the command <code>/dir</code> to display and <code>/openDir</code> to
open the Settings Directory.</p>

7
help/help-memory_usage.html
View File

@ -33,15 +33,16 @@
and add the appropriate parameter after the <code>javaw.exe</code> but
before the <code>-jar</code> parameter.</p>
<p>For example to restrict memory to 150 MB: <code>javaw -Xmx150M -jar "D:\Chatty\Chatty.jar"</code>.
You should test out yourself how low you can go, although more than 100 MB
<p>For example to restrict memory to 400 MB: <code>javaw -Xmx400M -jar "D:\Chatty\Chatty.jar"</code>.
You should test out yourself how low you can go, although more than 150 MB
is usually recommended. Note that Java will show a higher usage than
this in the Task Manager, since this pretty much only restricts how much
the program can store, Java will need some more for it's own management
and data.</p>
<p>For the Windows Standalone version you can add this value to the file
<code>&lt;path to Chatty&gt;/app/Chatty.cfg</code>.</p>
<code>Chatty.cfg</code> located in the <code>app</code> subfolder of
the Chatty folder.</p>
<h2><a name="error">OutOfMemoryError</a></h2>
<p>If you get an OutOfMemoryError then Java ran out of memory. This can

66
help/help-releases.html
View File

@ -2,6 +2,8 @@
<html>
<title>Chatty Release Information</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<meta charset="UTF-8">
<style type="text/css">
pre {
border-left: 1px solid #AAAAAA;
@ -15,6 +17,7 @@
<h1><a name="top">Release Information</a></h1>
<p>
<a href="#0.9">0.9</a> |
<a href="#0.8.7">0.8.7</a> |
<a href="#0.8.6">0.8.6</a> |
<a href="#0.8.5.1">0.8.5.1</a> |
@ -47,7 +50,68 @@
full list of changes.</p>
<h2>
<a name="0.8.7">Version 0.8.7</a> <a name="latest">(This one!)</a> (2017-09-12)
<a name="0.9">Version 0.9</a> <a name="latest">(This one!)</a> (2017-12-26)
<a href="#top" class="top">[back to top]</a>
</h2>
<p>This version includes more Look and Feels which you can select in the
settings, including some fully dark themes.</p>
<p>There should also be a slight improvement in memory usage and startup
performance, since not all emote metadata is loaded at once anymore
(which actually takes up a lot of resources with more than 300k emotes).</p>
<p>Also check out TAB Completion for Emoji, with which you can e.g. enter
<code>:think</code> and <kbd>TAB</kbd> to complete to <code>:thinking:</code>,
which when send through the inputbox is replaced with the appropriate
Emoji character (which is also a new feature).</p>
<pre>
### Twitch Updates
- Added /raid command and display of incoming raids, joining raids doesn't work
- Added support for gifted sub messages
### Look / GUI
- Added more Look and Feels, including dark themes
- Added custom presets to color settings
- Added userlist font setting
- Improved organization and help in Settings Dialog a bit
- Updated Chatty app icons
- Added feature to customize message color based on rules (like Highlighting,
except it only colors messages)
- Updated help
### Emoticons / Emoji
- Load emoticon metadata only as needed to improve memory usage
- Updated source for subscriber emoticon metadata, fixing e.g. which channel an
emote is from, added display of emote tiers
- Improved display of information in emote context menu and emote dialog
- Grouped together sets with only one emote in Emote Dialog
- Fixed some BTTV emotes (like D:) appearing when they shouldn't
- Added Emoji TAB Completion (anything starting with ":")
- Added conversion of Emoji short code to Emoji character when entered into the
inputbox (e.g. :thinking: -> 🤔 when being sent)
### Settings
- Added -d launch argument to directly specify settings directory
- Added ability to execute program for Notifications (e.g. run native Linux
notification)
- Added ability to change spamProtection setting without restart
- Added F1 to open help to settings (instead of it being hardcoded)
- Added "log ignored messages" setting, to be able to turn that off (by default
it does log them, as before)
- Added more timestamp options to the settings (anything can be set via setting
commands anyway, but that's not very accessible)
- Improve setting commands
### Bugfixes
- Fixed bug with separators in custom context menus
- Fixed some emote code conversions
- Fixed error on "Use title only" in Admin Dialog
- Possibly fixed rare error with parsing livestreamer menu options
</pre>
<h2>
<a name="0.8.7">Version 0.8.7</a> (2017-09-12)
<a href="#top" class="top">[back to top]</a>
</h2>
<p>This update finally contains the ability to set the three communities. It

50
help/help-setting_commands.html
View File

@ -21,6 +21,8 @@
<dd>For Boolean settings you can use <code>true</code>, <code>1</code>
or <code>on</code> to enable the setting, <code>!</code> to
toggle it and any other value to disable it.</dd>
<dd>Can be used to set the value of a key of a Map setting (for example
<code>/set lafCustomTheme selectionBackgroundColor 255 180 0</code>).</dd>
<dt><code>/get &lt;setting&gt;</code></dt>
<dd>Shows the current value of a setting.</dd>
@ -29,13 +31,15 @@
<dd>Resets the setting to the default (hard-coded) value.</dd>
<dt><code>/clearsetting &lt;setting&gt;</code></dt>
<dd>Sets String (text) settings to an empty String.</dd>
<dd>Sets String (text) settings to an empty String. Removes all entries
from List or Map settings.</dd>
<dt><code>/add &lt;setting&gt; &lt;value&gt;</code></dt>
<dd>Adds an item to a list setting.</dd>
<dd>Adds an item to a List setting.</dd>
<dt><code>/remove &lt;setting&gt; &lt;value&gt;</code></dt>
<dd>Removes an item from a list setting.</dd>
<dd>Removes an item from a List setting or removes a key (and the
associated value) from a Map setting.</dd>
</dl>
<p><em>Tip:</em> You can use <a href="help.html#nickCompletion">TAB Completion</a>
@ -61,6 +65,7 @@
viewed with <code>/get</code>.</p>
<p>
<a href="#laf">Look and Feel</a> |
<a href="#font">Font</a> |
<a href="#time">Time</a> |
<a href="#server">Server/Connection</a> |
@ -148,6 +153,45 @@
files.</td>
</tr>
</table>
<h3><a name="laf">Look and Feel</a></h3>
<table class="settings">
<tr style="border-bottom: 1px solid #EEE">
<th>Setting</th>
<th>Type</th>
<th>Values</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td class="setting">laf</td>
<td>String</td>
<td>Look&amp;Feel code</td>
<td>default</td>
<td>Look&amp;Feel code used by Chatty (can be set in the
Settings Dialog), although if starting with <code>:</code>
you can directly set a Look&amp;Feel class name, for
example <code>:javax.swing.plaf.metal.MetalLookAndFeel</code>.</td>
</tr>
<tr>
<td class="setting">lafTheme</td>
<td>String</td>
<td>Look&amp;Feel theme code</td>
<td>Default</td>
<td>Look&amp;Feel theme code used by Chatty (can be set in the
Settings Dialog), mostly to change the global font size.</td>
</tr>
<tr>
<td class="setting">lafCustomTheme</td>
<td>Map</td>
<td>Theme properties</td>
<td><em>empty</em></td>
<td>This setting can be used to directly set your own
<a href="http://www.jtattoo.net/ThemeProps.html">JTattoo Theme properties</a>.</td>
</tr>
</table>
<p><em>Note:</em> You may need to restart Chatty for Look and Feel
settings to take full effect.</p>
<h3><a name="font">Font</a></h3>

170
help/help-settings.html
View File

@ -11,6 +11,7 @@
| <a href="#Chat">Chat</a>
| <a href="#Emoticons">Emoticons</a>
| <a href="#Usericons">Usericons</a>
| <a href="#Colors">Colors</a>
| <a href="#Usercolors">Usercolors</a>
| <a href="#Highlight">Highlight</a>
| <a href="#Ignore">Ignore</a>
@ -23,7 +24,7 @@
| <a href="#Other">Other</a>
| <a href="#Advanced">Advanced</a>
| <a href="#Hotkeys">Hotkeys</a>
| <a href="#Completion">Completion</a></p>
| <a href="#TAB_Completion">TAB Completion</a></p>
<p>This page details some of the settings in the Settings Dialog
(<code>Main Menu - Settings</code>). Also try hovering over settings
in the settings dialog itself, sometimes you can get a tooltip with some
@ -48,7 +49,7 @@
indiviual line height.</dd>
</dl>
<h3>Input Font</h3>
<h3>Input/Userlist Font</h3>
<p>Input font is restricted to two fonts by default, because other fonts
cause issues due to a bug in Java. The number behind the font is the
font size. You can manually change this setting via
@ -72,21 +73,21 @@
Favorites/History dialog.</li>
</ul>
<h3>Look&amp;Feel</h3>
<p>The Look&amp;Feel changes the overall look of the program. The "System"
Look&amp;Feel depends on the system you are on, the others are
cross-platform. Some Look&amp;Feels also allow you to additionally
select a different font size, which affects most of Chatty.</p>
<h2>
<a name="Messages">Messages</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<h3>Deleted Messages (Timeouts/Bans)</h3>
<p>This allows you to define how timeouts or bans are displayed in Chatty.</p>
<p><em>Tip:</em> Click on a username in chat to open the User Info Dialog,
which also shows the timeouts/bans and the original messages.</p>
<p><strong>Please Note:</strong> The timeout duration/reason is in Beta at
Twitch, so stuff <em>may or may not</em> change at some point and break
the display in Chatty. Telling the difference between a timeout and
permanent ban also depends on this, so if this info isn't available
users who were just timed out may be shown as banned.</p>
<ul>
<li>There are three options on how to handle deleted messages in chat:
<li>How to handle deleted messages (timeouts/bans) in chat window:
<dl class="dl-settings">
<dt>Delete Message</dt>
<dd>Completely replaces the message with <code>&lt;message deleted&gt;</code>.</dd>
@ -303,16 +304,41 @@
<a name="Emoticons">Emoticons</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<h3>General Settings</h3>
<h3>General Emoticon Settings</h3>
<dl class="dl-settings">
<dt>Show emoticons</dt>
<dd>Turns emoticon codes into images. This needs to be enabled for any
emotes to show up.</dd>
<dt>Scale (Chat)</dt>
<dd>The relative size of how emotes are displayed in chat (100% is regular size).</dd>
<dt>Maximum Height</dt>
<dd>The maximum height of emotes in chat (in pixels). Use 0 to allow any height.</dd>
<dt>Emotes Dialog</dt>
<dd>The relative size of how emotes are displayed in the Emotes Dialog (100% is regular size).</dd>
<dt>Double-click on emote closes Emote Dialog</dt>
<dd>If enabled, double-clicking on an emote in the Emote Dialog closes
the Emote Dialog.</dd>
<dt>Cheers (Bits)</dt>
<dd>You can choose whether to show <a href="https://help.twitch.tv/customer/portal/articles/2449458">Cheering</a>
emotes in chat animated, as static images (like other emotes) or
not at all (so they'll just show up as text).</dd>
<dd>Sending Cheers is not supported at this point.</dd>
</dl>
<h3>Third-Party Emoticons</h3>
<dl class="dl-settings">
<dt>Enable BetterTTV Emotes</dt>
<dd>Shows BetterTTV emotes (Personal Emotes not supported at this time).</dd>
<dt>Allow animated emotes</dt>
<dd>Show animated emotes (BTTV GIF emotes).</dd>
<dt>Enable FrankerFaceZ (FFZ)</dt>
<dd>Downloads <a href="help.html#emoticons">FrankerFaceZ</a> emotes and
Mod Icons (where available).</dd>
@ -325,34 +351,21 @@
<dd>Show special FFZ emotes available in some channels (mainly
Speedrunning Events). To receive these emotes Chatty maintains a
connection to the FFZ Socket Server.</dd>
<dt>Allow animated emotes</dt>
<dd>Show animated emotes (BTTV GIF emotes).</dd>
<dt>Scale</dt>
<dd>The relative size of how emotes are displayed in chat (100% is regular size).</dd>
<dt>Maximum Height</dt>
<dd>The maximum height of emotes in chat (in pixels). Use 0 to allow any height.</dd>
<dt>Emotes Dialog</dt>
<dd>The relative size of how emotes are displayed in the Emotes Dialog (100% is regular size).</dd>
<dt>Double-click on emote closes Emote Dialog</dt>
<dd>If enabled, double-clicking on an emote in the Emote Dialog closes
the Emote Dialog.</dd>
<dt>Emoji Set</dt>
</dl>
<h3>Emoji</h3>
<dl class="dl-settings">
<dt>Set</dt>
<dd>Turns Emoji characters into images. You can choose between different
sets of Emoji images, or choose <code>None</code> to turn off Emoji
images altogether.</dd>
<dt>Cheers (Bits)</dt>
<dd>You can choose whether to show <a href="https://help.twitch.tv/customer/portal/articles/2449458">Cheering</a>
emotes in chat animated, as static images (like other emotes) or
not at all (so they'll just show up as text).</dd>
<dd>Showing Cheering Badges and sending Cheers is not supported at this
point.</dd>
<dt>Replace Emoji codes in entered text</dt>
<dd>Emoji codes like <code>:joy:</code> or <code>:mouse:</code> get
replaced with their respective Emoji character (and thus image, if
a Set is chosen) when entering them into the inputbox.</dd>
<dd><em>Tip:</em> Use <a href="help.html#TAB_Completion">TAB Completion</a>
to complete partially entered Emoji codes.</dd>
</dl>
<h3>Ignored Emotes</h3>
@ -495,6 +508,60 @@
<p><em>Tip:</em> Jump to entries in the table by clicking into a column and
start to type. Backspace or wait to get out of the search mode.</p>
<h2>
<a name="Colors">Colors</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>Customize colors of certain types of chat messages. For the general look
of the program you can choose another Look&amp;Feel from the "Main"
settings page.</p>
<h2>
<a name="Msg_Colors">Message Colors</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>You can customize the color of messages based on the same message
matching rules and patterns that are used for the
<a href="#Highlight_Matching">Highlight system</a> (not all prefixes
apply). Add a new item, enter what messages you want to match and select
the color you want them to have.</p>
<p>The order of entries can matter, the first color from the top that
matches is used.</p>
<p><em>Note:</em> The default message color is set on the "Colors" settings
page ("Normal message").</p>
<p><em>Note:</em> This feature only changes the message <em>color</em>. Use
the Highlight system instead if you want
to highlight important messages, have them added to a separate
Highlighted Messages window and maybe show a notification or play a
sound for it at the same time.</p>
<h3>Examples</h3>
<p>Examples of how to match certain messages, so you can assign it a custom
color.</p>
<dl>
<dt><code>status:r</code></dt>
<dd>Matches all messages from a known bot (FFZ, BTTV or the
<code>botNames</code> setting).</dd>
<dt><code>cat:vip</code></dt>
<dd>Matches all messages from users in the <code>vip</code> Addressbook
category.</dd>
<dt><code>chan:#tailsgaming start:!points</code></dt>
<dd>Matches all messages in channel <code>#tailsgaming</code>, starting
with <code>!points</code>.</dd>
<dt><code>re*:(?i)(?&lt;!practice |debug )\bROM\b(?! hack)</code></dt>
<dd>Matches all messages containing the word <code>ROM</code>, not
preceded by <code>practice&nbsp;</code> or <code>debug&nbsp;</code>, nor
followed by <code>&nbsp;hack</code> (case-insensitive).</dd>
</dl>
<div class="moreInfo">More examples: <a href="#Highlight_Examples">Highlight settings help</a></div>
<h2>
<a name="Usercolors">Usercolors</a>
<a href="#top" class="top">[back to menu]</a>
@ -605,7 +672,7 @@
match the message. The following two types of prefixes can be used to change
highlighting behaviour per item.</p>
<h3>Text Matching Prefixes</h3>
<h3><a name="Highlight_Matching">Text Matching Prefixes</a></h3>
<p>By default, matching is done case-insensitive and when the word or phrase
appears anywhere in the message. However, you can add the following
prefixes in front of the text to change this matching behaviour. You can
@ -713,7 +780,7 @@
</ul></li>
</ul>
<h3>Examples</h3>
<h3><a name="Highlight_Examples">Examples</a></h3>
<dl>
<dt><code>word1 word2</code></dt>
<dd>Matches e.g. <code>word1 word2</code>, <code>Word1 word2</code> anywhere in the message</dd>
@ -886,7 +953,7 @@
<p><img src="Notifications_example.jpg" /></p>
<p>Possible event types that can be selected for an entry:</p>
<p>Possible <strong>event types</strong> that can be selected for an entry:</p>
<dl class="dl-settings">
<dt>Stream Status</dt>
@ -919,7 +986,7 @@
<dd>When a new chat message filtered by AutoMod is received.</dd>
</dl>
<h3>Settings for an entry (Notification/Sound)</h3>
<h3>Event settings (Notification/Sound)</h3>
<dl class="dl-settings">
<dt>Channel</dt>
<dd>Name of the channel this item should be restricted to.</dd>
@ -973,6 +1040,23 @@
<h3>General Notification Settings</h3>
<p>There are different types of Notifications:</p>
<dl class="dl-settings">
<dt>Chatty Notifications</dt>
<dd>The default popup Notification created by Chatty, with additional
settings (see below).</dd>
<dt>Tray Notifications (OS dependant)</dt>
<dd>Native Tray Notifications, which will act differently depending on
what OS you are on.</dd>
<dt>Run OS Command</dt>
<dd>Execute a program on your system, for example to run native
notifications in Linux. <em>For advanced users only, read the help
in the "Edit system command" dialog.</em></dd>
</dl>
<p>If you have selected <strong>Chatty Notifications</strong>:</p>
<dl class="dl-settings">
<dt>Position</dt>
<dd>The corner of the screen the notification is displayed.</dd>
@ -1120,6 +1204,11 @@
<dt>Mod Actions</dt>
<dd>Logs the commands performed by mods in your channel (Broadcaster/Mods only).</dd>
<dd><code>MOD_ACTION: tduva (host coollertmb)</code></dd>
<dt>Ignored Msg.</dt>
<dd>Logs messages that have been hidden by the Ignore list, like normal
messages. You can disable this if you don't want ignored messages to
show up in the chat log files.</dd>
</dl>
<h2>
@ -1436,7 +1525,7 @@
</ul>
<h2>
<a name="Completion">Completion</a>
<a name="TAB_Completion">TAB Completion</a><a name="Completion"></a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>TAB Completion allows you to write the beginning characters
@ -1464,6 +1553,7 @@
<ul>
<li>Prefixing <code>@</code> always completes usernames</li>
<li>Prefixing <code>/</code> always completes command names</li>
<li>Prefixing <code>:</code> always completes Emoji codes (not Twitch Emotes!)</li>
<li>Prefixing <code>.</code> always performs Custom Completion</li>
<li>Certain commands such as <code>/ban</code> always complete usernames</li>
</ul>
@ -1545,7 +1635,7 @@
</dl>
<h3><a name="Completion-custom">Custom Completion Items</a></h3>
<h3><a name="TAB_Completion-custom">Custom Completion Items</a><a name="Completion-custom"></a></h3>
<p>Custom Completion allows you to add your own keyword/value pairs for
completion. Custom Completion can always be performed by prepending the

133
help/help.html
View File

@ -5,14 +5,14 @@
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
<h1><a name="top">Chatty (Version: 0.8.7)</a></h1>
<h1><a name="top">Chatty (Version: 0.9)</a></h1>
<table>
<tr>
<td valign="top">
<strong>General usage</strong>
<ul class="menu">
<li><a href="#title">Title and Tabs</a></li>
<li><a href="#shortcuts">Shortcuts</a></li>
<li><a href="#shortcuts">Hotkeys</a></li>
<li><a href="#commands">Commands</a></li>
<li><a href="#login">Twitch Login</a></li>
</ul>
@ -27,10 +27,10 @@
<strong>Chat moderation / utility</strong>
<ul class="menu">
<li><a href="#nickCompletion">TAB Completion</a></li>
<li><a href="#TAB_Completion">TAB Completion</a></li>
<li><a href="#inputHistory">Input History</a></li>
<li><a href="#userselection">User Selection Mode</a></li>
<li><a href="#emoticons">Emoticons/Emote Dialog</a></li>
<li><a href="#emoticons">Emoticons / Emote Dialog</a></li>
<li><a href="#pausechat">Pause Chat / One-click moderation</a></li>
<li><a href="#automod">AutoMod</a></li>
</ul>
@ -73,8 +73,8 @@
<li><a href="help-releases.html">Release Information</a></li>
<li><a href="help-troubleshooting.html">Troubleshooting</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#thanks">Miscellaneous/Thanks</a></li>
<li><a href="#about">About/License</a></li>
<li><a href="help-about.html#thanks">Miscellaneous / Thanks</a></li>
<li><a href="help-about.html">About / License</a></li>
<li><a href="#ignoreJoinsParts">Ignore joins/parts</a></li>
<li><a href="help-memory_usage.html">About Memory Usage</a></li>
<li><a href="#custom-processes">Run Custom Processes</a></li>
@ -124,21 +124,21 @@
also heavily cached).</p>
<h2>
<a name="shortcuts">Shortcuts</a>
<a name="shortcuts">Hotkeys</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p><em>You can customize most of these shortcuts in the settings, and also
add shortcuts for some functions not listed here.</em></p>
<p>Default shortcuts which can't be changed:</p>
<p><em>You can customize most of these hotkeys in the settings, and also
add hotkeys for some functions not listed here.</em></p>
<p>Default hotkeys which can't be changed:</p>
<ul>
<li><kbd>F1</kbd> - Open help</li>
<li><kbd>PageUp/PageDown</kbd> - Scroll up or down in chat</li>
<li><kbd>Arrow Up/Down</kbd> - Go through <a href="#inputHistory">Input History</a></li>
<li><kbd>TAB</kbd> - For <a href="#nickCompletion">TAB Completion</a></li>
<li><kbd>TAB</kbd> - For <a href="#TAB_Completion">TAB Completion</a></li>
</ul>
<p>The following are more default shortcuts, however these can be changed
<p>The following are more default hotkeys, however these can be changed
in the settings:</p>
<ul>
<li><kbd>F1</kbd> - Open help</li>
<li><kbd>Ctrl-F</kbd> - Find text in chat</li>
<li><kbd>Ctrl-L</kbd> - Open Live Channels window</li>
<li><kbd>Ctrl-J</kbd> - Open dialog to join channel</li>
@ -174,7 +174,8 @@
<code>/slow</code>, <code>/slowoff</code>,
<code>/subscribers</code>, <code>/subscribersoff</code>,
<code>/clear</code>, <code>/mods</code>, <code>/host</code>,
<code>/unhost</code>, <code>/color</code>
<code>/unhost</code>, <code>/raid</code>, <code>/unraid</code>,
<code>/color</code>
just like in normal Twitch Chat</li>
<li><code>/join &lt;channel&gt;</code> - Joins the given channel</li>
<li><code>/part</code> or <code>/close</code> - Leaves the current channel</li>
@ -526,21 +527,26 @@
seriously.</p>
<h2>
<a name="nickCompletion">TAB Completion</a>
<a name="TAB_Completion">TAB Completion</a><a name="nickCompletion"></a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>When you type in the inputbox, you can TAB-complete different types of
things, by using either <kbd>TAB</kbd> or <kbd>Shift-TAB</kbd> to
initiate Completion, which complete different types depending on the
<a href="help-settings.html#Completion">Completion settings</a>.</p>
<p>Some prefixes automatically switch to a certain type of completion
independant of whether you use <kbd>TAB</kbd> or <kbd>Shift-TAB</kbd>:</p>
<p>When typing in the inputbox, you can use the following keys by default
(this can be changed in the <a href="help-settings.html#Completion">Completion settings</a>):</p>
<ul>
<li><kbd>TAB</kbd> to complete usernames</li>
<li><kbd>Shift-TAB</kbd> to complete Emoticons</li>
</ul>
<p>Once a completion is initiated, <kbd>TAB</kbd> and <kbd>Shift-TAB</kbd>
cycle forwards and backward through the results.</p>
<p>Some prefixes always force a certain completion type
no matter if you use <kbd>TAB</kbd> or <kbd>Shift-TAB</kbd>:</p>
<ul>
<li>Prefixing <code>@</code> completes usernames</li>
<li>Prefixing <code>/</code> completes command names</li>
<li>Prefixing <code>.</code> performs <a href="help-settings.html#Completion-custom">Custom completion</a></li>
<li>Prefixing <code>:</code> completes Emoji codes (not Twitch Emotes!)</li>
<li>Prefixing <code>.</code> performs <a href="help-settings.html#TAB_Completion-custom">Custom completion</a></li>
<li>Certain commands such as <code>/ban</code> complete usernames for
their first parameter</li>
<li>Setting commands such as <code>/set</code> complete setting names
@ -733,7 +739,7 @@
<div class="moreInfo">More information: <a href="help-settings.html#Usercolors">Usercolor Settings</a></div>
<h2>
<a name="emoticons">Emoticons/Emote Dialog</a>
<a name="emoticons">Emoticons / Emote Dialog</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>Chatty supports the following types of emoticons:</p>
@ -761,8 +767,15 @@
<li><strong>Not supported</strong> are Personal Emotes</li>
</ul>
</li>
<li>Emoji, turns the Unicode Emoji character into an image (you can
enter Emoji either by pasting the character directly, or by entering
a shortcode (e.g. <code>:thinking:</code>) into the inputbox, which
will be turned into the character when you press Enter to send it.</li>
</ul>
<p><em>Tip:</em> You can use <a href="#TAB_Completion">TAB Completion</a>
for Emoticon codes (Shift-TAB by default) and Emoji shortcodes.</p>
<p>You can enable/disable Emoticons in general (displaying the images instead
of the text) in the settings under <code>Emoticons</code>. You can also
ignore specific emotes in the same place in the settings.</p>
@ -1416,6 +1429,11 @@ MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287</pre
different setting files on the same computer.
<a href="help-guide_folders.html">More information..</a></dd>
<dt><code>-d &lt;dir&gt;</code></dt>
<dd>Same as <code>-cd</code>, except that you directly specify the
settings directory to use. The specified directory has to already
exist.</dd>
<dt><code>-set:&lt;settingName&gt; &lt;setting value&gt;</code></dt>
<dd>Change any setting that can be edited via the <code>/set</code>
command (see <a href="help-setting_commands.html">Setting Commands</a>).</dd>
@ -1477,81 +1495,18 @@ MiniK http://static-cdn.jtvnw.net/emoticons/v1/25/1.0 set:793 id:3287</pre
<li>Twitch Account: <a href="http://twitch.tv/tduva">tduva</a></li>
<li>Twitch Chat: Channel <a href="http://www.twitch.tv/chattyclient/chat?popout=">#chattyclient</a> (Highlight "tduva" to get my attention if I'm there)</li>
<li>Twitter: <a href="https://twitter.com/ChattyClient">@ChattyClient</a></li>
<li><a href="https://discord.gg/WTuqGeJ">Discord</a></li>
</ul>
<p>If you are referring to a specific version of Chatty, please provide the
actual version number, which you can find on the top of the main help page in Chatty
(this one if you are reading this in Chatty, otherwise go to Chatty and open
<code>Help - About/Help</code> or press <kbd>F1</kbd>).</p>
<h2>
<a name="thanks">Miscellaneous/Thanks</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>Some of the resources that were helpful in the development of this program:</p>
<ul>
<li>Thanks to <a href="http://java-sl.com">java-sl.com</a> for some nice articles.</li>
<li>Thanks to <a href="http://twitchemotes.com">Twitchemotes.com</a> for
their <a href="http://twitchemotes.com/api/sets">Emoteset API endpoint</a>.</li>
<li>Thanks to <a href="https://frankerfacez.com">FrankerFaceZ</a> for
their Emotes/APIs and support</li>
<li>Thanks to <a href="http://www.nightdev.com">Nightdev</a> for allowing the use
of the <a href="http://www.nightdev.com/betterttv/">BetterTTV</a> emotes.</li>
</ul>
<h2>
<a name="about">About/License</a>
<a href="#top" class="top">[back to menu]</a>
</h2>
<p>Chatty is using a few libraries/resources made freely available by others:</p>
<ul>
<li>Using <a href="https://code.google.com/p/json-simple/">JSON-Simple</a>, which is licensed under
the <a href="http://www.apache.org/licenses/LICENSE-2.0">"Apache License 2.0"</a>.</li>
<li>Versions with Windows Global Hotkey support use <a href="https://code.google.com/p/jintellitype/">JIntellitype</a>,
which is licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">"Apache License 2.0"</a>.</li>
<li>Using the <a href="https://tyrus.java.net">Tyrus</a> standalone websocket client library licensed under
<a href="https://tyrus.java.net/license.html">CDDL 1.1 and GPL 2 with CPE</a>.</li>
<li><a href="https://www.iconfinder.com/icons/17999/bookmark_favorite_star_icon">Favorite Icon</a>
(Star Icon) by Everaldo Coelho under <a href="http://www.gnu.org/licenses/lgpl.html">LGPL</a>.</li>
<li>Several Icons from the <a href="http://tango.freedesktop.org/Tango_Icon_Library">Tango Icon Theme</a>
(Public Domain).</li>
<li>Edit Icon (Pencil Image), Ok Icon (Green Arrow), Invalid Icon (Cross) from <a href="http://www.icon-king.com/projects/nuvola/">NUVOLA ICON THEME</a> for KDE 3.x by David Vignoni
under <a href="http://www.gnu.org/licenses/lgpl.html">LGPL</a>.</li>
<li>Robot Icon by <a href="http://p.yusukekamiyamane.com">Yusuke Kamiyamane</a> under <a href="http://creativecommons.org/licenses/by/3.0/">CC-BY 3.0</a>.</li>
<li>Emoji:
<ul>
<li>Emoji info (description, category) based on <a href="https://github.com/Ranks/emojione/blob/master/emoji.json">emoji.json by EmojiOne</a>
under the <a href="https://opensource.org/licenses/MIT">MIT License</a></li>
<li><a href="http://emojione.com/">EmojiOne</a> images licensed under
<a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International</a></li>
<li><a href="https://github.com/twitter/twemoji">Twitter Emoji (Twemoji)</a> images licensed under
<a href="https://creativecommons.org/licenses/by/4.0/">CC-BY 4.0</a></li>
</ul>
</li>
</ul>
<p>This application (except for the parts mentioned in the previous paragraph)
is released under the MIT License.</p>
<pre>
Copyright (c) 2014 tduva
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.</pre>
<p><em>Moved to <a href="help-about.html">About page</a>.</em></p>
</body>
</html>

2
version.txt
View File

@ -1 +1 @@
0.8.7 Communities update, Bugfixes, and much more..
0.9 Added Dark Themes, Performance Improvements, Bugfixes, and more..