From 3650f82a2ba1db51b74c848a3037896369c4c0f3 Mon Sep 17 00:00:00 2001 From: Syntax-Sculptor Date: Mon, 7 Apr 2025 07:51:50 -0800 Subject: [PATCH] docs: getting started page --- docs/APIReference.md | 1 + docs/GettingStarted.md | 22 ++++++++++++++++++++++ docs/StageCreation.md | 1 + 3 files changed, 24 insertions(+) create mode 100644 docs/APIReference.md create mode 100644 docs/GettingStarted.md create mode 100644 docs/StageCreation.md diff --git a/docs/APIReference.md b/docs/APIReference.md new file mode 100644 index 0000000..c38b506 --- /dev/null +++ b/docs/APIReference.md @@ -0,0 +1 @@ +TODO: WORK ON ME! \ No newline at end of file diff --git a/docs/GettingStarted.md b/docs/GettingStarted.md new file mode 100644 index 0000000..01a5a11 --- /dev/null +++ b/docs/GettingStarted.md @@ -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) \ No newline at end of file diff --git a/docs/StageCreation.md b/docs/StageCreation.md new file mode 100644 index 0000000..c38b506 --- /dev/null +++ b/docs/StageCreation.md @@ -0,0 +1 @@ +TODO: WORK ON ME! \ No newline at end of file