Home

Frannsoft edited this page Jul 31, 2016 · 42 revisions

Welcome to the FrannHammer wiki!

This API is being worked on with KuroganeHammer's permission. All credit for the actual data that is stored and retrieved goes to him and any other people that are involved in that process.

Allows consumers to pull back the data displayed on KuroganeHammer's site as JSON. The data is stored in a database and is not scraped from the site on-call.

Getting Started

Live API documentation can be found via Swagger docs

A good place to get started is the Character Data page.

API Features

This allows consumers to pull back the following types of data from the existing KuroganeHammer site:

  • Character details such as image links, color theme from KuroganeHammer.com, descriptions, etc.
  • Movement details such as Weight, Fall Speed, Walk Speed, etc.
  • Move details such as active Hitboxes, First Actionable frames, Knockback Growth, etc.
  • Ability to tailor responses to your specific needs

To see more details on these features, check out these wiki pages:

Documentation

Web API docs here - These are different from the Swagger docs above. Rather than demoing calls and results, this is the server-side code documentation.

Data.Core docs can be found here. This is the guts of the project. You can use these locally, not everything has web api calls however so you might be responsible for some making any necessary calls yourself right now. Currently, you need to build these in order to use them. Depending on demand nuget packages might be made available. These libs are all created using C# 6.

The live docs (above) are a great place to see the full capability and how one can use it.

NOTE: The API is in beta and is subject to rapid change.
Issues and Feedback

Changes are being made that could affect public calls. I'll be sure to post those types of changes in this repo. If you have an issue, feel free to open one up on the Issues page or email me at the address in my Profile or twitter at franndotexe.

Thanks for taking a look!