dungeons_and_trolls

v1.10.0

Published

a year ago

JS API client generated by OpenAPI Generator

Downloads

0High
0Medium
0Low

malytomas

dungeons_and_trolls

DungeonsAndTrolls - JavaScript client for dungeons_and_trolls No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.10.0
Package version: 1.10.0
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install dungeons_and_trolls --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your dungeons_and_trolls from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var DungeonsAndTrolls = require('dungeons_and_trolls');

var defaultClient = DungeonsAndTrolls.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token"

var api = new DungeonsAndTrolls.DungeonsAndTrollsApi()
var attributes = new DungeonsAndTrolls.DungeonsandtrollsAttributes(); // {DungeonsandtrollsAttributes} 
var opts = {
  'blocking': true // {Boolean} default true
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.dungeonsAndTrollsAssignSkillPoints(attributes, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://dt.garage-trip.cz

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- DungeonsAndTrolls.DungeonsAndTrollsApi | dungeonsAndTrollsAssignSkillPoints | POST /v1/assign-skill-points | Send multiple commands to the Character bound to the logged user. The order of execution is defined in the message. DungeonsAndTrolls.DungeonsAndTrollsApi | dungeonsAndTrollsBuy | POST /v1/buy | Buy Items identified by the provided ID for the Character bound to the logged user. DungeonsAndTrolls.DungeonsAndTrollsApi | dungeonsAndTrollsCommands | POST /v1/commands | Send multiple commands to the Character bound to the logged user. The order of execution is defined in the message. DungeonsAndTrolls.DungeonsAndTrollsApi | dungeonsAndTrollsGame | GET /v1/game | Sends all info about the game. DungeonsAndTrolls.DungeonsAndTrollsApi | dungeonsAndTrollsGameLevel | GET /v1/game/{level} | Sends all info about the game level. DungeonsAndTrolls.DungeonsAndTrollsApi | dungeonsAndTrollsLevels | GET /v1/levels | Sends info about DungeonsAndTrolls.DungeonsAndTrollsApi | dungeonsAndTrollsMonstersCommands | POST /v1/monsters-commands | Control monsters. Admin only. DungeonsAndTrolls.DungeonsAndTrollsApi | dungeonsAndTrollsMove | POST /v1/move | Assign skill point to the attribute for the Character bound to the logged user. DungeonsAndTrolls.DungeonsAndTrollsApi | dungeonsAndTrollsPickUp | POST /v1/pick-up | Equip the Item from the ground identified by the provided ID for the Character bound to the logged user (unused). DungeonsAndTrolls.DungeonsAndTrollsApi | dungeonsAndTrollsPlayers | GET /v1/players | Sends all info about all players. DungeonsAndTrolls.DungeonsAndTrollsApi | dungeonsAndTrollsRegister | POST /v1/register | Register provided User to the Game and create a character. DungeonsAndTrolls.DungeonsAndTrollsApi | dungeonsAndTrollsRespawn | POST /v1/respawn | Respawn the Character bound to the logged user. DungeonsAndTrolls.DungeonsAndTrollsApi | dungeonsAndTrollsSkill | POST /v1/skill | Use a skill (provided by an item) by the Character bound to the logged user. DungeonsAndTrolls.DungeonsAndTrollsApi | dungeonsAndTrollsYell | POST /v1/yell | The Character bound to the logged user yells a messages (visible for everyone).

Documentation for Models

Documentation for Authorization

ApiKeyAuth

Type: API key
API key parameter name: X-API-Key
Location: HTTP header

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

dungeons_and_trolls

Installation

For Node.js

npm

Local development

git

For browser

Webpack Configuration

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

ApiKeyAuth