Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nick22985/manacubeapi
https://github.com/nick22985/manacubeapi
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/nick22985/manacubeapi
- Owner: nick22985
- License: mit
- Created: 2022-07-06T10:17:32.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-10T19:28:32.000Z (about 2 months ago)
- Last Synced: 2024-10-05T04:41:56.824Z (about 1 month ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/manacube
- Size: 580 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ManacubeApi
This project has no association to the official manacube developers
🚧 ManacubeApi 🚀 Under construction... 🚧
About |
Features |
Technologies |
Requirements |
Starting |
License |
Author
## :dart: About
This project is a npm wrapper to integrate with the manacube api (https://api.manacube.com/)
## :sparkles: Features
:heavy_check_mark: Api Client;\
:heavy_check_mark: Typescript;\
## :rocket: Technologies
The following tools were used in this project:
- [Node.js](https://nodejs.org/en/)
- [TypeScript](https://www.typescriptlang.org/)
## :white_check_mark: Requirements
Before starting :checkered_flag:, you need to have [Node](https://nodejs.org/en/) installed.
## :checkered_flag: Starting
```bash
# Install the project
$ npm i manacube
# import / declare client
const manacubeApi = require("manacube")
let manacubeClient = new manacubeApi.ManaCubeApi()
# Run the project
you can now use the client and the function to interact with the manacube api
```
## Functions
Declaring Client
```js
// Declare api instance
// Has to options baseUrl and disableSafeUUIDCheck. BaseUrl changes the default api url
// disableSafeUUIDCheck will not run any checks against any UUID imputed into the api.
let manacubeClient = new manacubeApi.ManaCubeApi();
let manacubeClient = new manacubeApi.ManaCubeApi('https://api.manacube.com/api/', true); // Disables UUID CHECKS
```
Reforms UUID to the correct formatting for the api or returns `Invalid UUID` if UUID isn't the valid minecraft format.
```js
manacubeClient.safeUUIDCheck('f91c3347-4be2-48f2-be73-9a4323f08497'); //return f91c3347-4be2-48f2-be73-9a4323f08497
manacubeClient.safeUUIDCheck('f91c3347-4be248f2be73-9a4323f08497'); //return f91c3347-4be2-48f2-be73-9a4323f08497
manacubeClient.safeUUIDCheck('f91c33474be248f2be739a4323f08497'); //return f91c3347-4be2-48f2-be73-9a4323f08497
manacubeClient.safeUUIDCheck('f91c33474be248323f08497'); //return Invalid UUID
```
Get Users sva's
```js
@param uuid MCC UUID
@param gamemode gamemode to get stats for
@returns A single users svas
manacubeClient.getUserSvas(uuid, gamemode);
```
Get gamemode sva's
```js
@param gamemode Gamemode to get stats for
@returns Get all SVAs that a player owns on a specific gamemode
manacubeClient.getAllGamemodeSvas(gamemode)
```
Get Patrons list of patrons and patron+
```js
@returns List of patrons uuids
manacubeClient.getAllPatrons()
```
Gets a list of all Patrons
```js
@returns List of patrons uuids
manacubeClient.getPatrons()
```
Get a list of all patron+
```js
@returns List of patrons uuids
manacubeClient.getPatronPlus()
```
Get player levels
```js
@param uuid UUID of player to get stats for
@returns Get a single players stats
manacubeClient.getPlayerLevels(uuid)
```
Get Top Guilds
```js
@param total Total amount of guilds to get
@returns Get a list of x guilds stats
manacubeClient.getTopGuilds(total)
```
Get players guilds
```js
@param uuid UUID of player to get stats for
@returns Get a single players stats
manacubeClient.getPlayerGuild(uuid)
```
Get Users Friends List
```js
@param uuid UUID of player to get stats for
@returns Get a single players friend list
manacubeClient.getUserFriends(uuid)
```
Gets Factions Placeholders
```js
@param season Factions Season payouts to get stats for
@returns Get a list of factions season payouts
manacubeClient.getFactionsSeasonPayouts(season)
```
Get factions Grace Placeholders
```js
@param placeholder placeholder
@returns placeholder
getGracePlaceholder(placeholder)
```
Get Players cubit balance
```js
@param uuid UUID of player to get stats for
@returns Get a single players cubit stats
getPlayersCubitBalance(uuid)
```
## :memo: License
This project is under license from MIT. For more details, see the [LICENSE](LICENSE.md) file.
Made with :heart: by nick22985