Go to file
Tomas Martins 6d519bf467 Renamed FloatController to SWGORequester, edited README 2019-09-17 23:17:16 -03:00
.swiftpm/xcode/package.xcworkspace Initial Commit 2019-09-02 19:46:54 -03:00
Sources/SWGOFloat Renamed FloatController to SWGORequester, edited README 2019-09-17 23:17:16 -03:00
Tests Renamed FloatController to SWGORequester, edited README 2019-09-17 23:17:16 -03:00
.gitignore Initial Commit 2019-09-02 19:46:54 -03:00
Package.swift Initial Commit 2019-09-02 19:46:54 -03:00
README.md Renamed FloatController to SWGORequester, edited README 2019-09-17 23:17:16 -03:00

README.md

SWGOFloat

SWGOFloat is a Swift framework that helps to provide a easy way to fetch information about a CS:GO weapon skin. All the information provided comes from Step7750's CSGO Float API.

Installation

Currently, this package can be installed through the Swift Package Manager

If you're running Xcode 11 or later, you can simply go to File -> Swift Package Manager -> Add Package Dependency... and search for SWGOFloat or just paste this Github page URL on the text field

If you're running an earlier version, you'll have to set up SPM on your project and add the following dependency to your Package.swift file:

dependencies: [
.package(url: "https://github.com/tfmart/SWGOFloat.git", from: "0.1.0")
]

Usage

To get started, you will need to create an instance of SWGORequester and configure it with either an item inspect link or using the S, A, D and M parameters from an inspect link.

  • Initiaing with an inspect link
let configuration = SWGORequester(inspectLink: "steam://rungame/730/76561202255233023/+csgo_econ_action_preview%20S76561198084749846A698323590D7935523998312483177")
  • Initiating with the S, A, D, M parameters
let configuration = SWGORequester(inventoryParameter: nil, aParameter: "13874827217", dParameter: "4649025583329100061", marketParameter: "2608048286785948758")

After the initial setup, use the getWeaponInfo method to start the request:

configuration.getWeaponInfo { response in
    switch response {
    case .success(let skin):
        // The request has been successful
    case .failure(let error):
        // The request has failed
    }
}

The method will return a Result type, which can contain the skin's information if the request succeeds or an ApiError, which represents an error that occurred during the request

Models

Docummentation about the models are coming soon!

Goals

  • Get skin info from CSGO Float API
  • Support for S, A, D and M parameters
  • Finish writing unit test for the request method
  • Get an item's screenshot with csgo.gallery