README.md

# cthulhu

[![Package Version](https://img.shields.io/hexpm/v/cthulhu)](https://hex.pm/packages/cthulhu)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/cthulhu/)

A Terraria player editor written in Gleam

```sh
gleam add cthulhu@1
```
```gleam
import cthulhu
import simplifile

pub fn main() -> Nil {
  let assert Ok(encrypted_player) = simplifile.read_bits(test_player_path)
  let assert Ok(raw_player) = cthulhu.decrypt(encrypted_player)
  let assert Ok(player) = cthulhu.decode_player(raw_player)
  echo player
}
```

Further documentation can be found at <https://hexdocs.pm/cthulhu>.

## Development

```sh
gleam run   # Run the project
gleam test  # Run the tests (requires a player file named test.plr)
```