Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/APIReference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TODO: WORK ON ME!
22 changes: 22 additions & 0 deletions docs/GettingStarted.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## Introduction

StageAPI is a powerful library for [*The Binding of Isaac: Repentance*](https://store.steampowered.com/app/1426300/The_Binding_of_Isaac_Repentance/) that allows for the creation of custom stages. It also provides other functionality that the modding API does not support, such as adding bosses and custom room types.

## Installation

**Steam Users:** If you own *The Binding of Isaac: Repentance* on Steam, you can install StageAPI off of the workshop [here](https://steamcommunity.com/workshop/filedetails/?id=1348031964).

**Non-Steam Users:** If you do not own the game on Steam, can clone the repository into your mods folder. Please keep in mind that certain features in the repository might not be present in the public build available on the Steam Workshop.

---
## Tutorials

These tutorials assume that you have a basic grasp on Lua and the modding API.

* [Stage Creation](./StageCreation.md)

---

### API Reference

- [API Reference](./APIReference.md)
1 change: 1 addition & 0 deletions docs/StageCreation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TODO: WORK ON ME!