search

project-slippi / slippi-js

Parse slp files and compute stats
GNU Lesser General Public License v3.0
147 stars 78 forks source link

Improve Documentation #44

Open NikhilNarayana opened 3 years ago

NikhilNarayana commented 3 years ago

Right now there is no direct documentation about the inner workings of slippi-js. It takes a decent bit of effort for devs to familiarize themselves with the SLP spec and the various tools provided by slippi-js. It would be ideal to have a central location for most of this info (linking back to the spec for deeper explanations would be acceptable).

b3nd3r-ssbm commented 3 years ago

I'm working on getting the info together, rn I have the SlippiGame object and its functions

Gaurav-Iyer commented 3 years ago

Has this documentation been pushed up anywhere, I couldn't seem to find it.

NikhilNarayana commented 3 years ago

Has this documentation been pushed up anywhere, I couldn't seem to find it.

nothing has been pushed anywhere to my knowledge or been reviewed for accuracy. for now asking in our discord's dev-support channel is a fine method to figure out what you need