documentation

README.md

@@ -1 +1,46 @@
-todo document this LOLL
+# nlw-api
+
+A simple API that caches and allows you to fetch data from the [Non-Listworthy Extreme Demons spreadsheet](https://docs.google.com/spreadsheets/d/1YxUE2kkvhT2E6AjnkvTf-o8iu_shSLbuFkEFcZOvieA/edit) (and [Insane Demon Spreadsheet](https://docs.google.com/spreadsheets/d/15ehtAIpCR8s04qIb8zij9sTpUdGJbmAE_LDcfVA3tcU/edit)!) running on `https://nlw.oat.zone/`. Originally made for the [NLW Integration](https://geode-sdk.org/mods/oatmealine.nlw_integration/) Geode mod, but free for anyone to use.
+
+## Documentation
+
+### Endpoints
+
+#### `/list?type={type}`
+
+Fetches the entire list as a JSON, including levels of type `type`. `type` can be `regular`, `pending`, `platformer` or `all` and defaults to `regular`.
+
+**Returns**: An array of [`NLWLevel`](#nlwlevel--level)s.
+
+#### `/ids`
+
+Fetches the IDS list as a JSON. **Experimental.**
+
+**Returns**: An array of [`IDSLevel`](#idslevel-level)s.
+
+### Objects
+
+#### `Level`
+
+Represents a generic level.
+
+- `sheetIndex`: The row index of the level on the associated spreadsheet. 0-indexed.
+- `name`: The name of the level. Standardized to the in-game level name.
+- `creator`: The creator(s) of the level, as listed on the sheet.
+- `description`: Descriptions and notes as listed on the sheet.
+
+#### `NLWLevel` : [`Level`](#level)
+
+Represents an NLW level.
+
+- `tier`: `"Fuck"`, `"Beginner"`, `"Easy"`, `"Medium"`, `"Hard"`, `"Very Hard"`, `"Insane"`, `"Extreme"`, `"Remorseless"`, `"Relentless"` or `"Terrifying"`.
+- `skillset`: Level skillset, as listed on the sheet.
+- `enjoyment`: Level enjoyment sampled from EDEL as a string. Can be `"N/A"`, look out!
+
+#### `IDSLevel`: [`Level`](#level)
+
+Represents an IDS level.
+
+- `tier`: `"Fuck"`, `"Beginner"`, `"Easy"`, `"Medium"`, `"Hard"`, `"Very Hard"`, `"Insane"` or `"Extreme"`.
+- `skillset`: Level skillset, as listed on the sheet.
+- `broken`: If the level is broken in 2.2. `"no"`, `"yes"`, or rarely `null` if unknown.