https://github.com/korczoczek/hexcastingCC_viewPattern

Displays hexcasting patterns using CC
https://github.com/korczoczek/hexcastingCC_viewPattern

computercraft computercraft-tweaked hexcasting

Last synced: 3 months ago
JSON representation

Displays hexcasting patterns using CC

• Host: GitHub
• URL: https://github.com/korczoczek/hexcastingCC_viewPattern
• Owner: korczoczek
• License: mit
• Created: 2024-02-24T19:04:18.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-10-15T20:35:37.000Z (3 months ago)
• Last Synced: 2024-10-17T07:11:43.550Z (3 months ago)
• Topics: computercraft, computercraft-tweaked, hexcasting
• Language: Lua
• Homepage:
• Size: 395 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# hexcastingCC_viewPattern

Allows for inspecting iotas stored inside focuses without having to use tools outside the game.

## Features

Ability to read and display iotas imbued with:

 - Patterns

 - Pattern Lists

 - Vectors

 - Numbers

 - Entities

 - MoreIotas:

   - Matrixes

   - Strings

Located inside:

 - Slates

 - Focuses (Using a Focal Port)

 - Akashic Bookshelves

## Requirements

 - [Computercraft](https://modrinth.com/mod/cc-tweaked)

 - [Tom's Peripherals](https://modrinth.com/mod/toms-peripherals) (GPU, Monitor)

 - [Ducky Peripherals](https://modrinth.com/mod/ducky-periphs) (Focal Port, various hexcasting APIs)

## Setup

By default the script will attempt to read from the block above and display using the GPU placed below (see picture below), to change this behaviour by editing the `hex_location` and `gpu_location` variables found in the beggining of the script.

Recommended monitor size is 3x3 blocks, but the script will attempt to scale to any monitor size

![Screenshot of the recommended script setup, the focal port is above the computer with the GPU below and a 3x3 monitor with its bottom left corner adjacent to the GPU](/images/setup.png)

## Installation

Download the script file

```

wget https://raw.githubusercontent.com/korczoczek/hexcastingCC_viewPattern/main/viewPattern.lua

```

**(Optional)** Download the pattern list file, which will enable the script to display names of input patterns

```

wget https://raw.githubusercontent.com/korczoczek/hexcastingCC_viewPattern/main/patternList.lua

```

## Customization

Several variables located at the script's beginning allow for customization of script behaviour

```

hex_location - location of iota to be read

gpu_location - location of the GPU

background - background color

patternListLoc - location of the patternList.lua file

```

## Known Issues

 - when physically changing monitor size it's nessesary for the script to be run twice before the change is refreshed internally

 - crash when the pattern to be displayed is just too damn big

## TODO

 - add missing pattern names

 - add ability to display more iota types