@efrei-craft/animus

v1.0.0

Published

3 years ago

Systme_de_gestion_du_serveur_Efrei_Craft

0High
0Medium
0Low

animus

Animus - JavaScript client for animus Système de gestion du serveur Efrei Craft This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0.0
Package version: 1.0.0
Build package: io.swagger.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 animus --save

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

Finally, switch to the directory you want to use your animus from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('animus') in javascript files from the directory you ran the last command above from.

git

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

    npm install YOUR_USERNAME/animus --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, that's to say your javascript file where you actually use this library):

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 Animus = require('animus');

var defaultClient = Animus.ApiClient.instance;

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

var api = new Animus.GamesApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAvailableGames(callback);

Documentation for API Endpoints

All URIs are relative to https://api.rezal.efreicraft.fr

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- Animus.GamesApi | getAvailableGames | GET /games/available-games | Get all available games Animus.GamesApi | getPlayerCount | GET /games/player-count | Get the player count of all games Animus.MiscApi | createAPIKey | POST /misc/api-key | Creates a new API key - temporarily public Animus.MiscApi | hello | GET /misc/hello | Says hello to the API - used for checking if the API is up Animus.PermissionsApi | createGroup | POST /permissions/groups | Creates a permission group Animus.PermissionsApi | deleteGroup | DELETE /permissions/groups/{id} | Deletes a permission group Animus.PermissionsApi | getGroups | GET /permissions/groups | Gets all permission groups Animus.PermissionsApi | updateGroup | PATCH /permissions/groups/{id} | Updates a permission group Animus.PlayersApi | addPlayerPermissionGroup | POST /players/{uuid}/groups | Add a permission group to a player Animus.PlayersApi | addPlayerPermissions | PUT /players/{uuid}/permissions | Add permissions to a player Animus.PlayersApi | changePlayerChannel | PATCH /players/{uuid}/channel | Change a player's chat channel Animus.PlayersApi | changePlayerServer | PATCH /players/{uuid}/server | Change a player's server Animus.PlayersApi | getAllPlayers | GET /players | Get all players Animus.PlayersApi | getOnlinePlayers | GET /players/online | Get a list of online players Animus.PlayersApi | getPlayerInfo | GET /players/{uuid} | Get information about a player Animus.PlayersApi | getPlayerPermissions | GET /players/{uuid}/permissions | Get a player's permissions (also gets the permissions of their permission groups) Animus.PlayersApi | playerConnect | POST /players/{uuid}/connect | A player connects to the server Animus.PlayersApi | playerDisconnect | POST /players/{uuid}/disconnect | A player disconnects from the server Animus.PlayersApi | removePlayerPermissionGroup | DELETE /players/{uuid}/groups | Remove a permission group from a player Animus.PlayersApi | removePlayerPermissions | DELETE /players/{uuid}/permissions | Remove permissions from a player Animus.PlayersApi | setPlayerPermissionGroup | PATCH /players/{uuid}/groups | Set a player's unique permission group (implies a removal of all other groups) Animus.QueuesApi | addPlayerToGameQueue | PUT /queues/{gameName} | Add a player to a game queue Animus.QueuesApi | removePlayerFromGameQueue | DELETE /queues/{playerUuid} | Remove a player from their current game queue Animus.ServersApi | getServerInfo | GET /servers/{serverId} | Get server info Animus.ServersApi | getServers | GET /servers | Gets all servers Animus.ServersApi | readyServer | PATCH /servers/{serverId}/ready | Marks a server as ready Animus.ServersApi | transferPlayers | PATCH /servers/{serverId}/transfer-players | Transfers players to another server Animus.ServersApi | updateGameServer | PUT /servers/{serverId}/gameserver | Updates a game server

Documentation for Models

Documentation for Authorization

apiKey

Type: API key
API key parameter name: x-api-key
Location: HTTP header