att-circuits v1.0.0

Allows you to create logic gate circuits in A Township Tale, letting you create custom puzzles and logic contraptions.

⚠️ This library has a peer dependency on att-string-transcoder. You must manually install this peer dependency in your project in order to use att-circuits.

⚠️ This library is meant for advanced users who already have a good understanding of ATT save strings. Check out our ATT String Workshop project to learn the basics.

:sparkles: Quickstart

Installation

Add this library to your project's dependencies:

npm install --save att-circuits

Usage

import { Circuit } from 'att-circuits';
import { Prefab } from 'att-string-transcoder';

const lever = Prefab.fromSaveString<'MRK_Small_Lever'>('...');
const door = Prefab.fromSaveString<'MRK_gate_02'>('...');
const circuit = new Circuit();

circuit.createWire('boolean').connect(lever, door);
circuit.setOrigin(door);

const prefab = circuit.toPrefab();
prefab.print();

Read the API Reference Documentation for more options.

:bow: Attribution

This project would not be possible without the knowledge revealed and shared by poi. :blue_heart: