aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 51a3569256d971d73219ee5a938eb7175d36a001 (plain)
1
2
3
4
5
6
7
8
9
10
11
# ywot-clean

A reconstructed version of `ywot-bot` built off of clean programming principles and a minimal, but fast API.

# Features

Currently, `socket.js` provides `Socket` which has a few signals and functions (documented in the code, of course) which allow abstracted interfacing with YWOT. However, certain facilities available in the old version like queuing or fetch division were scrapped in favor of more direct limits due to the unmaintainability of the old style.

`space.js` provides some dense spatial data management with `Space`, which is really good for specific dialogs and tests, but there may be some more work to be done to create a sparse storage device.

`examples/helloworld.js` can get you started. Everything in that should work pretty well, but the remainder of the repo is probably pretty buggy until I test it.