JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 27
  • Score
    100M100P100Q41059F
  • License MIT

JS interface for Hell Let Loose Community RCON tool.

Package Exports

  • crcon.js
  • crcon.js/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (crcon.js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

CRCON JavaScript API Module

This repository contains a JavaScript module for interacting with the Hell Let Loose Community RCON tool (CRCON) API. The module provides a comprehensive and fully functional interface for all CRCON API endpoints, enabling developers to build their own web interfaces, bots, and other applications using technologies such as NodeJS.

Features

  • Comprehensive API Coverage: All endpoints of the CRCON API are included, allowing for full interaction with the Hell Let Loose server.
  • Easy Integration: Designed to be easily integrated into your JavaScript projects, making it simple to build web interfaces, bots, and other applications.
  • Promise-Based: Utilizes JavaScript promises for asynchronous operations, ensuring a smooth and efficient user experience.
  • Token Authentication: Supports bearer token authentication for secure API calls.

Important Notice

This library is mostly untested and is written based on the information provided by the CRCON API get_api_documentation endpoint. Users are encouraged to test the library thoroughly in their own environments and report any issues they encounter.

Getting Started

Usage

First, import the API class and initialize it with your CRCON API base URL:

const API = require('./path-to-api-class'); // Adjust the path as necessary

const config = {
  token: 'your-api-token-here'
};

const api = new API('https://your-api-url.com', config);

Example

// Assuming the API class has been properly imported and initialized

const api = new API('https://your-api-url.com');

// Example: Get the list of all players
api.getPlayers()
  .then(data => {
    console.log('List of players:', data);
  })
  .catch(error => {
    console.error('Error fetching players:', error);
  });

Contributing

We welcome contributions to improve this module. If you find any issues or have suggestions for new features, please open an issue or submit a pull request.

Donations

If you find this library useful and would like to support its development, please consider donating to the addresses listed on my profile:

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

This module is a JavaScript port of the Hell Let Loose Community RCON tool (CRCON) API. Special thanks to the Hell Let Loose community for their continued support and development of CRCON.

Documentation

Read the API Documentation