Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hugeblank/shatter
Shatter your dull Overlay Glasses experience by turning it into a redirectable terminal target!
https://github.com/hugeblank/shatter
computercraft glasses overlay plethora
Last synced: 4 months ago
JSON representation
Shatter your dull Overlay Glasses experience by turning it into a redirectable terminal target!
- Host: GitHub
- URL: https://github.com/hugeblank/shatter
- Owner: hugeblank
- License: wtfpl
- Created: 2018-07-27T07:18:41.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-22T05:21:39.000Z (about 1 year ago)
- Last Synced: 2024-10-03T11:26:19.359Z (4 months ago)
- Topics: computercraft, glasses, overlay, plethora
- Language: Lua
- Size: 63.5 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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](./examples) directory for demonstrations on how to use shatter.