Skip to content

Core TypeScript library for writing Endless Online applications

License

Notifications You must be signed in to change notification settings

Cirras/eolib-ts

Repository files navigation

EOLib

Quality Gate Status Format Build Release

A core TypeScript library for writing applications related to Endless Online.

Installation

Install eolib using npm:

npm install --save eolib

Or yarn:

yarn add eolib

Features

Read and write the following EO data structures:

  • Client packets
  • Server packets
  • Endless Map Files (EMF)
  • Endless Item Files (EIF)
  • Endless NPC Files (ENF)
  • Endless Spell Files (ESF)
  • Endless Class Files (ECF)

Utilities:

  • Data reader
  • Data writer
  • Number encoding
  • String encoding
  • Data encryption
  • Packet sequencer

Requirements

Node.js is required to install dependencies and run scripts via npm.

Available Commands

Command Description
npm install Install project dependencies
npm run format Format changed files using Prettier
npm run generate Generate code based on eo-protocol
npm run build Build cjs and esm with production settings
npm run build:cjs Build cjs with production settings
npm run build:esm Build esm with production settings
npm test Run unit tests
npm run test:coverage Run unit tests with coverage