Skip to content

Quick Start

Edison Hua edited this page May 5, 2025 · 25 revisions

Method #1 - Get latest version from repository

  1. Download TextRender.ahk.
  2. In the same directory, create a new script copied from below.

folder

#include TextRender.ahk
tr := TextRender("hello world!", "color: Aquamarine")

screenshot 2022-06-05 22꞉22꞉24

  1. You should see 'hello world!' displayed in the center of your primary screen.

Method #2 - Stable Release

  1. Download the latest stable release from here.

TextRender Tutorial

Create an instance of the TextRender class.

tr := TextRender()

Use Render() to draw on screen.

tr := TextRender()
tr.Render("Hi! It's nice to meet you", "color: random")

For multiple layers of text use successive calls of Draw() followed by Render().

tr := TextRender()
tr.Draw("Hey, I just met you", "x: top c: random", "s: 10vmin")
tr.Draw("And this is crazy", "x: bottom c: random", "s: 10vmin")
tr.Render()

The first parameter of Draw/Render is a string. The second parameter can be a string or an object and is the background style. The third parameter can be a string or an object and is the text styles.

To keep everything simple pass everything to the constructor for a simple one-liner.

tr := TextRender("But here's my number", "y: 83% c: random", "s: 10vmin")

A temporary instance is created when the time is in the styles parameter and is not assigned to a variable.

; After 3 seconds, this will disappear.
TextRender("So call me, maybe", "time: 3000 color: MintCream", "s: 10vmin")

If a variable is assigned, the window will still be destroyed after 3 seconds, but the object can be reused.

tr := TextRender("It's hard to look right at you, baby", "time: 3000 color: MintCream", "s: 10vmin")
Sleep 5000 ; after 3 seconds this it should be gone
tr.Render("But here's my number, so call me maybe") ; Reuse object!

TextRender(Text, BackgroundStyle, TextStyle)

TextRenderDesktop(Text, BackgroundStyle, TextStyle) - Draw in front of desktop icons.

TextRenderWallpaper(Text, BackgroundStyle, TextStyle) - Draw behind desktop icons. Cannot be clicked. Windows 10 and above.

  • Text - String.
  • BackgroundStyle - Object or String. See Background Styles for details.
  • TextStyle - Object or String. See Text Styles for details.