xelib

https://github.com/z-edit/xelib

Admin

xelib is a native Node.js addon wrapping XEditLib.dll that provides an API for interfacing with...

Tokens:332

Snippets:5

Trust Score:6.8

License:MIT

Update:1 month ago

Show doc for...

Tokens:

Raw

### Install xelib via npm

Source: https://github.com/z-edit/xelib/blob/master/README.md

Command to install the xelib package from the z-edit repository.

```bash
npm i z-edit/xelib
```

--------------------------------

### Initialize and use xelib API

Source: https://github.com/z-edit/xelib/blob/master/README.md

Example showing how to initialize the library, set the game mode, load plugins, and retrieve element values.

```javascript
const xelib = require('xelib').wrapper;

// INITIALIZATION / SETUP
xelib.Initialize('A:\\path\\to\\XEditLib.dll');
// sets the library to the Skyrim game mode
xelib.SetGameMode(xelib.gmTES5);
// list plugins separated by newlines
xelib.LoadPlugins('Skyrim.esm\nUpdate.esm');
// wait until the loader finishes
let status = 0;
while (status < 2) {
    status = xelib.GetLoaderStatus();
}

// GETTING AN ELEMENT
let armorIronGauntlets = xelib.GetElement(0, 'Skyrim.esm\\00012E46');

// GETTING A VALUE
let fullName = xelib.GetValue(armorIronGauntlets, 'FULL');
```

Tokens:

Raw