Release 0.6.0 !

Former-commit-id: 439b0cb

README.md

@@ -11,7 +11,7 @@ What does this look like? A little something like this...
 
 Or perhaps like this...
 
-![Animated preview](images/preview.gif)
+![Animated preview](https://i.imgur.com/c2BIAno.gif)
 
 ## It's got labels!
 
@@ -30,7 +30,7 @@ between two colors, or go across a whole rainbow. Lots of options; lots of fun.
 typing-label, but there have been some changes. You can check [the TextraTypist wiki](https://github.com/tommyettinger/textratypist/wiki/Examples)
 for more information.
 
-As of 0.5.5, there are many new effects. Jolt, Spiral, Spin, Crowd, Shrink, Emerge, Heartbeat, Carousel, Squash, Scale,
+As of 0.6.0, there are many new effects. Jolt, Spiral, Spin, Crowd, Shrink, Emerge, Heartbeat, Carousel, Squash, Scale,
 and Rotate are all new to TextraTypist (not in typing-label). You can see usage instructions and sample GIFs at
 [the TextraTypist wiki's Tokens page](https://github.com/tommyettinger/textratypist/wiki/Tokens). Most of these effects
 make use of the smooth scaling and rotation options that effects can use starting in TextraTypist 0.5.1 .
@@ -70,6 +70,10 @@ square brackets like `[*]`, or you can use `{STYLE=BOLD}` to do the same thing.
     `{COLOR=Lighter Orange-Red}` (which would need that color to be defined).
     - One way colors such as `Lighter Orange-Red` can be defined is done in [SquidSquad](https://github.com/yellowstonegames/SquidSquad),
       which defines its own `ColorLookup`.
+- `[+region name]`, where region name is the name of a TextureRegion from a registered TextureAtlas, won't change the 
+  style, but will produce that TextureRegion in-line with the text.
+  - This is commonly used with `KnownFonts.addEmoji()` to add the 3000+ Twemoji icons to a Font.
+    - If you use Twemoji, the phrasees `[+saxophone]` and `[+🎷]` will each show a saxophone icon.
 
 ## But wait, there's fonts!
 
@@ -92,6 +96,9 @@ between any of those 13 fonts using the `[@Medieval]` syntax (where Medieval is
 for "KingThings Foundation"). All of these fonts work without a distance field effect, so they won't look as good at
 very large sizes, but are compatible with each other.
 
+The Twemoji icons are also present in an atlas of over-3000 32x32 images; `KnownFonts.addEmoji()` can register them with
+a Font so the `[+name]` syntax mentioned above can draw emoji inline.
+
 The license files for each font are included in the same folder, in `knownFonts` here. All fonts provided here were
 checked to ensure their licenses permit commercial use without fees, and all do. Most require attribution; check the
 licenses for details.
@@ -132,7 +139,7 @@ for some usage. A counterpart to `TextArea` is planned.
 You probably want to get this with Gradle! The dependency for a libGDX project's core module looks like:
 
 ```groovy
-implementation "com.github.tommyettinger:textratypist:0.5.5"
+implementation "com.github.tommyettinger:textratypist:0.6.0"
 ```
 
 This assumes you already depend on libGDX; TextraTypist depends on version 1.11.0 or higher. The requirement for 1.11.0
@@ -141,7 +148,7 @@ was added in TextraTypist 0.5.0 because of some breaking changes in tooltip code
 If you use GWT, this should be compatible. It needs these dependencies in the html module:
 
 ```groovy
-implementation "com.github.tommyettinger:textratypist:0.5.5:sources"
+implementation "com.github.tommyettinger:textratypist:0.6.0:sources"
 implementation "com.github.tommyettinger:regexodus:0.1.13:sources"
 ```
 
@@ -167,6 +174,9 @@ as-is, this Apache-licensed project is fully compliant with MIT. The full MIT li
 also present in all library source files here. The Apache license does not typically apply to non-code resources in the
 `src/test/resources` folder; individual fonts have their own licenses stored in that directory.
 
+Twemoji isn't a font, so it might be best to mention it separately. It's licensed under CC-BY 4.0, and requires
+attribution to Twitter if used.
+
 The logo was made by Raymond "raeleus" Buckley and contributed to this project. It can be used freely for any purpose,
 but I request that it only be used to refer to this project unless substantially modified.
 

build.gradle

@@ -20,7 +20,7 @@ def projectName = 'textratypist'
 version "$VERSION_NAME"
 group 'com.github.tommyettinger'
 
-//api "com.github.tommyettinger:textratypist:0.5.5"
+//api "com.github.tommyettinger:textratypist:0.6.0"
 
 [compileJava, compileTestJava, javadoc]*.options*.encoding = 'UTF-8'
 

docs/apidocs/allclasses-frame.html

@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>All Classes (textratypist 0.5.5 API)</title>
+<title>All Classes (textratypist 0.6.0 API)</title>
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

docs/apidocs/allclasses-noframe.html

@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>All Classes (textratypist 0.5.5 API)</title>
+<title>All Classes (textratypist 0.6.0 API)</title>
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

docs/apidocs/com/github/tommyettinger/textra/ColorLookup.GdxColorLookup.html

@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>ColorLookup.GdxColorLookup (textratypist 0.5.5 API)</title>
+<title>ColorLookup.GdxColorLookup (textratypist 0.6.0 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="ColorLookup.GdxColorLookup (textratypist 0.5.5 API)";
+            parent.document.title="ColorLookup.GdxColorLookup (textratypist 0.6.0 API)";
         }
     }
     catch(err) {

docs/apidocs/com/github/tommyettinger/textra/ColorLookup.html

@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>ColorLookup (textratypist 0.5.5 API)</title>
+<title>ColorLookup (textratypist 0.6.0 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="ColorLookup (textratypist 0.5.5 API)";
+            parent.document.title="ColorLookup (textratypist 0.6.0 API)";
         }
     }
     catch(err) {

docs/apidocs/com/github/tommyettinger/textra/Effect.html

@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>Effect (textratypist 0.5.5 API)</title>
+<title>Effect (textratypist 0.6.0 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Effect (textratypist 0.5.5 API)";
+            parent.document.title="Effect (textratypist 0.6.0 API)";
         }
     }
     catch(err) {

docs/apidocs/com/github/tommyettinger/textra/Font.DistanceFieldType.html

@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>Font.DistanceFieldType (textratypist 0.5.5 API)</title>
+<title>Font.DistanceFieldType (textratypist 0.6.0 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Font.DistanceFieldType (textratypist 0.5.5 API)";
+            parent.document.title="Font.DistanceFieldType (textratypist 0.6.0 API)";
         }
     }
     catch(err) {

docs/apidocs/com/github/tommyettinger/textra/Font.FontFamily.html

@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>Font.FontFamily (textratypist 0.5.5 API)</title>
+<title>Font.FontFamily (textratypist 0.6.0 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Font.FontFamily (textratypist 0.5.5 API)";
+            parent.document.title="Font.FontFamily (textratypist 0.6.0 API)";
         }
     }
     catch(err) {

docs/apidocs/com/github/tommyettinger/textra/Font.GlyphRegion.html

@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>Font.GlyphRegion (textratypist 0.5.5 API)</title>
+<title>Font.GlyphRegion (textratypist 0.6.0 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Font.GlyphRegion (textratypist 0.5.5 API)";
+            parent.document.title="Font.GlyphRegion (textratypist 0.6.0 API)";
         }
     }
     catch(err) {
@@ -178,6 +178,25 @@ <h3>Constructor Summary</h3>
 </td>
 </tr>
 <tr class="rowColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/github/tommyettinger/textra/Font.GlyphRegion.html#GlyphRegion-com.badlogic.gdx.graphics.g2d.TextureAtlas.AtlasRegion-">GlyphRegion</a></span>(com.badlogic.gdx.graphics.g2d.TextureAtlas.AtlasRegion&nbsp;atlasRegion)</code>
+<div class="block">Creates a GlyphRegion from a parent TextureAtlas.AtlasRegion (almost always from an atlas).</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/github/tommyettinger/textra/Font.GlyphRegion.html#GlyphRegion-com.badlogic.gdx.graphics.g2d.TextureRegion-">GlyphRegion</a></span>(com.badlogic.gdx.graphics.g2d.TextureRegion&nbsp;textureRegion)</code>
+<div class="block">Creates a GlyphRegion from a parent TextureRegion (typically from an atlas).</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/github/tommyettinger/textra/Font.GlyphRegion.html#GlyphRegion-com.badlogic.gdx.graphics.g2d.TextureRegion-float-float-float-">GlyphRegion</a></span>(com.badlogic.gdx.graphics.g2d.TextureRegion&nbsp;textureRegion,
+           float&nbsp;offsetX,
+           float&nbsp;offsetY,
+           float&nbsp;xAdvance)</code>
+<div class="block">Creates a GlyphRegion from a parent TextureRegion (typically from an atlas), along with any offsets to use
+ for its x and y coordinates, and the amount of horizontal space to move over when this is drawn.</div>
+</td>
+</tr>
+<tr class="altColor">
 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/github/tommyettinger/textra/Font.GlyphRegion.html#GlyphRegion-com.badlogic.gdx.graphics.g2d.TextureRegion-int-int-int-int-">GlyphRegion</a></span>(com.badlogic.gdx.graphics.g2d.TextureRegion&nbsp;textureRegion,
            int&nbsp;x,
            int&nbsp;y,
@@ -280,6 +299,58 @@ <h4>xAdvance</h4>
 <!--   -->
 </a>
 <h3>Constructor Detail</h3>
+<a name="GlyphRegion-com.badlogic.gdx.graphics.g2d.TextureRegion-">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>GlyphRegion</h4>
+<pre>public&nbsp;GlyphRegion(com.badlogic.gdx.graphics.g2d.TextureRegion&nbsp;textureRegion)</pre>
+<div class="block">Creates a GlyphRegion from a parent TextureRegion (typically from an atlas). The resulting GlyphRegion will
+ have 0 offsetX, 0 offsetY, and xAdvance equal to <code>TextureRegion.getRegionWidth()</code>.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>textureRegion</code> - a TextureRegion to draw for this GlyphRegion, typically from a TextureAtlas</dd>
+</dl>
+</li>
+</ul>
+<a name="GlyphRegion-com.badlogic.gdx.graphics.g2d.TextureAtlas.AtlasRegion-">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>GlyphRegion</h4>
+<pre>public&nbsp;GlyphRegion(com.badlogic.gdx.graphics.g2d.TextureAtlas.AtlasRegion&nbsp;atlasRegion)</pre>
+<div class="block">Creates a GlyphRegion from a parent TextureAtlas.AtlasRegion (almost always from an atlas). The resulting
+ GlyphRegion will have the same offsetX and offsetY as atlasRegion, and xAdvance equal to
+ <code>TextureAtlas.AtlasRegion.originalWidth</code>.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>atlasRegion</code> - a TextureAtlas.AtlasRegion to draw for this GlyphRegion, typically from a TextureAtlas</dd>
+</dl>
+</li>
+</ul>
+<a name="GlyphRegion-com.badlogic.gdx.graphics.g2d.TextureRegion-float-float-float-">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>GlyphRegion</h4>
+<pre>public&nbsp;GlyphRegion(com.badlogic.gdx.graphics.g2d.TextureRegion&nbsp;textureRegion,
+                   float&nbsp;offsetX,
+                   float&nbsp;offsetY,
+                   float&nbsp;xAdvance)</pre>
+<div class="block">Creates a GlyphRegion from a parent TextureRegion (typically from an atlas), along with any offsets to use
+ for its x and y coordinates, and the amount of horizontal space to move over when this is drawn.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>textureRegion</code> - a TextureRegion to draw for this GlyphRegion, typically from a TextureAtlas</dd>
+<dd><code>offsetX</code> - how many pixels to shift over the TextureRegion when drawn; positive is to the right</dd>
+<dd><code>offsetY</code> - how many pixels to shift over the TextureRegion when drawn; positive is upwards</dd>
+<dd><code>xAdvance</code> - how much horizontal space the GlyphRegion should use up when drawn</dd>
+</dl>
+</li>
+</ul>
 <a name="GlyphRegion-com.badlogic.gdx.graphics.g2d.TextureRegion-int-int-int-int-">
 <!--   -->
 </a>