Shatter

Shatter your dull Overlay Glasses experience by turning it into a redirectable terminal target!

Shatter adds several features to the overlay glasses experience beyond a terminal. It is meant to be used in a neural interface (obviously) with an unbound wireless keyboard.

Brief Rundown

API

• Parameters
  • table: canvas object provided by the overlay glasses
• Returns
  • table: terminal object
  • function: cursor handler function to be put in parallel with your code

Terminal Object

Alpha Manipulation

getTextAlpha: get the alpha value for the text

• Parameters
  • none
• Returns
  • number: alpha value, in range 0-1

getBackgroundAlpha: get the alpha value for the background

• Parameters
  • none
• Returns
  • number: alpha value, in range 0-1

setTextAlpha: set the alpha value for the text

• Parameters
  • number: alpha value within range 0-1
• Returns
  • none

setBackgroundAlpha: set the alpha value for the background

• Parameters
  • number: alpha value within range 0-1
• Returns
  • none

Custom Color Manipulation

setTextHex: set the text color using a color code in the format 0xrrggbbaa

• Parameters
  • number: hex code for color value
• Returns
  • none

setBackgroundHex: set the background color using a hex color code in the format 0xrrggbbaa

• Parameters
  • number: hex code for color value
• Returns
  • none

getTextHex: gets the text color returned in the format 0xrrggbbaa

• Parameters
  • none
• Returns
  • number: hex code for color value

getBackgroundHex: gets the background color returned in the format 0xrrggbbaa

• Parameters
  • none
• Returns
  • number: hex code for color value

Scaling

setScale: set the text and background pixel scale

• Parameters
  • number: scale value within range 0.5-10
• Returns
  • none

Events

shatter_resize: fired when the shatter terminal object is resized

Getting Started

Let's set up all elements of shatter! Obviously you're here for this part so I'll make it as brief as possible.

1. run wget https://raw.githubusercontent.com/hugeblank/Shatter/master/shatter.lua on your neural interface that has overlay glasses.
2. Find an unbound wireless keyboard, this functions as both a keyboard & mouse, keep that in mind.
3. Check out the examples directory for demonstrations on how to use shatter.