StarCraftKit

Welcome to StarCraftKit, a Swift package tailored for developers engaged in creating apps or tools focused on the professional StarCraft II scene. This package provides a robust set of interfaces designed to streamline the handling, querying, and presentation of data related to players, matches, and tournaments within the StarCraft II pro scene.

About StarCraftKit

StarCraftKit offers Swift interfaces for the pro StarCraft II scene, making it easier to integrate professional game data into your applications. Whether you're building an app to display live match updates, track player statistics, or organize tournament information, StarCraftKit has the tools you need to get the job done efficiently and effectively.

Features

Player Profiles: Access detailed profiles of professional StarCraft II players, including statistics, current status, and match history.
Match Details: Query information about specific matches, including player matchups, game results, and detailed statistical analysis.
Tournament Data: Explore comprehensive details about past, ongoing, and upcoming tournaments, including brackets, match schedules, and winner information.

Getting Started

To start using StarCraftKit in your project, ensure you have Swift 5.7 or later and add the package to your project dependencies:

dependencies: [
    .package(url: "https://github.com/marcusziade/StarCraftKit.git", from: "1.0.0")
]

Then, import StarCraftKit in your Swift files to access its functionalities:

import StarCraftKit

CLI Application

The StarCraftCLI, built with the StarCraftKit package, is a CLI tool for accessing data on StarCraft II tournaments, players, and matches. It uses command-line arguments to perform actions:

tournaments: Lists all StarCraft II tournaments.
players: Retrieves professional player profiles and statistics.
matches: Fetches details on specific matches.

Usage

Compile and run the application with Swift, providing commands like swift run StarCraftCLI tournaments to fetch data. A valid PANDA_TOKEN environment variable is required for API requests.

Environment Variable

Set the PANDA_TOKEN environment variable with your PandaScore API token for authentication.

Getting Started

To use StarCraftCLI, clone the repository, ensure Swift 5.7 or later is installed, and follow the commands to start fetching data.

Environment Variables in Xcode

To securely access the PandaScore API, which powers the package, you'll need to use an API token. Upon signing up with PandaScore, you're given a unique token.

Setting Up Environment Variables in Xcode

Create an Environment Variable for Your Token: Open your project in Xcode, select your application target, and go to the "Edit Scheme" menu. Under the "Run" section, find the "Arguments" tab. Here, you can add environment variables. Create a new variable named PANDASCORE_API_TOKEN and set its value to your PandaScore API token.

The package will look for this key in the code, so that's all you need to do manually, for now...

Contribution

StarCraftKit is under development, contributions are welcome. If you have ideas for improvements, find a bug, or want to add new features, feel free to open an issue or submit a pull request.

License

StarCraftKit is released under the MIT License.