created user guide
This commit is contained in:
@@ -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
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user