search

thomas-crane / nrelay

A console based modular client for Realm of the Mad God built with Node.js and TypeScript.
https://nrelay.net/
MIT License
40 stars 21 forks source link

No online docs #51

Open xElfenlied opened 4 years ago

xElfenlied commented 4 years ago

docs.nrelay.net seems to be offline.. and "The code in the src/ folder has extensive inline documentation..." with only 1 example... where can i check what the tool is able to... (enter portals/ move/ pick up stuff/etc...)

thomas-crane commented 4 years ago

Hi @xElfenlied,

As I was not actively working on nrelay for some time, I didn't bother to renew the nrelay.net domain and it has since expired. The docs are still hosted on Firebase and you can access them from either https://nrelay-docs.web.app/ or https://nrelay-docs.firebaseapp.com/

When I say "inline documentation", I am referring to the JSDoc comments. It is these comments which are extracted by the TypeDoc tool and turned into the documentation website. If you are interested in finding some examples of what is possible with nrelay, it might be better to look in the docs folder of the main repo. There you will find some example plugins, and some docs about how to use other parts of nrelay.

I will leave this issue open until I have updated the links to the documentation to point to the right domain.