bap-room-packager/userguide.md

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.

This program will take a collection of Bapalon rooms and automatically package them into BAP's directory format.

For a well developed example, see 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.

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