From f9f0345c82ce681217f51ed573a878943483329d Mon Sep 17 00:00:00 2001
From: zomo <admin@zomo.dev>
Date: Wed, 15 Apr 2026 21:17:48 -0500
Subject: [PATCH] created user guide

---
 readme.md    | 14 +++++++++-
 userguide.md | 77 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 90 insertions(+), 1 deletion(-)
 create mode 100644 userguide.md

diff --git a/readme.md b/readme.md
index e56c191..cadaec6 100644
--- a/readme.md
+++ b/readme.md
@@ -1,5 +1,7 @@
 # bap-room-packager
 
+**This is the guide for people who plan on working with or working on this program. [Click here for a guide if you want to submit a room.](userguide.md)**
+
 This program will take a collection of [Bapalon](https://akuma-kira.itch.io/bap) rooms and automatically package them into BAP's directory format.
 
 For a well developed example, see [SOUP ROOMS](https://kiteline.itch.io/soup-rooms).
@@ -25,6 +27,8 @@ If the following optional audios are not included, they will be automatically fi
 - FOOT
 - MUSIC
 
+### File Formats
+
 Per BAP's readme file, here's a list of accepted file formats. Read BAP's readme file for engine limitations.
 
 - image
@@ -39,7 +43,7 @@ Per BAP's readme file, here's a list of accepted file formats. Read BAP's readme
 
 ### Room Settings
 
-Each room's settings should be placed in a `ROOM.ini` (or `ROOM.txt`) file. Read BAP's readme file for more details of each setting.
+Each room's settings should be placed in a `ROOM.ini` (or `ROOM.txt`) file. Read BAP's readme file for more details about each setting.
 
 The settings from each `ROOM.ini` file will be used to generate the final `CF.ini` file.
 
@@ -56,6 +60,10 @@ Layer_Frames=1
 Fog_Color=0
 Fog_End=-1
 Mini_speed=1
+
+name=
+credits=
+links=
 ```
 
 ## Usage
@@ -118,4 +126,8 @@ Layer_Frames=1
 Fog_Color=0
 Fog_End=-1
 Mini_speed=1
+
+name=example
+credits=zomo
+links=https://example.com
 ```
diff --git a/userguide.md b/userguide.md
new file mode 100644
index 0000000..4ae3648
--- /dev/null
+++ b/userguide.md
@@ -0,0 +1,77 @@
+# Bap Room Packager User Guide
+
+**This is the guide for people who plan on submitting a room. Your organizer must be using this tool for this guide to be applicable.**
+
+[Click here to skip to the `ROOM.ini` file setup.](#room-settings)
+
+This program will take a collection of [Bapalon](https://akuma-kira.itch.io/bap) rooms and automatically package them into BAP's directory format.
+
+For a well developed example, see [SOUP ROOMS](https://kiteline.itch.io/soup-rooms).
+
+## Room Folder Setup
+
+Each room folder needs at least the following images. Every other file is optional.
+
+- ART
+- CREDIT
+- FLOOR
+- ROOF
+- WALL
+
+If the following optional images aren't included, they'll be automatically filled in with a transparent png file.
+
+- MINI
+- INTERACT
+- LAYER
+
+If the following optional audios aren't included, they'll be automatically filled in with a silent wav file.
+
+- FOOT
+- MUSIC
+
+## File Formats
+
+Per BAP's readme file, here's a list of accepted file formats. Read BAP's readme file for engine limitations.
+
+- image
+  - PNG
+  - JPG
+  - BMP
+- audio
+  - WAV
+  - MP3
+  - OGG
+  - MIDI
+
+Important notes about file formats:
+
+- audio
+  - for consistent results, use a WAV file for MUSIC
+
+## Room Settings
+
+You need to move the settings from BAP's `CF.ini` file into a new file called `ROOM.ini` in your room's folder. Read BAP's readme file for more details about each setting.
+
+**You should also include your credits.** 3 options have been added:
+
+- `name` is the name of your room
+- `credits` is your name
+- `links` is a link to you somewhere
+
+Here's an example `ROOM.ini` file.
+
+```ini
+size=1
+speed=1
+fov=55
+texture_repeat=3
+room_height=350
+layer_frames=1
+fog_color=0
+fog_end=-1
+mini_speed=1
+
+name=example
+credits=zomo
+links=https://example.com
+```