sigonasr2
/
rabiribi-map-editing
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

revised guide

Browse Source
master
wcko87 7 years ago
parent f3b11e78a9
commit 15cb87fe81
4 changed files with 165 additions and 81 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 111
      editorguide.md
  2. 105
      index.md
  3. 28
      runningcustommaps.md
  4. 2
      sitemap.txt

111
editorguide.md
Unescape View File

@ -0,0 +1,111 @@
# Using the Tiled Map Editor for Rabi-Ribi
## Important Notes!
**Please read all of the following points carefully before getting started!**
Tiled is a pretty flexible map editor, and can do a lot of things not accepted by the Rabi-Ribi game.
Using the editor in the wrong way can cause either the converter to crash, or the map files to not work as expected.
1. If you are deleting tiles, don't use the blank tiles in the tileset. actually erase them properly with the erase tool (E)
2. Don't ever put collision tiles in the tile layers (tile0 to tile6) or graphical tiles in the collision layer. I have no idea what happens if you do, and it probably won't be good.
3. To create events and items, use the "rectangle" tool to create a 1-tile box where the event should be, and name the tile with the Event ID. (the name can be set on the properties panel on the left). If done correctly, the event id should show up above the tile.
4. Do not name an event or tileid something that is not a number. It will cause the converter to crash.
5. Make sure you turn on [**View -> Snapping -> Snap to Grid**](https://user-images.githubusercontent.com/27341392/30008566-5d1a0a60-9153-11e7-81cf-0d874c735f5c.png) (otherwise the events/items can be placed in floating positions, which will cause problems in conversion.)
6. Minimap data layers (roomcolor, roomtype, roombg) are hidden by default. click the eye icon next to the layers to toggle on their visibility. they work similar to events/items. Set their names to other numbers to change their values.
7. Do not delete/move/insert any objects in the minimap data layers. Only change their names.
8. You can re-order the layers in the editor for viewing convenience, they will not affect anything. but do not rename the layers.(edited)
9. Don't mess with map settings like map size.
10. Press X to flip a tile by the x-axis, Y to flip by the y-axis. Do not rotate tiles. Do not flip collision tiles.
## Quick Start Guide
When you open a map in Tiled, you should see something like this.
![expecttosee](https://user-images.githubusercontent.com/27341392/30276609-f61fd322-9737-11e7-82cf-f70c570e5af9.png)
The map data is stored in layers. The layer panel is on the right, and looks like the below image:
![layers](https://user-images.githubusercontent.com/27341392/30008490-cf24761e-9152-11e7-94d2-955ab89621a7.png)
**Note: You can re-order the layers in the menu, and hide/unhide layers. But do not rename any of the layers. Renaming the layers will cause the map conversion to fail.**
There are 7 tile layers, `tiles0` to `tiles6`. These layers store tile data you can see in-game. The main layer you should be adding tiles to is `tiles1`. More details on the layers can be found in the detailed docs.
Here we take tiles from the tileset and add them to the `tiles1` layer.
![editor_adding_tiles](https://user-images.githubusercontent.com/27341392/30276612-f9f1f23c-9737-11e7-9df0-85c9e8b8c24a.png)
Tile layers are purely visual. For Erina to collide with the floor, you need to add collision tiles to the `collision` layer. **Note: Do not add collision data to tile layers, or tile data to the collision layer**.
![editor_adding_collision](https://user-images.githubusercontent.com/27341392/30276606-f5d4d1f6-9737-11e7-8a4a-86fff8f02dca.png)
Before we add items and events, make sure **View -> Snapping -> Snap to Grid** is turned on, like in the image below:
![snap to grid](https://user-images.githubusercontent.com/27341392/30008566-5d1a0a60-9153-11e7-81cf-0d874c735f5c.png)
If Snap to Grid is not on, there will be conversion errors later.
To add items, we switch to the `items` object layer. To create a new item, use the *Rectangle* tool to create a 1-tile rectangle. Name the rectangle with the Item ID of the item you want. A list of Item IDs can be found in the detailed documentation.
Alternatively, you can copy-paste an existing item object and simply change the name.
![editor_adding_items](https://user-images.githubusercontent.com/27341392/30276607-f5d61c46-9737-11e7-8f8a-b285747bf04b.png)
Almost everything else in the game is an event. More details on events will be explained later. To add an event, we switch to the `event` object layer. Create events the same way you create items.
In the following image, we create a "Start Point" event (event id 34), and a column of autosave events. (42 is an autosave event, and 44 is a no-save event, which allows autosave events to be triggered again)
![editor_adding_events](https://user-images.githubusercontent.com/27341392/30276605-f5ced0da-9737-11e7-8bea-c267c124e782.png)
Finally, you can also edit room types, room colors and room backgrounds. The most important of the three is room types. Room types affect how the camera scrolls in the rooms.
In this case, we want to turn these rooms into a single long room. We do this going to the `roomtype` layer, selecting the rooms we want to change, and change the names of these objects to "2". Room type 2 represents long horizontal rooms. More information on room types can be found in the detailed docs.
**Note: Do not delete any objects in the `roombg`, `roomcolor` or `roomtype` layers. You should only change the names of the objects.**
![editor_roomtype](https://user-images.githubusercontent.com/27341392/30276604-f59e4370-9737-11e7-9274-5cb74c175e21.png)
## Understanding Events, Item Ids, Minimap tiles (Object Layers)
When you first open up the map editor, you might notice a lot of numbers.
![mapeditor](https://user-images.githubusercontent.com/27341392/30008300-b79449c2-9150-11e7-8425-54c32eba09d3.png)
These numbers belong to Object layers. There are [five object layers](https://user-images.githubusercontent.com/27341392/30008490-cf24761e-9152-11e7-94d2-955ab89621a7.png).
* `events`: Event Triggers. Most of the things that "happen" in game come from event tiles.
Events include, but is not limited to:
* Cutscene Start Triggers
* Boss Triggers
* Music Triggers
* Enemies, and other entities like springs, computers etc.
* Easter Eggs
* Save points, heal points, warp stones
* Bomb blocks, Hammer blocks, ribbon blocks
* Map transitions
* Environmental lighting effects
* etc etc etc...
* `items`: Item ids. Only items exist in this layer.
* `roombg`: The background for each room
* `roomcolor`: The color of the minimap tile for the room
* `roomtype`: Determines if the room is a single room, or a vertical/horizontal/large room, for camera scrolling.
More detailed information on these layers can be found in the [Detailed Documentation](https://github.com/wcko87/rabiribi-map-editing/tree/master/docs).

105
index.md
Unescape View File

@ -4,8 +4,10 @@ Brought to you by the [Rabi-Ribi Speedrunning Community](http://www.speedrun.com
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://discord.gg/dDfpNAr"><img src="https://discordapp.com/assets/f8389ca1a741a115313bede9ac02e2c0.svg" height="20" />Rabi-Ribi Speedrunning Discord</a>
# How to edit Rabi-Ribi maps:
### Downloads
# How to edit Rabi-Ribi maps
## Downloads
Download the following:
1. The [Rabi-Ribi Map Converter](https://ci.appveyor.com/project/wcko87/rbrb-map-converter/build/artifacts)
2. These [Tileset files](https://github.com/wcko87/rabiribi-map-editing/files/1283420/rabiribi-tilesets.zip)
@ -13,103 +15,42 @@ Download the following:
![mapedit](https://user-images.githubusercontent.com/27341392/30008514-fea9b4f8-9152-11e7-9e5d-1bf9959714f6.png)
### How to use
## How to use
Rabi-Ribi maps have the extension `.map`. Normally, these maps are found in `Rabi-Ribi/data/area` in your steam directory. We will explain how to modify the maps in this directory.
We use the Rabi-Ribi Map Converter to convert between the `.map` file format, which is used by Rabi-Ribi, and the `.json` file format, which is used by the Tiled Map Editor.
After downloading the Rabi-Ribi Map Converter, unzip it into any location you want.
In the rabiribi map converter directory, there are three folders:
1. `s1_original_maps`
2. `s2_editable_maps`
3. `s3_final_maps`
Place the original Rabi-Ribi maps in `s1_original_maps`. These maps will never be modified by the converter.
- Double-clicking `original-to-editable.bat` will take all the maps in `s1_original_maps`, convert them to `.json` file format maps, and place them in `s2_editable_maps`.
- You can open the `.json` file format maps in the tiled map editor, as long as the **tileset files are also placed in the same directory as the `.json` files**.
- Double-clicking `editable_to_final.bat` will take all the maps in `s2_editable_maps`, convert them back to rabi ribi maps, and place them in `s3_final_maps`.
- You can copy these `s3_final_maps` back into Rabi-Ribi to try them out. (maps are placed in the `Rabi-Ribi\data\area` folder in your steam directory)
### Important Notes when working with the Map Editor
Please read all of the following points carefully before getting started.
Tiled is a pretty flexible map editor, and can do a lot of things not accepted by the Rabi-Ribi game.
Using the editor in the wrong way can cause either the converter to crash, or the map files to not work as expected.
1. If you are deleting tiles, don't use the blank tiles in the tileset. actually erase them properly with the erase tool (E)
2. Don't ever put collision tiles in the tile layers (layer0 to layer6) or graphical tiles in the collision layer. I have no idea what happens if you do, and it probably won't be good.
3. To create events and items, use the "rectangle" tool to create a 1-tile box where the event should be, and name the tile with the eventid. (the name can be set on the properties panel on the left). If done correctly, the event id should show up above the tile
4. Do not name an event or tileid something that is not a number. it will cause the converter to crash
- Double-clicking `original_to_editable.bat` will take all the maps in `s1_original_maps`, convert them to `.json` file format maps, and place them in `s2_editable_maps`.
5. Please turn on [**view -> snapping -> Snap to Grid**](https://user-images.githubusercontent.com/27341392/30008566-5d1a0a60-9153-11e7-81cf-0d874c735f5c.png) (otherwise the events/items can be placed in floating positions, which will be awkward and doesn't actually convert properly)
- You can open these `.json` file format maps in `s2_editable_maps` in the Tiled Map Editor.
6. Minimap data layers (roomcolor, roomtype, roombg) are hidden by default. click the eye icon next to the layers to toggle on their visibility. they work similar to events/items. set their names to other integers to change their values.
- Double-clicking `editable_to_final.bat` will take all the maps in `s2_editable_maps`, convert them back to Rabi-Ribi maps, and place them in `s3_final_maps`.
7. Do not delete/move/insert any objects in the minimap data layers. Only change their names.
8. You can re-order the layers in the editor for viewing convenience, they will not affect anything. but do not rename the layers.(edited)
9. Don't mess with map settings like map size etc
10. Press X to flip a tile by the x-axis, Y to flip by the y-axis. Do not rotate tiles. Do not flip collision tiles.
# Understanding Events, Item Ids, Minimap tiles
When you first open up the map editor, you might notice a lot of numbers.
![mapeditor](https://user-images.githubusercontent.com/27341392/30008300-b79449c2-9150-11e7-8425-54c32eba09d3.png)
These numbers belong to Object layers. There are [five object layers](https://user-images.githubusercontent.com/27341392/30008490-cf24761e-9152-11e7-94d2-955ab89621a7.png).
* `events`: Event Triggers. Most of the things that "happen" in game come from event tiles.
Events include, but is not limited to:
* Cutscene Start Triggers
* Boss Triggers
* Music Triggers
* Enemies, and other entities like springs, computers etc.
* Easter Eggs
* Save points, heal points, warp stones
* Bomb blocks, Hammer blocks, ribbon blocks
* Map transitions
* Environmental lighting effects
* etc etc etc...
* `items`: Item ids. Only items exist in this layer.
* `roombg`: The background for each room
* `roomcolor`: The color of the minimap tile for the room
* `roomtype`: Determines if the room is a single room, or a vertical/horizontal/large room, for camera scrolling.
More detailed information on these layers can be found in the [Detailed Documentation](https://github.com/wcko87/rabiribi-map-editing/tree/master/docs).
# How to play Custom Rabi-Ribi Maps
There are two methods.
### Method 1: Version 1.8e
The [1.8e beta version](https://steamcommunity.com/app/400910/discussions/0/1473095965300641483/) includes special features specifically to support Rabi-Ribi custom maps.
1. Add the custom map (`.map`) files to `Rabi-Ribi\custom\<your map name>`. (each custom map should be in its own folder)
2. After starting Rabi-Ribi, press F5 or F6 to open up the [custom maps menu](https://user-images.githubusercontent.com/27341392/30108930-ee520480-9336-11e7-9a82-bf40ca1ae89e.png). Select the custom map and start a new game.
### Method 2: Replacing maps
This was the original method before the 1.8e beta started supprting custom maps.
1. Replace the maps in `Rabi-Ribi\data\area\` (remember to back up the maps before you do this)
2. Start up Rabi-Ribi and start a new game normally.
- You can copy these `s3_final_maps` back into Rabi-Ribi to try them out. (maps are placed in the `Rabi-Ribi\data\area` folder in your steam directory)
Note: Even if you do not back up your maps, you can easily restore your original maps by using the Verify Game Integrity option on steam.
### NOTE: The Tileset files MUST be placed in the same directory as the `.json` files for the map editor to display correctly!
- I suggest placing the Tileset files in `s2_editable_maps`
# Modifying Character Dialogue and Cutscenes
The 1.8e beta version of Rabi-Ribi includes the ability to modify cutscenes and character dialogue for custom maps. By default, the game makes use of the files in `Rabi-Ribi\localize` for its cutscenes. If you create the files `story_emot.rbrb` and `story_text.rbrb` and place them in your custom map folder (`Rabi-Ribi\custom\<your map name>\`) together with your map, these ifles will be used for dialogue/cutscenes instead.
# Guides
More information on the contents of these files can be found in the [Detailed Documentation](https://github.com/wcko87/rabiribi-map-editing/tree/master/docs/cutscenes).
### [Running Custom Maps](runningcustommaps)
# Custom Tilesets
### [Getting Started with the Editor](editorguide)
The 1.8e beta version of Rabi-Ribi includes the ability to replace the current tileset with a custom tileset. If `tile1_a.png` is placed in the `Rabi-Ribi\custom\<your map name>\` folder, the game will use that instead of the default tileset.
### [Detailed Documentation](https://github.com/wcko87/rabiribi-map-editing/tree/master/docs/)
# Debug Mode
The 1.8e beta version of Rabi-Ribi contains a Debug mode, which displays all event triggers in-game. To turn this on, add `-debugshowevents` to the launch options.
# Frequently Asked Questions
@ -121,6 +62,8 @@ A: This happens when you don't put the tileset files in the same directory as th
A: A conversion error happens when you do something in Tiled that is not valid in Rabi-Ribi. I suggest reading the [Important Notes when working with the Map Editor](#important-notes-when-working-with-the-map-editor) to find out what you should and should not do in Tiled.
# Other Stuff
### Demo

28
runningcustommaps.md
Unescape View File

@ -0,0 +1,28 @@
# How to play Custom Rabi-Ribi Maps
There are two methods.
### Method 1: Version 1.8e
The [1.8e beta version](https://steamcommunity.com/app/400910/discussions/0/1473095965300641483/) includes special features specifically to support Rabi-Ribi custom maps.
1. Add the map files to `Rabi-Ribi\custom\<your map name>`. (each custom map should be in its own folder)
2. After starting Rabi-Ribi, press F5 or F6 to open up the [custom maps menu](https://user-images.githubusercontent.com/27341392/30108930-ee520480-9336-11e7-9a82-bf40ca1ae89e.png). Select the custom map and start a new game.
### Method 2: Replacing maps
This was the original method before the 1.8e beta started supprting custom maps.
1. Replace the maps in `Rabi-Ribi\data\area\` (remember to back up the maps before you do this)
2. Start up Rabi-Ribi and start a new game normally.
Note: Even if you do not back up your maps, you can easily restore your original maps by using the Verify Game Integrity option on steam.
# Modifying Character Dialogue and Cutscenes
The 1.8e beta version of Rabi-Ribi includes the ability to modify cutscenes and character dialogue for custom maps. By default, the game makes use of the files in `Rabi-Ribi\localize` for its cutscenes. If you create the files `story_emot.rbrb` and `story_text.rbrb` and place them in your custom map folder (`Rabi-Ribi\custom\<your map name>\`) together with your map, these ifles will be used for dialogue/cutscenes instead.
More information on the contents of these files can be found in the [Detailed Documentation](https://github.com/wcko87/rabiribi-map-editing/tree/master/docs/cutscenes).
# Custom Tilesets
The 1.8e beta version of Rabi-Ribi includes the ability to replace the current tileset with a custom tileset. If `tile1_a.png` is placed in the `Rabi-Ribi\custom\<your map name>\` folder, the game will use that instead of the default tileset.
# Debug Mode
The 1.8e beta version of Rabi-Ribi contains a Debug mode, which displays all event triggers in-game. To turn this on, add `-debugshowevents` to the launch options.

2
sitemap.txt
Unescape View File

@ -1,2 +1,4 @@
https://wcko87.github.io/rabiribi-map-editing/
https://wcko87.github.io/rabiribi-map-editing/editorguide
https://wcko87.github.io/rabiribi-map-editing/runningcustommaps
https://wcko87.github.io/rabiribi-map-editing/random_images

Write Preview
Loading…
Cancel
Save