{"_id":"@efrei-craft/animus","name":"@efrei-craft/animus","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@efrei-craft/animus","version":"1.0.0","description":"Systme_de_gestion_du_serveur_Efrei_Craft","license":"Unlicense","main":"src/index.js","scripts":{"test":"mocha --recursive"},"browser":{"fs":false},"dependencies":{"superagent":"3.7.0","querystring":"0.2.0"},"devDependencies":{"mocha":"~2.3.4","sinon":"1.17.3","expect.js":"~0.3.1"},"gitHead":"61c6333f1f046bbd43b61321054b9f9bcb0d66c0","_id":"@efrei-craft/animus@1.0.0","_nodeVersion":"19.7.0","_npmVersion":"9.5.0","dist":{"integrity":"sha512-9M1508tgxYdHW/1ooHNaRo7EUqDX7DkSGrFEFEnC/nBDkvv56/0UPxRfP6yYFb+d8OwhQ53wkpkpiHwwU5/W1g==","shasum":"eab31009f0fe1976ddb60ae808e16d9174a80174","tarball":"https://registry.npmjs.org/@efrei-craft/animus/-/animus-1.0.0.tgz","fileCount":124,"unpackedSize":374184,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBCVVndCTkrGJR5DuYXP5kJF6Xc3X6g+sZpsOzZSNpJ+AiAlxSEdz/LHweV1tK35NrmXB1STda3PZZG2d5Lq7hb7Ag=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkC+cNACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmo6EQ/+KJaLsnRdkPFteC6pQouTfqSr+iSi5gCFScZ68hUYocwkO/Iw\r\nuBFH128NNzLplPXgpFjUYA5LP/G7RkVPi9x3LUwHDu++GFl1+Wsh67Ffetjb\r\nPPrjRIGl/U0GfdLasFSjd4xfHpZgNlt7BxQN2KWZrvvR8q3dFGtdihNKTiO3\r\nKwffFQXQSwIFfCkr/t6e5tPslDgIjjA5nDwXhp4pv9lpStsKUKfkpr0ndkM3\r\n2NUvdfIVHpgi6Qr+3hNr5SZXbTIRdMVMQ8sipa7SQMPOjs9RGL8DDJN94PUo\r\nQlhESPHUYSKKTSUv2fFjIVwGxqHTyBvBODXNUHT8JGtzeYJ1PUt9tCnaruh+\r\niXOu814N/y2UAm1c3rnZPeWBGqMKLBq1kCNY8lP8scdsVwg8OfkTQJxL+QOc\r\nhXHGnpEQgfAoSEeQjr0e6wA00bIJx7VeHjeG0cEt6IS1ew+n04g/J1967rNf\r\niWpRGYO2z57zZXqs2E7F+W0IZ2Rm5UiIy7jxl3bKNTc/HblwP+OSxnN4sW0O\r\nTbFESgpYC4pur4ireWq25qReHv19aFiqaflX9zSoZxXuXZ0ZBLy0oeYUnbpi\r\nITulhIbhWATIktqOw+ChZ/wbS2L8dYzFtijY4h+KK1aT5b6scArBFX0GRiK6\r\ncNrvclwzKQq4WXepNlF/pBR/DxJEXwZ39uA=\r\n=cPe3\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"docsystem","email":"titipub05@gmail.com"},"directories":{},"maintainers":[{"name":"docsystem","email":"titipub05@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/animus_1.0.0_1678501645475_0.5389401370436087"},"_hasShrinkwrap":false}},"time":{"created":"2023-03-11T02:27:25.405Z","1.0.0":"2023-03-11T02:27:25.612Z","modified":"2023-03-11T02:27:25.814Z"},"maintainers":[{"name":"docsystem","email":"titipub05@gmail.com"}],"description":"Systme_de_gestion_du_serveur_Efrei_Craft","license":"Unlicense","readme":"# animus\n\nAnimus - JavaScript client for animus\nSystème de gestion du serveur Efrei Craft\nThis SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:\n\n- API version: 1.0.0\n- Package version: 1.0.0\n- Build package: io.swagger.codegen.languages.JavascriptClientCodegen\n\n## Installation\n\n### For [Node.js](https://nodejs.org/)\n\n#### npm\n\nTo publish the library as a [npm](https://www.npmjs.com/),\nplease follow the procedure in [\"Publishing npm packages\"](https://docs.npmjs.com/getting-started/publishing-npm-packages).\n\nThen install it via:\n\n```shell\nnpm install animus --save\n```\n\n##### Local development\n\nTo use the library locally without publishing to a remote npm registry, first install the dependencies by changing \ninto the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:\n\n```shell\nnpm install\n```\n\nNext, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:\n\n```shell\nnpm link\n```\n\nFinally, switch to the directory you want to use your animus from, and run:\n\n```shell\nnpm link /path/to/<JAVASCRIPT_CLIENT_DIR>\n```\n\nYou should now be able to `require('animus')` in javascript files from the directory you ran the last \ncommand above from.\n\n#### git\n#\nIf the library is hosted at a git repository, e.g.\nhttps://github.com/YOUR_USERNAME/animus\nthen install it via:\n\n```shell\n    npm install YOUR_USERNAME/animus --save\n```\n\n### For browser\n\nThe library also works in the browser environment via npm and [browserify](http://browserify.org/). After following\nthe above steps with Node.js and installing browserify with `npm install -g browserify`,\nperform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually \nuse this library):\n\n```shell\nbrowserify main.js > bundle.js\n```\n\nThen include *bundle.js* in the HTML pages.\n\n### Webpack Configuration\n\nUsing Webpack you may encounter the following error: \"Module not found: Error:\nCannot resolve module\", most certainly you should disable AMD loader. Add/merge\nthe following section to your webpack config:\n\n```javascript\nmodule: {\n  rules: [\n    {\n      parser: {\n        amd: false\n      }\n    }\n  ]\n}\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) instruction and execute the following JS code:\n\n```javascript\nvar Animus = require('animus');\n\nvar defaultClient = Animus.ApiClient.instance;\n\n// Configure API key authorization: apiKey\nvar apiKey = defaultClient.authentications['apiKey'];\napiKey.apiKey = \"YOUR API KEY\"\n// Uncomment the following line to set a prefix for the API key, e.g. \"Token\" (defaults to null)\n//apiKey.apiKeyPrefix['x-api-key'] = \"Token\"\n\nvar api = new Animus.GamesApi()\n\nvar callback = function(error, data, response) {\n  if (error) {\n    console.error(error);\n  } else {\n    console.log('API called successfully. Returned data: ' + data);\n  }\n};\napi.getAvailableGames(callback);\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.rezal.efreicraft.fr*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*Animus.GamesApi* | [**getAvailableGames**](docs/GamesApi.md#getAvailableGames) | **GET** /games/available-games | Get all available games\n*Animus.GamesApi* | [**getPlayerCount**](docs/GamesApi.md#getPlayerCount) | **GET** /games/player-count | Get the player count of all games\n*Animus.MiscApi* | [**createAPIKey**](docs/MiscApi.md#createAPIKey) | **POST** /misc/api-key | Creates a new API key - temporarily public\n*Animus.MiscApi* | [**hello**](docs/MiscApi.md#hello) | **GET** /misc/hello | Says hello to the API - used for checking if the API is up\n*Animus.PermissionsApi* | [**createGroup**](docs/PermissionsApi.md#createGroup) | **POST** /permissions/groups | Creates a permission group\n*Animus.PermissionsApi* | [**deleteGroup**](docs/PermissionsApi.md#deleteGroup) | **DELETE** /permissions/groups/{id} | Deletes a permission group\n*Animus.PermissionsApi* | [**getGroups**](docs/PermissionsApi.md#getGroups) | **GET** /permissions/groups | Gets all permission groups\n*Animus.PermissionsApi* | [**updateGroup**](docs/PermissionsApi.md#updateGroup) | **PATCH** /permissions/groups/{id} | Updates a permission group\n*Animus.PlayersApi* | [**addPlayerPermissionGroup**](docs/PlayersApi.md#addPlayerPermissionGroup) | **POST** /players/{uuid}/groups | Add a permission group to a player\n*Animus.PlayersApi* | [**addPlayerPermissions**](docs/PlayersApi.md#addPlayerPermissions) | **PUT** /players/{uuid}/permissions | Add permissions to a player\n*Animus.PlayersApi* | [**changePlayerChannel**](docs/PlayersApi.md#changePlayerChannel) | **PATCH** /players/{uuid}/channel | Change a player's chat channel\n*Animus.PlayersApi* | [**changePlayerServer**](docs/PlayersApi.md#changePlayerServer) | **PATCH** /players/{uuid}/server | Change a player's server\n*Animus.PlayersApi* | [**getAllPlayers**](docs/PlayersApi.md#getAllPlayers) | **GET** /players | Get all players\n*Animus.PlayersApi* | [**getOnlinePlayers**](docs/PlayersApi.md#getOnlinePlayers) | **GET** /players/online | Get a list of online players\n*Animus.PlayersApi* | [**getPlayerInfo**](docs/PlayersApi.md#getPlayerInfo) | **GET** /players/{uuid} | Get information about a player\n*Animus.PlayersApi* | [**getPlayerPermissions**](docs/PlayersApi.md#getPlayerPermissions) | **GET** /players/{uuid}/permissions | Get a player's permissions (also gets the permissions of their permission groups)\n*Animus.PlayersApi* | [**playerConnect**](docs/PlayersApi.md#playerConnect) | **POST** /players/{uuid}/connect | A player connects to the server\n*Animus.PlayersApi* | [**playerDisconnect**](docs/PlayersApi.md#playerDisconnect) | **POST** /players/{uuid}/disconnect | A player disconnects from the server\n*Animus.PlayersApi* | [**removePlayerPermissionGroup**](docs/PlayersApi.md#removePlayerPermissionGroup) | **DELETE** /players/{uuid}/groups | Remove a permission group from a player\n*Animus.PlayersApi* | [**removePlayerPermissions**](docs/PlayersApi.md#removePlayerPermissions) | **DELETE** /players/{uuid}/permissions | Remove permissions from a player\n*Animus.PlayersApi* | [**setPlayerPermissionGroup**](docs/PlayersApi.md#setPlayerPermissionGroup) | **PATCH** /players/{uuid}/groups | Set a player's unique permission group (implies a removal of all other groups)\n*Animus.QueuesApi* | [**addPlayerToGameQueue**](docs/QueuesApi.md#addPlayerToGameQueue) | **PUT** /queues/{gameName} | Add a player to a game queue\n*Animus.QueuesApi* | [**removePlayerFromGameQueue**](docs/QueuesApi.md#removePlayerFromGameQueue) | **DELETE** /queues/{playerUuid} | Remove a player from their current game queue\n*Animus.ServersApi* | [**getServerInfo**](docs/ServersApi.md#getServerInfo) | **GET** /servers/{serverId} | Get server info\n*Animus.ServersApi* | [**getServers**](docs/ServersApi.md#getServers) | **GET** /servers | Gets all servers\n*Animus.ServersApi* | [**readyServer**](docs/ServersApi.md#readyServer) | **PATCH** /servers/{serverId}/ready | Marks a server as ready\n*Animus.ServersApi* | [**transferPlayers**](docs/ServersApi.md#transferPlayers) | **PATCH** /servers/{serverId}/transfer-players | Transfers players to another server\n*Animus.ServersApi* | [**updateGameServer**](docs/ServersApi.md#updateGameServer) | **PUT** /servers/{serverId}/gameserver | Updates a game server\n\n\n## Documentation for Models\n\n - [Animus.ApiKey](docs/ApiKey.md)\n - [Animus.Body](docs/Body.md)\n - [Animus.Body1](docs/Body1.md)\n - [Animus.Body10](docs/Body10.md)\n - [Animus.Body11](docs/Body11.md)\n - [Animus.Body12](docs/Body12.md)\n - [Animus.Body13](docs/Body13.md)\n - [Animus.Body2](docs/Body2.md)\n - [Animus.Body3](docs/Body3.md)\n - [Animus.Body4](docs/Body4.md)\n - [Animus.Body5](docs/Body5.md)\n - [Animus.Body6](docs/Body6.md)\n - [Animus.Body7](docs/Body7.md)\n - [Animus.Body8](docs/Body8.md)\n - [Animus.Body9](docs/Body9.md)\n - [Animus.Game](docs/Game.md)\n - [Animus.GameServer](docs/GameServer.md)\n - [Animus.InlineResponse200](docs/InlineResponse200.md)\n - [Animus.InlineResponse2001](docs/InlineResponse2001.md)\n - [Animus.InlineResponse400](docs/InlineResponse400.md)\n - [Animus.InlineResponse4001](docs/InlineResponse4001.md)\n - [Animus.InlineResponse404](docs/InlineResponse404.md)\n - [Animus.InlineResponse4041](docs/InlineResponse4041.md)\n - [Animus.PermGroup](docs/PermGroup.md)\n - [Animus.PermGroupPlayer](docs/PermGroupPlayer.md)\n - [Animus.Permission](docs/Permission.md)\n - [Animus.PermissionInput](docs/PermissionInput.md)\n - [Animus.Player](docs/Player.md)\n - [Animus.PlayerCount](docs/PlayerCount.md)\n - [Animus.Punishment](docs/Punishment.md)\n - [Animus.Server](docs/Server.md)\n - [Animus.Template](docs/Template.md)\n\n\n## Documentation for Authorization\n\n\n### apiKey\n\n- **Type**: API key\n- **API key parameter name**: x-api-key\n- **Location**: HTTP header\n\n","readmeFilename":"README.md"}