rabiribi-map-editing/docs/README.md

# Detailed Documentation

[Rabi-Ribi Map Editing Main Page](https://wcko87.github.io/rabiribi-map-editing/)

This is the detailed documentation for some of the more technical aspects of map editing (especially events).

Basically we store id tables and miscellaneous notes here, as a reference. Click around the various files in this directory to look through them.

## Event Basics:

How to use events
* Suppose you want to place a certain type of event (e.g. a heal point)
* First, remember the location of a known heal point (e.g. the big flower near aruraune)
* Then open up the corresponding map and go to that location and note down the event id.
* Place that event id in the map to get a heal point.

For some of the more technical events, some information may be found in the [events directory](./events)

## Item Basics:

The [table of item ids](./items/item_ids.csv) can be found in the detailed docs.

Note: In custom maps, picking up the Congratulations! trophy (item id 42) will display the time and end the game.

## Room Background/Type/Color Basics:

To modify these, make the roombg/roomtype/roomcolor layers visible and change the name labels of the room tiles.

* [Background Images](./room_background_images.md)
* [Room Color List](./room_colors.md)
* [Room Types](./roomtypes.md)
* The room colors / background ids used in the original game can be found from these text files:
  * [room_colors_original.txt](./room_colors_original.txt)
  * [room_background_ids_original.txt](./room_background_ids_original.txt)

Note: you may need to restart the game for changes in room backgrounds/types/colors to take effect properly.

## Cutscene Basics:

To modify cutscenes, create two new text files, story_emot.rbrb and story_text.rbrb, and put them in the same folder as your map files.

story_emot.rbrb is for character portraits and emotions, story_text.rbrb is for cutscene text/dialogue.
* [story_emot.rbrb Information](./cutscenes/story_emot.md)
* [story_text.rbrb Information](./cutscenes/story_text.md)