Skip to content

An unofficial JavaScript SDK for the Wynncraft API, providing easy access to Wynncraft game data with built-in caching support.

License

Notifications You must be signed in to change notification settings

Sebastien-Moraz/WynnSDK

Repository files navigation

WynnSDK

WynnSDK

An unofficial JavaScript SDK for the Wynncraft API, providing easy access to Wynncraft game data with built-in caching support.

Installation

npm install wynnsdk

Features

  • 🚀 Easy-to-use wrapper for the Wynncraft API
  • 💾 Built-in caching system to respect API rate limits
  • ⚡ Promise-based async/await support

Usage

import { WynnSDK } from 'wynnsdk';

// Initialize the SDK
const sdk = new WynnSDK();

// Get player information
const playerInfo = await sdk.getPlayer('PlayerName');

// Get guild information
const guildInfo = await sdk.getGuild('GuildName');

// Get item information
const itemInfo = await sdk.searchItem('Legendary Spear');

// Get live player and guild, party, friend locations
const playerLiveData = await sdk.getPlayerLocations();

Caching System

WynnSDK implements an intelligent caching system to:

  • Respect Wynncraft API rate limits
  • Reduce API calls for frequently requested data
  • Improve response times

Cache durations:

The cache duration is automaticly determinate with header of the request.

Documentation

Full documentation will be available soon.

Contributing

Contributions are welcome! Feel free to:

  1. Fork the project
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

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

Author

  • Sebastien Moraz

Links

Support

If you encounter any problems or have questions, please:

  • Open an issue
  • Contact the author through GitHub

About

An unofficial JavaScript SDK for the Wynncraft API, providing easy access to Wynncraft game data with built-in caching support.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •