Nearsighted Prank Master
Learn how companies like Phone2Action are using npm in their front-end developmentJoin the conversation »

7daystodie-api-wrapper

1.4.1 • Public • Published

Build Status Coverage Status Docs NPM Snyk Vulnerabilities for npm package node

7 Days to die API wrapper

A simple wrapper around the web API from Alloc's fixes mod.

## Requirements

  • A 7 Days to Die server running Alloc's Fixes

The port required for this module is the same as the dynamic map page. For more info, see the documentation of the mod itself https://7dtd.illy.bz/wiki/Ports

## Example usage

Install with npm npm i 7daystodie-api-wrapper --only=prod

const SdtdApi = require('7daystodie-api-wrapper');
 
const sdtdServer = {
   ip: "192.168.1.100",
   port: "8082",
   adminUser: "admin",
   adminToken: "secret"
}
 
foo();
 
async function foo() {
   let stats = await SdtdApi.getStats(sdtdServer);
   console.log(`The current ingame time is ${stats.gametime.days} days, ${stats.gametime.hours} hours and ${stats.gametime.minutes} minutes.`)
}

## Running tests

To run tests, you must have a working 7 Days to die server with allocs fixes installed. You must also have at least one player profile saved on the server (logging in once will do this).

Fill in the server connection info in a .env file (see example file) and then run npm test

Install

npm i 7daystodie-api-wrapper

DownloadsWeekly Downloads

34

Version

1.4.1

License

GPL-3.0

Unpacked Size

288 kB

Total Files

78

Last publish

Collaborators

  • avatar