nrelay docs

This website provides documentation for the source code of nrelay. The main nrelay repository has further documentation in the form of guides and tutorials about using nrelay.

This website is generated using the TypeDoc documentation generator. It uses the inline JSDoc comments that are written in the nrelay source. The documentation is divided in to several logically related modules:

• cli
  • The CLI of nrelay and other related classes.
• core
  • The core entities and classes of nrelay, such as the Client.
• crypto
  • Classes used to provide cryptographic algorithm implementations used in RotMG.
• decorators
  • TypeScript decorators used to interact with nrelay.
• models
  • Enums, interfaces and classes which represent object structures and values used by nrelay or RotMG.
• networking
  • Classes and interfaces related to the networking code of nrelay.
  • /data
    • Data packets used by RotMG.
  • /packets/incoming
    • Packets which are sent from the server to the client.
  • /packets/outgoing
    • Packets which are sent from the client to the server.
• services
  • Mostly static classes that provide helpful utility functions used throughout nrelay.
  • /http
    • Classes relating to http functionality.
  • /logging
    • Classes related to the logging mechanism.
  • /pathfinding
    • Classes relating to the A* pathfinder implementation.
• stdlib
  • The nrelay standard library.