ATT Liquids
---
Makes it easier to create custom liquids in _A Township Tale_ using save strings.
⚠️ This library has a **peer dependency** on [`att-string-transcoder`](https://github.com/mdingena/att-string-transcoder). You must manually install this peer dependency in your project in order to use `att-liquids`.
## :sparkles: Quickstart
### Installation
Add this library to your project's dependencies:
```shell
npm install --save att-liquids
```
### Usage
```ts
import { Liquid } from 'att-liquids';
const liquid = new Liquid('Potion_Medium');
liquid
.setColor('#2a455800')
.setVisualAppearance('VisionStewCooked')
.addEffect('Feed', 2)
.addEffect('Heal', 10)
.addEffect('Nourish')
.addEffect('SpeedIndirectEffect', 5)
.addVisualChunk('Salt')
.addVisualChunk('BabuCooked')
.addVisualChunk('TomatoCooked')
.setServings(42);
liquid.print();
```
Read the [API Reference Documentation](docs/README.md) for more options.
## :bow: Attribution
This project would not be possible without the knowledge revealed and shared by [poi](https://github.com/officialpoiuytrewq4645). :blue_heart: