Welcome to the official RPG Paper Maker documentation page! Here you will find all that you need to become a pro Paper Maker!

-- How do I get this amazing program?
Installation
You can find the installer by clicking the orange DOWNLOAD button on the home page, or from the download link along the top of the official website. Choose between the free and commercial options, then your OS. 

The installer will allow you to choose the version you want to download. It's recommended you use the latest version, but all versions are always available. Once the files are downloaded and installed you can launch right into the program.

Windows
Run RPG Paper Maker installer.exe and follow the instructions.  

Linux
Extract the file. Check out the README instructions in the root of the folder (the last instruction is./run.sh). 

MacOSX
Extract the file. Run RPG Paper Maker.app.

-- The program is open...now what?
There are a few options that apply to the editor itself so let's look at those first.

Change theme
There are two different themes: Dark and White. 

If you want to change it, go to Options > General options....

        



There is also an option to hide the splash screen while the program is loading if you don't want it to remain on top of other programs. 

Change language
You can change the engine language in Options > Change language...:


Enable / Disable Updater
This option will check for new updates to RPG Paper Maker on startup. Go to Options > Auto display updater. You may want to disable this if you choose to work in an older version.

 


-- I'm ready to create!
Create a new project
You can create a new project by clicking here on the main toolbar:


You can also use CTRL+N or go to File > New project....


Here you can choose the Project name , which is the name of your game and is used as a label on the game window. Enable  auto-generate if you want to generate a folder name based on that project name. Otherwise enter it manually in the Directory namefield. Then choose the location of this project folder. By default, it will be on a freshly created RPG Paper Maker Games folder in the user's Documents folder. 

Open an existing project
You can open an existing project by clicking here on the main toolbar:


You can also use CTRL+O or go to File > Open project > Browse.... 

Recent projects can also be opened on the first screen (or go to File > Open project).

-- What should I do first?
Before you jump into making maps and working on gameplay there are settings you should get in order first. They will determine how some functions work later on, so it's pretty important. 

Update keyboard controls
Here you can customize all controls used in the editor and the game.  

Click the KEYBOARD icon in the main toolbar:


The ENGINE CONTROLS are what you use in the editor. Right now you can only change the directions, which moves the cursor(allowing you to look around the maps you are making).

The GAME CONTROLS are the what the player will have available to press in game. If you plan on using a key you first have to add it to this list, then it becomes available to use in your code. All controls in this list are available in the main menu under SETTINGS for the player to customize in the game, if you choose to allow it.  

The MENU CONTROLS link actions that are used by the player for window based menus to existing GAME CONTROLS.  

The default controls are set up like your standard RPG game, but you can name them anything you want. If you were making a spaceship game you might name keys "acceleration" or "shields". What happens when these keys are pressed is determined by your game objects, mainly the hero. The entire system is customizable. 

You can add as many keys as you want to the GAME CONTROLS. To make a new one right click anywhere on the list, or double click below the bottom entry. You can add new ones now and decide what they are used for later. Or maybe just come back each time you think of a new key to add.

Abbreviation: Name used for JavaScript use (for advanced programmmers).

Description: Will be displayed in game at the keyboard settings menu.

Shortcut: Choose the keyboard key here. To set a new key press Change.... You can have more than one key per action. They are separated with a | symbol. You can also use the + symbol for key combinations. 

Remove last: Remove the last shortcut (from the right).

Remove all: Remove all shortcuts.

Change general game settings
A lot of options are available in the Systems manager. The many tabs along the top contain important game elements but for now let's focus on the first tab, System. 

You may not need to change all of these options but many of them need to match the resource files you will use. This engine doesn't use fixed resource file sizes. You decide that by altering the following options. 

Click the SYSTEMS icon on the main toolbar. It will display the last tab you were working on. 


This will be a brief explanation of the options along the left side. Some will be explained in more detail further ahead in the documentation. 

Game name: Set the name of your game.

Game native resolution: Set width / height resolution of the game when in window mode (this doesn't apply to Fullscreen mode). You can choose between Window or Fullscreen display.  

Antialiasing: If checked, antialiasing will be applied in game.

Mouse controls: If checked, mouse controls will be applied (windows choices, events...)

Map properties:

Square size (in px): this is the size (in pixels) of one tile in your maps. Your other graphics should match this size, with larger sprites being multiples of the base size. (16, 32, 48, etc).

Ray portions (editor): The map is separated into several portions (16x16 squares). You can change here the number of portions to display.

Ray portions (ingame): Same but for ingame.

Mountain collision height limit (in px): this determines how high a mountain type block has to be before it blocks the player's movement. Anything lower will be treated like a step and you walk over it. 

Mountain collision angle limit (in degree): this determines how steep a slope the player can walk up. Too steep and you can't walk up or down. 

Frames:

Map frame duration: Time in milliseconds for a frame to pass on a map. 

*some of the below lists need verification/expansion*

This affects: object sprites, battle animations called outside of battle, etc. 

Doesn't affect: autotiles, battle?. 

Animation frames: determines the number of frames in 1 cycle of an animation. 

This affects: object sprites, etc. 

Doesn't affect: battlers, autotiles. 

Battlers frames: determines the number of frames in 1 cycle of a battler animation.

Battlers rows: The number of rows available in a battler graphic file.

Autotiles frames: determines the number of frames in 1 cycle of a

 animated autotile.

Autotiles frame duration: Time in milliseconds for a frame of an animated autotile.


      *Adding frames means you have to increase the width of your graphic files. 
      *Adding rows means you have to increase the height of your graphic files. 

Global sounds:

Cursor: Sound to play when the cursor moves.

Confirmation: Sound to play when confirming a menu choice.

Cancel: Sound to play when canceling something.

Impossible: Sound to play when a choice is impossible.

Other options:

Window skin: The default window skin used for various window UI elements. 

Faceset scaling width/height (in px): The faceset stretched width/height when using a 640x480 screen resolution. This exists in order to have HD facesets for bigger screen resolutions.

Icons size (in px): The size of the icons used in messages and item names. You can include many icons in one resource file and this determines the uniform size for each individual icon. 

Max number of save slots: Change the max number of save slots available to the player.

Price of sold item: Set how much of the original value you get back when selling an item. This can be a variable. 

Most of these options will be set once and never changed. Doing so could mean you have to adjust all your resource files to match. You will want to set some standards early to avoid wasting time converting dozens of files if you decide to change these numbers halfway through development. 

Some settings could be determined by your resources, too. If you have a 64x64 character and can't make it any smaller, that becomes your baseline for other things. 

Now let's look at the right side of the System tab.

Each of these lists works the same way. Right click for options of the highlighted item or double click an existing item to edit it. 

You can add as many items as you want but you first have to make room. Use the +, -, and SET MAX buttons at the bottom of each list to change it's total size. Then edit the new empty item to make something new. The values you can set differ from list to list. 


Font sizes
When writing some messages you are given a dropdown menu of choices for font size. This list is where you determine what choices are available. 

Choose whatever name you want. You may want to label them to match the number used like "10", instead of descriptors like "Small". 

Size is in pixels. It can be a number or a variable. 

Font names
This is where you choose what fonts will be available to use in the game. 

The first step is to place the font files in your project - "project folder/.../content/font". 

Next click on the FONTS icon in the main toolbar.




Make sure the box is checked up above or you won't see your new fonts on the right side. From here simply double click a file on the right side to put it in the middle. Only the files in the middle can be seen by the editor. 

Changing the name here is mainly for when the file was changed externally - update it here to match. You will have a chance to give it a label later on that you will see more often. Hit OK when finished. 

Now go back to SYSTEMS and our FONT NAMES list. Edit a new entry.


Here is where you give it a label that you will see when picking fonts to use from a list.

Most of the time you will use the FONT ID setting and choose one from that dropdown list. Here you will find the files we moved from the right side to the middle earlier. 

Choosing the BASIC setting gives you 2 options. Text and Variable. 

Text allows you to name a font, perhaps even referencing the users pre-existing OS fonts (as Arial isn't in the above list).

Variable allows you choose a variable, which can later be changed to contain different words in order to set it to that font more easily. This allows for all kinds of gameplay ideas, like having a different font in each town or when your HP is low. 

Colors
These are required for commands that need to be given a color to use, such as flash screen and fonts. You may want to enter the base rainbow of colors in advance. You can always come back later to fine tune the RGB values to match the palette of your other graphics or maybe because it clashes with your window skin. 


Window skins
Creating a custom window skin is a bit complex so you'll want to stick with the default for now. It's something that will be explained in detail later. You can make basic changes or recolor the default skin for a simple new look. 

Currencies
The currencies you use will depend on your gameplay. This is for later. 

Speeds
Objects have an option for their default speed. When choosing that speed you will see the items listed here. It's used in other commands like Move Object. 

I found it helpful to label the speeds with numbers instead of descriptions like "fast". It's a good idea to create many values here that you might use; 0.1, 0.2, 0.3, 1.5, 2.0, 2.5, etc. This keeps the list organized and you won't have to keep coming back here in the future to add more. 

You can also label some speeds "Hero" or "Bullet". Then only assign those speeds to those objects. This becomes useful when you use a variable for the speed. By changing a variable you can adjust only the Hero's speed without needing to use a Move Object command. It's easier to code fun gameplay elements, like walking speed being based on the hero's Agility stat.

Detections
This is for later. It's used for the built in hit detection system. 

Camera Properties
This is for later. It's used to create different default camera angles.

Frequencies
This determines how often certain things happen. As of now I only know it can be used for object movement. It determines how long to wait after each action. If an object was set to move east, east, east - the frequency is how long it waits between each step. 

If you look at the default "Instantaneous" you will see that the number is 0. It will wait 0 seconds after taking 1 step, to create fluid movement. You can add a few numbers here like with speeds, for fine tuning object movement later on. 0.1, 0.2, etc.

Skyboxes
This is for later. It's used to create a cube of walls, floor, and ceiling that is used as the backdrop to your maps. You will need to create custom resources to make a skybox, but that is part of the mapping process later. 

Initial Party Members
This is for later, when you actually have heroes to add.

-- A hidden feature
Most of the other tabs here are self explanatory. You will end up working in them later as you flesh out your game. They will be explained in more details in other sections. However there is one other important hidden feature here to understand early on. 

It's on the MODEL tab:



A model is like an object you might find on a map, except this is global and outside of any map. Any map object can use a model instead of having it's own code. It's a template for objects.

The first model in this list is what determines the default values when you create a new object on a map. So you can tailor this model to however you want your new objects to start out. It might even be useful to change it temporarily to easily mass produce some objects on a map. 

I find it helpful to disable the check boxes for "Block hero when reaction" and "Pixel Offset". Most of my objects won't want that enabled by default, but the actual look of this model will depend on your needs and preferences.

DO NOT use this model for any other purpose(unless you have a good plan). If you made this into a treasure chest, then every new object would start out as a treasure chest.

-- My game is made now
Test your game
Now that you set the foundation for your project it's time to make something. Once you get some maps and objects strung together you can test your project by clicking here on the main toolbar or pressing P.


You can edit your project while the test window is open. Any changes won't take effect until you restart the test, but you can fix bugs as you find them without interrupting the test game. 

It's worth mentioning that you have some options available for test play accessed from the menu. 



Showing the bounding boxes will help you visualize hit detection and collisions in general, but it's a great tool for debugging issues. This can cause lag on low end computers. 

You can show the frames per second(FPS) rate. 

The "Synchronize map objects" buttons is used to resolve a specific bug. This will be explained later in the mapping section. 

Deploy your game
There are 2 ways to do this. You can zip/rar the project folder and send that out. It doesn't need to be opened in the editor to play, simply run game.exe. However, RPM will need to be installed on that computer. 

Or you can use the built in export function. It can't be opened in the editor anymore, but it won't require any extra installation. It creates a new folder which you would then have to zip/rar.

You can find it in the menu, under File > Export standalone....


Location: The location of the standalone folder that you want to create. The default name of this folder will be GameName+{OS}+{version}.

Type of export: Choose export options here.

Deploy a desktop application: Choose here to deploy your game as a desktop application (choose the OS from the dropdown menu: Windows, Linux, or Mac).

Protect data: Enable this if you want to encrypt the files so they can't be accessed outside of the game. (This may cause the game not to load. Always test your standalone game)

Deploy for web browser: Choose here to deploy your game as a web application. This will generate a folder with an index.html file on the root that you can easily export to your website.

Version: Make up a version number. These numbers are automatically used in name o fthe resulting folder. Having 1 for major and 0 for minor will create a 1.0 version.

Your folder would turn out like this: Getting-Started-WINDOWS-x64-v1.0 (but feel free to rename it). Now you can send your masterpiece out into the world. 

-- Conclusion
If you have used other RPG making software before you will find a lot of this engine very familiar. The biggest reason to use it, besides the 3D, is the flexibility of those familiar features. It has a way of letting you do a lot with much less code than you would expect, as long as you make use of the new features as well. 

Map editor
-- Overview
This section will explain the basics of each aspect of the map editor. It will include what each section is used for, how to interact with it, what each button/menu does, and the keyboard controls for map editing. 

For more in depth explanations and usage look at the ADVANCED section about mapping. 

-- Meet the Editor
After opening a project, you will be brought to what we can consider the home screen of our project- The Map Editor. From here you have access to every feature the engine has to offer. 

Let's look at each individual section. 


(1) The Map Selector
A.K.A the map tree, this is where you create and organize the maps that make up your game. You can create folders and drag items around at any time(this won't affect your code, like teleport commands, so it's safe to do).

Click on the map you want to appear on the right side (5) for editing. Clicking on a folder displays no data in the other sections. 

It is recommended that you use folders to categorize your maps. There are different approaches to naming conventions like area names, level numbers, story elements, etc. 


You can use folders inside of folders to further categorize things. Whatever works best for you. 

In the default RPG battle system regular maps are used as the backdrop. So by default there is a folder called "Battle maps" which is used to store these maps. This isn't required but is highly recommended to keep them separate from normal maps the hero will walk on. Although for some games you might just use normal maps for battle. 

To make a new map you have to right click on a folder. Maps can't exist outside of at least one folder. By default each project starts with a top folder called "Maps". You can't even delete everything from the map tree, there will always be one folder present. 

You can right click on a map for the usual options like edit, copy, delete. 

If you right click on a folder you get similar options for that folder. When you copy a folder it can only be pasted on another folder or an open space under the list.

When you create or edit a map, you will get this window:


Name: Label for your map that appears in the map tree.

Tileset: This determines what tiles you have available to draw onto this map.

Size:

Length: The map length in number of squares (X axis, left to right).

Width: The map width in number of squares (Z axis, front to back).

Height: The map height above 0 in number of squares (Y axis, floor to sky).

Depth: The map depth below 0 in number of squares (Y axis, floor to seabed).

*Depth isn't always needed if you plan your maps ahead of time. But if you suddenly want to add lower levels to a map you can increase the depth to be able to draw lower in the Y axis.

Music: The music played in the background while on this map.

Background sound: This is like a second sound channel that lets you play a repeating sound file alongside the music. Common uses would be wind/rain, birds chirping, etc.

Camera prop. ID: The settings for the camera that are applied when entering the map. Any previous changes to the camera are lost.

Sky: (the area around or behind your map tiles)

Color ID: Use a solid color for the entire sky.

Picture: Use a picture for the entire sky. It doesn't rotate with the camera.

Skybox ID: Uses 6 images to form a cube around the map. This does rotate with the camera.

There are 2 tabs on the right side:

Map startup reactions: Like objects on your map you can add code here. By default it's set up to run this code only once, each time you enter the map. However you can adjust the STATES/EVENTS however you'd like.

Battles: This lets you enable random battles on the selected map.  


Battle map ID: This determines what map the fight will take place on. You can use a variable for this.

Random battles: Create a list of possible enemy troops to battle.
*Double click an empty space or right click to add to the list
(see below image for that dialogue box)

Number of steps after next battle: Determines how many steps are required to trigger a battle. (1 square = 3-4 steps)

Variance (%): Provides variation to the above number so it's not the same number of steps each time. (It's a percentage)
*300 steps with 20 variance = 240-360 steps between battles


Troop ID: The group of enemies to fight.

Priority: Determines how often this troop will be picked to fight. Higher number gets picked more often.

Probability: The calculated probability of this troop getting picked, based on the priorities of all troops in the list. (Since there is only one troop it's showing 100%. It changes as you add more.)

Terrain: Determines which parts of the map can trigger this fight.

Entire map : You can trigger this battle from anywhere on the map.

Terrain: Choose a number and only tiles with that assigned number will trigger this fight. You can add multiple numbers.

(2) The Tile Selector
This is where you see all the tiles available to draw with. These tiles can also be used by objects in place of a full character sprite sheet. 

Only 1 tileset can be selected per map, however there is no limit to how large a tileset can be. So you can put all your game's tiles on one tileset and use it for every map. Or you can use different files for different maps. (I prefer one large tileset)

There are really only 2 functions here:

Left Mouse Click - Select a single tile. This will be used with whatever draw tool you select.

Left Mouse Click and Drag - Use this to select more than one tile. Useful for drawing large objects like trees or houses. It's alignment with the grid changes between odd and even number of tiles selected. If your 3 tile wide tree isn't matching up, try drawing it 1 or 2 tiles at a time. 

The map and tile selector boxes are connected. 

You can drag the horizontal separator up and down to see more of one or the other. It's useful to see more of the tiles when drawing maps. 

You can also move the vertical separator left and right to hide or show more of both sections. It's wise to limit your tileset in width, so you don't have to make this box too wide in order to see everything. 



(3) Drawing types
There various types of terrain and each one works differently. You will be switching between these on a regular basis. The currently selected type that you will be drawing with is always highlighted.

Each type has sub types. The word you see is the subtype selected. When you hover your mouse over that type you will see a list of subtypes. Click one and that word is now showing, which tells you what kind of tile you are about to draw. If that type is highlighted, of course. Click the words directly to switch types without changing the subtype. 

Land - These tiles are laid flat and make up what the player will walk on.

Floor - Draw tiles from the tileset to make up a floor. 

Autotile - These use unique resource files. They can be animated and have special properties. These resource files have to be imported to a list before they appear in the tile selector. (More on this in the next chapter)

Sprites - These tiles are drawn standing up, like the hero. 


Face Sprite - Draws tiles from the tileset that always turn with the camera to "face" the viewer.

Fix Sprite - Draws tiles from the tileset that don't turn with the camera. They remain "fixed" in their orientation

Double Sprite - Same as Fix Sprite, except 2 copies of the tile are crossed together. They don't turn with the camera, but never appear flat when seen from any side.

Quadra Sprite - Same as Double Sprite, except 4 copies to appear more full.


Wall - These use unique resource files and are drawn using their own unique method. They can only be drawn by choosing a starting point and an end point in a straight line. Then the graphic fills in a wall in between. You can't single click to delete a wall. You have to right click a starting point then right click an end point and it will erase everything in between. You need to be on the correct Y axis for this. 

These resource files have to be imported to a list before they appear in the tile selector. (More on this in the next chapter)


Mountains - These are squares and slopes that give a 3D feel to any map. 

Mountain - These use unique resource files that are used to create squares, with FLOOR tiles used on top. By changing some options you can create slopes of various sizes instead. 

These resource files have to be imported to a list before they appear in the tile selector. (More on this in the next chapter)


3D Objects - These use pre-rendered models of any shape and size as static scenery.

3D Object - Lets you place and drag around your 3D objects on the map.


Object - These are used for the hero, npcs, interactive items, or to simply add code to a map. They use 2D sprites for a graphic in either fixed or face orientation. You can use 3D objects but that feature is not fully functional (as of Dec 2022).

Object - Lets you create and drag around objects on the map.

View - This is for viewing the map.

View - Lets you see things as they will appear in the game.

(4) Drawing tools
Once you select the type, it's time to choose a tool to draw with. Not all drawing tools are available for all types. 

There are 3 groups separated by a vertical line:

Group 1 determines if it will align to the grid or not.

The first icon has an isometric view of a square, to say it will align to the grid and the other squares.

The second icon is just a pixel, to say you can place it on any pixel you want. 

Some tiles benefit from being aligned to the grid and it makes it easier overall, especially when working with the Move Object command. 

Other tiles look better when pixel placed, like scenery, for a more natural look. Trees and flowers, for example. 

Group 2 are your basic art tools.


The first icon is the MOVE tool. With it you can move what is already drawn. Click and drag them around.

The second icon is the ROTATION tool. With it you can rotate what is already drawn. In place of the Tile Selector you will see some options. Choose here which axis you want it to rotate on and by how much, then click on something drawn to apply it.

The third icon is the SCALING tool. With it you stretch what is already drawn. Choose which axis to alter, then click and drag something. It will stretch in that direction. 

The fourth icon is the PENCIL tool. It will draw whatever you have selected from the Tile Selector. Click and drag to draw freehand. Right click will delete whatever the mouse cursor is pointing at, however it can only delete whatever is from the selected Draw Type. (You can't erase sprites while floor is selected)

The fifth icon is the SQUARE tool. It will let you click once to start a square, then drag to the desired size and let go of the mouse button to finish. Using right click instead will delete in the same way. 

The sixth icon is the PAINT tool. It will fill the area you click on with whatever you have selected from the Tile Selector. Using right click instead will delete in the same way.

Group 3 determines what layer it will draw on.


The first icon has an isometric view of a single square, this is the default layer. When you draw there is only one layer. Drawing on an existing spot will remove the previous tile. It will not delete more than one layer under it if many are stacked.

The second icon is an isometric view of a 2nd square on top, to say that this will be drawn as an extra layer on top of whatever you click on. With this enabled you can draw an infinite number of layers on top of already drawn tiles. When you right click to delete it will remove the top layer first. You would have to keep right clicking to remove each layer in a stack. 

!! IMPORTANT !! - Be careful when using the extra layer tool. When you are done using it always remember to switch back to the default layer. Drawing some things with the extra layer can have undesired consequences, resulting in the need to redraw parts of your map. It's not fun.

A common behavior of all drawing tools is that when you click and drag, the cursor is locked to that Y coordinate. You will need to click again to affect any other Y coordinate. 

When you are drawing, the camera angle plays a big part in where you can draw. It will always try to place the tile you want to draw on top of anything under your cursor. You may need to turn the map, or change the zoom level, to draw in the exact spot you want to. Turning the camera upside down is sometimes required.

For example, lets says there is a flat map with a mountain in the middle. If your cursor appears over the mountain, it will automatically draw at the higher Y elevation of that mountain. If your cursor appears over the ground below, it will draw at that lower Y elevation. If you wanted to draw floor tiles under the mountain, you would start drawing on the floor next to the mountain and drag the cursor under the mountain, because the drawing will be locked to that Y value and it will prevent the tile from drawing on top of the mountain.

The Advanced > Mapping section will go into more detail on using these tools effectively. 

(5) Drawing space
This is the area for viewing and drawing your maps. 

You will see data in the bottom left corner of this section that will help guide you, especially when using the pixel drawing option.



It displays the information where your cursor is. You can hover over a tile to see it's coordinates and other info. This also tells you where it's going to draw/delete when you click, so if it's going to affect a tile on a higher Y value it will tell you here beforehand.

There are 2 numbers in the top left corner of this section. This tells you where on the Y axis you will be drawing(unless your cursor is over a tile with a higher Y value). When you change this value the visible grid moves up and down. This is listed in the menu under Edition>Height up/down. Height moves in full squares, and Height Plus moves in pixels on top of that. 

Generally left mouse button is for drawing graphics or selecting an object. 

Right click will delete graphics or give a context menu for an object.

If you have a scroll wheel it will change the camera zoom level. You can also click and drag the scroll wheel to turn the camera.

Keyboard shortcuts are needed to draw at different Y elevations (see below Keyboard Shortcuts/Modifiers).

(6) Main Toolbar
This contain icons for the most common functions of the editor. 

You can right click anywhere on this toolbar for an option to toggle it on and off. When it's off, you right click anywhere in the main menu section to get it back.

When the editor is in windowed mode and not long enough, you will see double arrows on the right hand side of the toolbar. Click this to view the hidden icons. 

(7) Main Menu
From here you can access all functions, including what's already visible in the toolbar. 

However, there are a few things found only here so I will cover those.

File

Open BR Folder - This opens the location of the default resource files that came with RPM, if you need to examine them for any reason. (BR = Basic Resources)

Export Standalone - To create a copy of your game to publish.

Close Project - This will bring you back to the RPM launch page. 

Edition (A.K.A. Edit)

Shows you some useful keyboard shortcuts, or allows you to trigger those functions with mouse clicks. 

Options

Set BR Path - Lets you choose the location for the engines default resources. Very few people will ever need to change this.

Set DLC Path - Lets you choose the location for the engines DLC resources, if you have any. 

Debug Options - Remember this for when you have a bug to fix.

General Options - Some options that apply to the editor.

Change Language - Choose the language for the editor. (Doesn't affect the game)

Auto Display Updater - This is a check box to toggle it on/off. When on, it will check for updates every time you start RPM. 

Display

Show / Hide Grid - Toggles the grid visible on your maps. Recommended you leave this on as the grid easily shows you which Y elevation you are currently set to draw on. (You can use the "View" Draw Type to see your map without the grid)

Show / Hide Square Info - Toggles the information where your cursor is pointing. (It's not very obtrusive and extremely helpful, so you might only need this off if you want clean screenshots from the editor) 



Help

About - Check what version of RPM you are currently running.

-- Keyboard Shortcuts/Modifiers
When looking in the main menu you can see some of those options have keyboard shortcuts next to the name; CTRL+N, SHIFT+UP, G, etc. You can get by without knowing most of them, although the Height Up/Down(moving Y axis grid) can only be achieved by using the keyboard. 

There are keys that modify how your mouse behaves when working on your maps and it's not really stated anywhere inside the program (yet).

SHIFT - While holding this, you can click and drag to turn the camera. This is helpful if you only have 2 mouse buttons. 

CTRL - While holding this, you can click somewhere on your map and the camera will instantly move there. It also changes the scroll wheel to move the Y axis grid up and down. You will do this often. If you use it temporarily to draw something up in the air, always remember to move the Y axis grid back to normal.

SHIFT+CTRL - While holding this, you can move the Y axis grid by pixels, instead of full squares. 

As a side note - there are some common OS buttons that can help speed up your work on some objects and menus. You don't have to control everything with the mouse. 

Arrow keys - These can change the option that is highlighted, like when looking at a list of code or events. Some fields allow you to press up or down to change the value, like choosing a number for a variable or time event. Usually these can also be changed by spinning your scroll wheel. 

Enter - On most windows it will choose/activate the option that is highlighted(although for some options it produces no result). The starting point differs based on what window you opened. There are times when you can press enter more quickly than moving your mouse cursor. 

*For example, when you open an object the OK button is highlighted. If you don't need to change anything on the object you can press enter and the window will close. It easy to dismiss it as only saving a small fraction of time compared to moving the mouse to the OK button, but when practiced this can save a lot of time in the long run. However, things are inconsistent across the editor right now so I find it hard to make full use of this. 

Escape - On some windows it will act like pressing the cancel button. It will close the window without saving any changes. 

Tab - Changes what option is highlighted. 

This is common with all Windows programs, so I don't know how it might be in all OS/versions. Pressing Tab allows you to cycle through all the available buttons, check boxes, and text fields in the current window. When it reaches the end it goes back to the first one. SHIFT+TAB cycles in reverse.

*Normally the fields are cycled in a natural sequence, but in RPM you will see the selection bouncing around the window out of sequence. Hopefully this will get organized in the future.

Spacebar - On some windows it will edit the option that is highlighted. This is commonly used when working on your code. You can right click a line of code and click edit, you can double click that line of code to jump into the edit window, or you can press spacebar to open what is highlighted. (Sometimes Enter will do the same thing)

These keys comes in handy when doing certain kinds of actions, especially mass changing some lines of code. 

-- Cursors
There are 2 different cursors you will see on your map.

 

The camera always follows the cursor on the left. You control it with keyboard controls. There are no scroll bars so this is the only real way to look around your map. You can't move it outside the boundaries of the map. 

The cursor on the right is the selector for the OBJECT Draw Type. A mouse click will place this cursor which used for things like pressing SPACEBAR, CTRL+C, CTRL+V, etc. 

-- Undo / Redo
You can use this common feature to rollback changes to your map. You can find it in the main menu, where it shows the keyboard shortcuts. 

Undo - CTRL + Z

Redo - CTRL + SHIFT + Z

This works for things like drawing/erasing any graphic, creating/deleting objects, writing in a text field, and probably more.

It doesn't work for everything so be careful. A few things that don't work are; changing editor options, creating/deleting maps and folders, creating/deleting lines of code. 

-- Save your changes
Don't forget to save often. 

*Caution - this engine is still in development and sometimes crashes. It gets more stable with each version and it's currently not too bad, but it can happen. 

To save your changes you can use the main menu or these shortcuts in the main toolbar:


Save: Save the changes only on the currently selected map.

All: Save the changes on all maps. 

When a map has been changed you will see a * after its name in the map tree:


When you are in a menu like SYSTEMS and you press OK, those changes are automatically saved. Even if you were to quit without saving, only map changes would be lost. If the engine crashes before you hit OK, you will lose those changes. I assume this works for most other menus.

Automatic Backups
A recent update introduced an automatic backup feature. Every 30 minutes it creates a backup of the important project files. It doesn't copy all the resources so each backup is only about 5mb.  

How to restore backups is not yet clear, but you probably just make a copy of the main project and drop the backup files in. 

-- Conclusion
It's a very simple layout and is easy to get used to. Drawing maps in 3D takes some getting used to, but everything is harder with a 3rd dimension. 

Resource management
-- Overview
This section will explain how to create, import, and manage all your resource files. 

-- Types of resources
There are many types of resource files used in RPM. You can see this by looking in the main resource folder for your project. 

You can navigate there manually or press the FOLDER button on the main toolbar. 


Then find your way to the Content folder. 


Don't use subfolders inside these default folders of your project, the editor will not see them. 

Datas 
This is for items that don't fit any other category and are mostly just data you won't normally touch. 

The folder itself contains .json files that make up the database of your project. There are some ways to manipulate this stuff but it's for advanced users. 

If something in your project gets corrupted you might be instructed to replace these files to fix it. It may allow transferring database info between projects, but it's unconfirmed territory. User beware and always make backup copies if you go messing around in here.

Maps - This is where your maps are stored. A folder is created for each one starting with MAP0001. It seems that deleting a map in the editor does not delete it's folder here. 

Saves - This is where save games are stored from playing the game. While working on your project and using test play, they will appear here as normal. When you use the built-in export function the save games will NOT go with it. 

Scripts - This is for advanced programmers. If you don't know what it does, don't touch it.

Fonts
This is for your fonts. Place them here and set them up in the database. 

Images
This is for all your graphics. It's separated into 2 categories:

HUD - These are used for drawing things on screen.

Animations - Battle effects like visual effects, weapons, and spells.

Bars - HP bars, etc. 

Facesets - Images to show alongside dialogue/messages.

GameOver - Full screen images to display on game over.

Icons - Small images to show inside messages or next to item names. 

Pictures - Images of any size to be drawn and manipulated on screen.

TitleScreen - Full screen images to display on the title screen.

WindowSkins - Used to make up all the windows drawn. 

Textures2D - These are used for mapping and objects.

Autotiles - Special tiles that change based on how they are drawn. 

Battlers - Used for all characters/targets in battle. 

Characters - Sprite sheets you attach to objects. 

Mountains - Images that make up the squares/slopes of mountain tiles. 

Objects3D - Pre-rendered models you attach to objects or place directly on maps. 

Particles - Images used for particle based functions, like weather effects (rain/snow).

SkyBoxes - Images used to make up the cube of SkyBoxes. 

Tilesets - Images used to draw tiles and objects on your maps.

Walls - Images that are used for the Wall draw type. 

Shapes
Used for something, probably. Needs more data. There are 3 folders here:

Collisions

MTL

OBJ

Songs
This is for all the audio of your game. 

BackgroundSounds - Repeating sound files.

MusicEffects - Non-repeating music files that pause the currently playing music. 

Musics - Repeating music files. 

Sounds - Non-repeating sound files. 

Styles
Used for something, probably. Needs more data. By default it contains a .css file.

Videos
This is for video files you can play in your game. 

-- How to import 
There are a few different ways depending on the type of resource. Here's how to add them in the editor:


There are individual windows for each type and they have 2 different appearances. You access them from this part of the main toolbar.

Pictures / Videos / Songs / Shapes / Fonts

These windows have 3 columns. On the left is where you start by choosing the subtype to work on. Sometimes there is only one to choose from. The middle columns shows what resources are imported and ready to use. The right column shows what files are on your computer and available to import from the project resource folder. The check box at the top must be enabled to see the right column.

If the item you want to import is not in the right column then you can press the + button to add a file from anywhere on your computer. The export button doesn't seem to work for me, so I'm not sure. I assume it's supposed to let you pull files out of the game. 

There are 2 buttons between the middle and right columns. 

The arrow moves an item from the right column into the middle column. You can also double click it for the same result.

The red X is to delete the highlighted item in the middle column. It has no effect on the right column. You can press the delete key to delete from either column. Deleting files from the right column will also delete them from project folder, so be careful.

When you place a resource in the middle column it's assigned the next available ID number and put at the bottom of the list. You can safely rearrange these. The blue icons are the default graphics, and red icons are for your custom imported resources. 

You can rename them if you want. That won't change the name of the actual file so it might be difficult to find the actual file later to match what you called it in the engine. Keep that in mind. This would be used if you change the file name, and want the engine to match.  

! IMPORTANT ! Make sure you remove a resource from the middle column if you plan to delete it from the project folder. Otherwise you will get an error when it tries to load it in game. 

When you add new files to the project folder directly while the engine is open, you may need to close and reopen any windows for it to refresh and see them. Some windows have a REFRESH button for this purpose. If you make direct changes to a file in an external program you will need to refresh to see it. Often switching between maps, opening a menu like DATAS/SYSTEMS, or saving the project should do this. 

Because there are multiple columns it's important to ensure you have the correct one highlighted when performing actions. You might go to pick an item and browse the right column, then press OK thinking that one is selected. But unless you select that item from the left column it won't be correct. 

Autotiles / Walls / 3D Objects / Mountains

These types have a more simplified window. It starts with the list on the left. Click the + or use SET MAX to increase the list and add more items. 

Give your new entry a name and use the TEXTURE field to choose the resource file. This window functions like above; move items from right to left then make sure you select the correct one from the left column. 

Each of these types use the same list concept, but have a few different options and will be explained later.

-- Resource properties
A common question about resources is: how do I arrange my graphics? Most programs use set values and templates for how they have to be arranged. While this is true for a few things in RPM, like the top line in a CHARACTER file is the object facing south, the size of the whole image is often up to you. 

Every resource is made up of frames. 


This is like a canvas where you paint your graphic. The player will only see 1 frame at a time. And you only have so much room. Is your sprite is too large to fit in the canvas? Make the canvas larger.


When you stack these together you get a whole resource file - ready to be placed in your project folder. The engine takes that whole file and cuts it into equal pieces based on your settings.


Generally the frames go from left to right. The leftmost one being what the player sees first and what is used when it's set to not animate. It also serves as the standing pose. When you stop moving it resets to frame 1. 

You can find most of the settings discussed in this chapter in SYSTEMS, on the SYSTEM tab. 


Map frame duration - This determines the speed of all animations outside of battle. This affects anything you might use on a map except for anything that has it's own duration setting. Numbers for duration are in milliseconds, so only make small changes to it. 

Animation frames - This determines how many frames for the resource files: Characters, (needs more data)

Battlers frames - This determines how many frames for the sprites used in battle, characters/targets. 

Battlers rows - This determines how many poses for the battle sprites. 

Autotiles frames - This will determine how many frames, but only for autotiles.

Autotiles frame duration - This will set the speed, but only for autotiles. 

So to create your resource - stack your variable sized canvas to a size that equals FRAMES x POSES. You decide the number of frames, but most of the resources don't let you choose how many poses. You will need to know the number for each type. You can look at the default resources(BR) as a reference, your other files already imported, or bookmark this page.

Let's look at the rules for each type:

Fonts
There are no real restrictions (that I've seen) but there are properties you should know about. 

The menus in and out of battle are drawn with fixed distances between words/numbers. So if your large font takes up all the space a lot of information will be cut off. 

One example is the stats. If you give the stats long names it pushes the numbers out of sight. You can minimize this by keeping things brief that show up in menus. Or just switch to a smaller font.

Certain fonts, like retro ones, don't look good below a certain size and it still leads to cut off information. Run your fonts through all the menus to test how they align.  

Animations
Frames - Fixed @ 5

Poses - Fixed @ 5

Canvas size - Infinite


This one doesn't have poses. Instead each frame is made available for the animation editor. You can use any size as long as it's in a 5x5 grid. 

If you need large and small images, set your canvas size to the larger one and use that for the small image. You might want to center small images in the frame. 

Bars
This is new and needs more data


Facesets
Frames - Infinite

Poses - Infinite

Canvas size - User defined


This one doesn't have poses. Instead each frame is made available when picking a faceset in the editor. You can add as many as you want, as long as they have the same canvas size. All facesets have to use the same size canvas, but you can put small images in and adjust it's position as needed. 

Or you can instead use the Show Picture command for facesets. That would allow animation. In fact, you can make the default message box transparent (with external image software) and use Show Picture for all messages, for maximum flexibility. (This can't be done for menus, just dialogue boxes)

You have some settings in SYSTEMS:


Default Dialog box options - Opens a window with the settings shown in the next image.

Facesets size - This is the canvas size of your frames. 

Faceset scaling width - Needs more data

Faceset scaling height - Needs more data


Position - Above or Below, determines if it shows on top of the message box or below. This might be used for large busts that go behind the message box. 

X - Offset the image left/right from it's default position.

Y - Offset the image up/down from it's default position.

That default position is on the left side of the message box. 

GameOver
Single file - No frames/poses

Any image is stretched to fit the current game window. 

The game runs at different resolutions between full screen and windowed mode, so this ensures the image always fits. 

Icons
Frames - Infinite

Poses - Infinite

Canvas - User defined



There are no poses. All icons are available when entering text in a Show Message command or creating items in DATAS. You can do single icons per file, group similar ones across a few files, or jam everything into one. You can find the setting for canvas size in SYSTEMS. 

Pictures
Single file - No frames/poses

These are all single images of any shape and size. (Well technically they are either square or rectangle)

TitleScreen
Single file - No frames/poses

Works the same as GameOver. If you use a video for the title screen, it freezes on the last frame of the video. So you can put your title screen image there and it will remain on screen after the video is done. 

WindowSkins
Needs more data


The idea is that you have a large file with all the menu elements, and then in the settings you choose the size (and placement?) of each individual element. So it takes some testing and coordination with the settings for this one. 

If you want to try, take a look at the default settings and tweak those values one by one to see the result. 

Autotiles
Needs more data

There are 2 kinds of autotiles. Normal static ones look like this:


Each color seen here (2x3 tiles each) will be displayed as a single tile in the editor. You can put more than one into a single file, but the specifics on sizes need more data.

They contain all the possible shapes to auto create paths and edges based on how you draw the tiles. It's best to try drawing with some of these to better understand how they get assembled. 

If you want to do animated tiles, arrange each file like this:


Like most other animating resources you will add frames from left to right. The whole 2x3 block is your "frame". This will show up as a single vertical line of tiles in the editor. 

In order for the animation to work you need to check the box for ANIMATE when picking it. 

Battlers
Frames - User defined

Poses - User defined

Canvas size - Infinite


You set the frames and number of poses in SYSTEMS, and canvas size is your choice. 

The editor calls the first pose number 0, and counts up from there. These default poses can't be changed but any new poses you add can be further defined in DATAS on the STATUS tab.

This one is for the Death status. What it does is change your sprite to pose 8 when inflicted with the Death status. 


The other poses are hardwired into the battle system to trigger when you do the following:

0 - Idle
1 - 
Need that data, it's around here somewhere. Stuff like attacking, using a skill, taking damage. 
8 - Dead

We use 8 even though it's the 9th pose of the whole file, because we start counting at 0. 

By creating a new status and assigning it a new pose(battle position), all you have to do is inflict the player with that status and the pose will change. However built in actions might override this. 

More data is needed on using extra poses. 

Characters
Frames - User defined

Poses - Locked @ 4 (Each direction)

Canvas - Infinite


You can add more frames in SYSTEMS by increasing the Animation Frames. The first pose is always facing SOUTH, and each subsequent pose turns clockwise. D, L, U, R.

The canvas size is up to you but you'll want to keep the sprites centered horizontally. The main body of the object should be in the center. If there is an uneven side, like holding a long sword, you should increase the canvas width on the opposite side to keep the body in the middle. This becomes important when working in 3D where you can turn the camera.

For a sprite to appear to be touching the ground it's bottom will need to rest at the bottom of the canvas. Raising it up will bring it off the ground. This is used for flying things and even jumping animations. 

You can use tileset tiles instead but they are limited. It can be helpful to take a tile from the tileset and make it into a character sheet.

Mountains
Unique file - No frames/poses

Canvas - Locked @ 48x48

Like autotiles these contain all the graphics needed to make shapes. You chose what kind of shape to draw and the engine wraps this around it like a texture.

There are 2 approaches to this:


You can create a single large 3x3 tile and let the engine cut it to pieces to fill your shape. 


Or you can copy a single tile 9 times to fill up the 3x3 tile. Now it will fill the shape only with that single tile. This is very useful for retro games. Slopes still create angles of overlap. 

! IMPORTANT ! You can't have a single pixel of transparency on these files. If you do, the entire thing appears transparent. Not sure if this is a bug or intended, but it might change in the future. 

Objects3D
Needs more data

You can make these with an external program or you can make an image with all the textures flattened out and the engine will fold it into a 3D object.


Particles
Single file - No frames/poses

An image of any size that is drawn on the screen in various ways. Right now this only applies to the weather affects. But you can add anything you want - like having it rain coins, comets, or cats and dogs. 

SkyBoxes
Unique file - No frames/poses

Canvas - Needs more data


The default ones are 256x256. You can make one image and use it for all 6 sides of the cube, or you can make the other images unique - even connected for full effect. 

It appears pretty far away, using average fixed camera angles, and you rarely see much of it connecting. Especially the bottom half of the cube. Do some tests with the camera angles of your game before spending much time making these, for better results. 

(I recall doing some testing and I could use some different sizes, but large images didn't work right. Needs data)

Tilesets
Single file - No frames/poses

Canvas - Infinite

An important factor here is your square size, found in SYSTEMS. Square = Tile. So all of your tiles on the tileset need to match this number. It's best to have it match your other graphics if you want things to line up. 

It doesn't have to be the same number. If your characters are 64x64 you can still use 16 or 32 as the tile size, but you'll need to draw multiple tiles to fit under the character. It might have other side effects as well, like making things appear disproportionally sized. It's best to sort this out early, run some tests, and try to avoid changing it in the middle of development. 

Walls
Unique file - No frames/poses

Canvas - Variable


These work very similar to mountains. In fact, when I make a mountain resource I drop a copy of it in the Walls folder. They share the same size and are cut up in a similar way to fill the length of the wall. 

The difference is that you can make these different sizes and they can have transparency. 


More data is needed on the canvas size limits. (I didn't know until I wrote this that walls could be a different size)

Shapes
Needs more data

Used in conjunction with 3D objects. 

Songs
All sub types found in this folder seem fine using the common file types. 

Confirmed working:

.wav

.mp3

.ogg

Videos
The engine seems fine using the common file types. Videos are anchored in the upper left corner. If they are too small the rest of the screen is filled with black color. If it's too large it will be cut off. 

Confirmed working:

.mp4

Most others, but I'll need to check my data to list them. There's about 4-5 others. 

The only hiccup is that not all file types will work in the preview box of the editor, but it still plays fine in the game. The only thing to note is that longer files take longer to load. 

Based on my testing there is no noticeable difference in load times or quality between different file types of the same length. Use whatever works best for your needs. Maybe you want to ensure it works in preview mode. Maybe you want the best compression, or the highest quality. 

-- Conclusion
That covers how to create and import all the types of resources currently available. One more reminder to always run tests on your resource sizes. Working in 3D adds a new layer of complexity on how things actually appear in the game that some users may not be used to. Your choice of camera angle will set the stage. 

The following chapters will go into more detail on configuring some of these resources. 


Tilesets & Collisions
-- Overview
This section will explain how to setup your tiles and the collisions that determine where objects can go within your maps. Along with some of the basics of how objects can interact with each other. 

-- Tilesets
A tileset is the file that contains all the individual tiles that are available to draw on each map. You can have as many tilesets as you want, but you can only select one tileset per map. The tileset your map uses can be changed with a command mid-game. 

The database entry allows you to set various properties of those tiles. You can use the same tileset for more than one entry and set different properties for each one. 

Tileset files must be placed in the project folder under /images/textures/tilesets.

Add a new tileset
Open the Data Manager and click the Tilesets tab



As with all data lists, click the + to create a new entry. 


Then click the Picture button to select your tileset file. 


Make sure the file you want to use is on the left side and that it is highlighted before clicking OK. 


Files on the right are in your project folder. If you don't see them, click the checkbox "Show available content".
Tileset Properties
Now that you have a new tileset entry, it's time to set it's properties. If you don't, the player will be able to walk over/through everything. 

- Battle Map
The Battle Map setting lets you choose which map/position is used by default when you allow random battles on the map (Located in the Map Properties>Battles tab).


These are created on the Systems>Battle Systems tab.
It's not required to set this option on the tileset. You can set it in the Map Properties as well. 

- Practicable 
This tab allows you to set collisions that will be applied only when the tile is used as a Sprite. This setting has no effect on floor tiles. 


Start by clicking on a tile to create a dotted square. Then you can resize the square by dragging the edges. Larger objects require you to click multiple tiles. 

You can right click and choose edit to use specific numbers for more accurate squares. 


To delete a square you can click on it to highlight it in purple, then press Delete on your keyboard. Or you can right click a square and choose Delete. 

- Directions 
This tab controls how an object can walk over a tile when it's used as a Floor tile. 


Each tile has 4 arrows that determine which side of the tile the player can walk through. 

An arrow means you CAN walk through that side. 

A square means you CAN'T.

You can click each individual arrow to make change. If you click the square in the middle it toggles each one. Arrows become squares and squares become arrows. 

Here are some common uses, with red lines indicating where you can't walk:


A tile that can only be entered from the north side

A tile that can't be walked on at all

A tile that only allows north-south

A tile that only allows east-west

- Terrain
This tab allows you to assign ID numbers to each tile which can be used in your code to identify what tile an object is standing on. This can have many uses like making the object slow down, take damage, or checking if they can jump onto that tile. 


Left click to increase the number and right click to decrease it.

To make use of Terrain ID, start by using the Set Variable command:


It will check which tile the object is standing on and write the Terrain ID into a variable. You can then use a Condition to decide what happens when a certain ID is found:


- Climbing
This tab lets you set a tile to be climbable when it's used as a Sprite. When enabled, an object that walks into it will automatically climb up one side and down the other. 


An O means it CAN be climbed.

An X means it CAN'T.

When the player first starts climbing, whatever direction they are holding will be "forward". Pressing the opposite direction will be "back", allowing them go back the way they came. 

When you reach the top, it has a small area that is treated as a floor tile. You can walk around normally until you touch an edge, then you will start to climb down whatever side you touch.

This is a new feature and can be a little buggy. Placement of your sprite is very important when used as a ladder. The top needs to be placed close to the edge of the floor tile for you to be able to transition from the top of the ladder to the higher ground. 

There is a setting that determines climbing speed on the Systems>System tab:


You can use a variable to adjust it mid-game
Some of these tabs allow you to change the zoom.


-- Other types
There are several other types of special tiles that can be placed on your maps. They each have their own drawing tool in the editor and method for importing. 

Currently all these are linked to the tileset. When you make a new tileset you will have to import them all over again to have them show up in the list. 

If you want to keep them, you can copy a tileset entry so it includes all these. However you will have to adjust all the Practicable, Direction, Terrain, and Climbable settings. 

Staring with version 3.0, these will no longer be linked to a tileset. So all of them will always be available, no matter which tileset you use. 

- Autotiles 
These are special floor tiles that will change shape when you draw the same tile next to it. It takes pieces of a few preset tiles to form continuous shapes. Often used for things like roads or water. 

Autotile files must be placed in the project folder under /images/textures/autotiles.


Here is an example of how the graphic file is laid out:


is this out of date?
The first square is used when you draw a single tile. Next to that is the square containing the pieces that will be used for corners. And below that are the squares used for long lines and inverse corners. The engine will use 1/4 or 1/2 of these tiles to create the whole shapes. 

To add a new one, click the Autotiles icon:


Click the + to add a new entry, then the texture button to choose the file for that entry:


On this screen, each Autotile is represented by a single square, which is how it will appear in the editor
When choosing a texture file you can have multiple Autotiles in a single file. It will look like this:


An animated Autotile has its frames organized from left to right, and will look like this:


You must check the box for "Animated" to designate an entire file as animated tiles. Therefore you can't mix animated and non-animated Autotiles in the same file. 

When you check the box for Animated it assumes all frames on the top row are for the same Autotile. All frames on that row will be grouped together. To add more Autotiles, they must be placed below and not to the side. 

The number of frames and speed of an Autotile is set in the Systems Manager:


Once you have imported all the files, you must add them to the list. First choose the Autotile drawing tool:


Then on the left, click on Update List:


This step may not be required after version 3.0
Move them to the left so they can be used:


- Walls
These are special sprites that can be drawn as vertical walls of any length. They can only be drawn in straight lines, from point A to point B.

Wall files must be placed in the project folder under /images/textures/walls.

Click the Walls icon to add new ones to the list:


Move them to the left side to make them available when using the Walls draw tool. 


You will see a white line indicating the starting point of the wall. 


Click and drag with the left mouse button to see your wall extend. Release the button to finish. 


If you do not create a straight line, the wall will disappear and show red lines. Meaning you can't draw it like that. Releasing the mouse button like this will cancel the attempt. 


To delete a wall, right click any part of the wall and drag your mouse. When you release, it will delete that section of the wall. 


- 3D Objects
These are special objects with more details and options available. They can be pre-made in external programs like Blender or made from wrapping an image texture around a box. 

3D Object files must be placed in the project folder under /images/textures/objects3D.

See the 3D Objects section for further information.

3D Objects

- Mountains
These are special textures that are used to form cubes or shapes of various size and shape. They are mainly used as mountain but can be used creatively for other purposes like stairs and doors. 

Mountain files must be placed in the project folder under /images/textures/mountains.

Click the Mountains icon to add them to the list:


Move them to the left side to make them available when using the Mountain draw tool.


Choose which texture you want to use, then adjust the Settings to select the size and shape.

These default settings create a cube that is 1 tile x 1 tile. The actual size in px depends on your system setting for Square Size. Mountain collision height and angle will affect how objects interact with them.


Adjust the Border Height to make a cube that is taller or shorter. You must increase the pixel setting before setting the square setting to 0. 

If the Border Height in px is equal to or lower than the Mountain collision height setting, the object will climb over it. 

For example, this mountain size will allow the player to walk on top of it because the Mountain collision height setting is currently on 4. 


1 square of the border height is equal to the square size setting. So using the defaults, you would need to set the Mountain collision height setting to 16 to allow objects to climb over a mountain with a border height of 1 square. 

When drawing mountains you can stack single cubes on top of each other, or change the border height. Each method will create a different looking mountain. 


By drawing the same texture next to it, the engine will combine them and create a continuous wall. It will not merge different textures. 


When you adjust the Border Width, it will change from a cube to a cube with angled sides. 


The Angle listed corresponds to the Mountain collision angle setting. If the angle is equal to or less than the setting, the player will be able to walk up the slope. 

Both of the Mountain collision settings can be variables and changed mid-game.

The engine doesn't offer single tile slopes yet, but you can create them by using border width and height of 1. Then placing cubes to cover the angled sides. 


You might want to make it 2 tiles wide for easy access
-- Collisions
Collisions control how objects interact with each other and the environment. When you import new resources they will not have a collision. YOU MUST ALWAYS set a collision for anything that should be solid, otherwise you may have bugs. Like your hero walking through walls. 

These bounding boxes are red and determine where an object can/can't walk. The above settings for tiles and characters use red ones. 

There is another type of box that is blue and is used for other interactions, like talking and attacking. The Send Event command uses blue ones. More on this below. 

Bounding boxes
A Bounding Box is a simple geometric shape that is used to check for an interaction between 2 objects. When you set a square collision, it is automatically turned into a cube that is placed around the sprite. 


A cylinder requires more processing, so cubes are used to increase performance
When an object with a collision moves, the engine will check if it's red bounding box touches another red bounding box and stop it from moving. This is why if there is no collision, it will walk through everything.

For object interactions, like getting hurt when you touch an enemy, the Send Event command is used to create a new collision/bounding box. Then you can choose what happens when that collides with something. More on this below.

To see the bounding boxes as you play, you can enable it from the editor. This can be useful for debugging or just to understand how things work.

Check the following option:



This can cause lag on low-end computers
When the camera is facing N, E, S, or W the red bounding box will appear as a diamond. 

When the camera is facing in between, like NE or SW, the red bounding box will appear as a square. 


Other boxes turn as well, but it can possibly change how 2 boxes interact
The different shapes will affect how your object moves in the game world. Floor tiles will be square and your hero is a diamond. So if even the tip of the diamond touches the floor tile, you won't be able to pass. 


The tip of the diamond extends below the visual appearance of the sprite, so it can take a while for players to adjust. They might think the collision is only the yellow line, but it also includes the red triangle. 

The edges of the bounding box determine when an interaction is triggered, not when they overlap. Assuming you have a tile size of 16 px, if your bounding box is 16 px tall you will not be able to walk under a 1 tile high space like this: 


Because the top edge of your box touches the bottom edge of the tile above and won't let you pass. You need to change the height of your box to 15 px to pass under. You may or may not want this behavior, it's your choice. 

Different shapes
Depending on which sprite you are using, bounding boxes can be various shapes:


Sprites
Fix sprites are flat. The player will be able to walk closer to them.

Other types of sprites will have a full diamond like the player. The player will have to walk further north/south in order to pass by.  


Floor tiles
Floor tiles that are set to block the hero, like the dark square, don't show a bounding box. However, you can imagine something like this flat red bounding box in it's place. In this scenario, the hero is unable to walk directly S or W because the tips of it's diamond are hitting the blocked floor tile. 

Autotiles work the same way as floor tiles.

Mountains have a few options:


The default is going to be the most common. This will make the collision match the size and shape of the mountain. 

Force Always (not sure, needs more specific data)

Force Never would be used to allow an object to pass through. One example, using a mountain tile as a door. 

Walls work similar to sprites, in that they will have Practicable and Climbable tabs. 

3D Objects have their own special options for collisions, however it is not fully implemented. There are 2 places to set collisions for these:

Collisions icon > 3D Objects tab


3D Objects
You are limited to NONE, or SIMPLIFIED. Which likely uses the basic shape/size of the object as it's collision. Needs more data. 

3D Objects icon


3D Objects
It provides the same options, just in a different place. Changing it in one place, also changes it in the other. 

-- How to set collisions
The best place to adjust your collisions will be the Collisions Manager since it combines all collision types in one place. This is the only place to set collisions for Characters, but all others have a second place to set them. 


It's good practice to set collisions when you import the graphics, like in the Tileset or Autotiles windows.  But if you need to adjust them later, Collisions will be your central location. 

- Characters
To set collisions for your characters, click the Collision icon and choose the Character tab. Remember this is the only place to set them and you must set them every time you import a new character that should have a collision. 

Since characters are animated, you can set a different collision for each frame. This would be useful for a character that drastically changes shape as it animates.

In general, it's easier to manage when all frames share the same collision. By checking the box for Repeat, all frames will use the collision from the first frame. 


The size and shape of this collision may vary, but generally you will make the width no larger than the square size. If it is larger, the object will not be able to pass through narrow spaces. Then you will have to tailor your maps to fit the larger collisions.


One way to get around this is to walk NE or NW into this passage, instead of trying to walk directly N through it 
If the player collision is exactly the size of 1 square, it can be difficult for the player to walk into those narrow spaces. Since they have to be perfectly aligned to do so. By shrinking the collision by 1 or 2 px, it makes that easier. Keep in mind that if you make it too small, the edges of your sprite will appear inside walls.

- Objects
Objects will use whatever collision is set for the sprite you choose.


This will apply the collision of that hero. If you choose no sprite, then it will have no red bounding box to block other objects. However, it can still be interacted with using blue bounding boxes like those used by the Hero Action event. 

- Send Events
The Send Event command is used to create special bounding boxes that allow you to create a wide range of actions. This lets you choose the size and shape of the box along with the action that is triggered when it interacts with another object. 

This is one of the most useful commands available in RPM. 

The first step to using this command is to make a Detection in the Systems Manager:


You can make a bounding box that will be placed at the location of the object that runs the Send Event command. The size and shape will depend on what you want to do, so how you complete this step will vary. 


The arrow indicates the object that runs the command, so you can position as needed (in front, behind, to the side, etc). Let's look at the Hero Action example. This will be programmed into your Hero model by default in your new project. 

You can find it in Systems > Model tab > Hero > Keypress [Action] Event:


Under Target, by choosing a Detection ID, you can select the bounding box you want to appear. This action uses "Front". 

Under Event, you choose what Event will be triggered if another object it is hit by the bounding box. This action uses "Hero Action".

When you press the Accept button, this small bounding box appears in front of the hero. 


On it's own this does nothing. If you walk up to this empty sign object and talk to it, nothing happens. 

The most important part of this equation is the Event on the object that this bounding box touches. By adding a Hero Action Event, you have a place to put code that will run when the Hero Action bounding box touches it. 


Now if you talk to the sign, it will display a message. This is the most basic example that most users might already be somewhat familiar with. 

This command will be explained further in it's own section.

There is also a Detection option in the bottom of the object window:


This will act like a Send Event command running on repeat, however the specific details on how it works will require more data. 

-- Conclusion
These settings are some of the most important ones in creating a functional game world. How you set them up will depend on the size and shape of your resources. Do some testing early on to figure out the best settings before you start making a lot of maps to avoid unexpected behavior later on. 

Variables & Conditions
-- Overview
This section will explain the important commands that store and make use of data throughout your game. These are required in even the most simple games. 

--Variables
Simply put, a variable is a place to store data that you can edit and read throughout your game. There are also Parameters and Properties which function a lot like variables, with different attributes and scope. Those will be explained below.

There are 3 types of data you can store and even more ways to make use of them. 

Data Types
Paper Maker allows the following types of data:

Number - Both positive and negative. 

Switch - ON or OFF.

Message - A string of alphanumeric text. 


The circle/dot to the left of each field is called a Radio Button
When writing data into a variable, you can choose the type of data you want to store by selecting one of the above highlighted fields. All other options look at existing data in the database and write that into the variable as a number. 

Entering Data
There are many different reasons for writing data into a variable. One common use is Hero HP. The variable contains a value for how much HP the Hero has left. Every time you get hit, something is subtracted from that variable. At any point you can check what the value is, to see how much HP is remaining. 

Let's look at each option available when writing data into a variable.

- Selection

First you choose which variable you want to write into. Click the ... button choose a single variable, or use the Range option to write the same data into a group of variables. 


On the left you have pages that can be used to help organize your variables. You can rename the pages to things like "Hero Stats" or "Quest Progress". 

It's good practice to group similar variables together instead of simply using the next available space whenever you need a variable. If you are working on something new, skip ahead and make a new page. That way you have space to add similar variables to the same page later on. 

As with other database lists, you can rearrange the order of these pages by drag and drop. The variable ID numbers won't change and you can further organize your variables.

Click the page on the left, so that on the right you can choose one of the variables to use for this operation. 

It is good practice to always name your variables to fit the usage. Hero HP, Time Remaining, etc. You want to be descriptive without making it too long, so that you can easily read it all in your code. 


 Protip: By writing some words all in CAPS, it helps them stand out in a full list of variables.  


- Operation

Next you choose what kind of operation this will be. 

Equals - Overwrite the old value with the new one.

Plus - Add the new value to the variable. 

Minus - Subtract the new value from the variable. 

Times - Multiply the variable by the new value. 

Divided by - Divide the variable by the new value. 

Modulo - Divide the variable by the new value, then get rid of the remainder. *

Equals works for all data types.

Plus \ Minus works for Number and Message.

The rest only work for Number.

*This function, a.k.a. Mod, might not be familiar to most people but it can be useful. It divides a number by the value entered, and only gives you the remainder. 

Let's say you have 10 divide by 3. You will end up with 3.333. 

If you instead use 10 mod 3, you will end up with 1. Because 3 fits into 10 three times, which is a total of 9. The remainder is 1.

One possible use for this is to remove decimal points. If you have a variable with a value of 3.333, start by making a copy of it. Do Mod 1 to the copy, which results in 0.333. Then subtract the copy from the original. 3.333 - 0.333 = 3. There are other ways to do this with javascript, but this method can be done with default commands and some math. 

- Value
There are many options in this category. 

-- Number

Some fields allow decimals
The most commonly used option. The drop down menu gives you the following choices:

Number - Choose a number to be used in the operation. 

Variable - Uses the value of the selected variable in the operation. 

-- Random

Set the range and the engine will pick a number at random between the two values. 

-- Message

Enter some text to be written into the variable. You can use the ADD operation and it will include the new text to the right of the existing message. Remember to add spaces and punctuation when required. 

-- Switch

Choose the new state of the switch - ON or OFF.

-- Inventory

Checks how many of a certain item the player is holding and writes that number into a variable. 

There is a drop down menu here that gives the following options:

Selection - Allows you to choose the item directly from a drop down menu.

Number - Allows you to choose a number, which corresponds with the ID of an item in the database. You can see HP potion has an ID of 1.

Variable - Allows you to use the value of a variable to choose the ID of the item that is checked. 

-- Currency

The first drop down menu lets you get a number for:

Owned - How much of the currency you have right now. 

Earned - How much you received since starting the game. Owned + Used. 

Used - How much you spent in stores or had taken away with commands. 

The last drop down menu has you choosing which currency to check, if your game uses more than one.

-- Statistic

Get the value of a statistic of a Hero or Enemy. Knowing the ID can be difficult. IDs are assigned in sequence as a Hero or Enemy is encountered. Unless your game is extremely linear, there is no direct way to know this unless you manually keep track with variables. 

For Heroes, a simple method is to add all the heroes to your party at the start of a New Game. This will secure their IDs starting with 0. Then you can change some of them to be HIDDEN with the Modify Party command, so they are not available to the player. When you want to give them back to the player, move them from HIDDEN to TEAM/RESERVE. This doesn't work if an unlimited number of heroes could be added, such as a Pokemon clone. The other choice is to keep track with variables as the heroes are added.

For Enemies, there is an option below that can provide it's ID but it only works inside a troop reactions. You could also keep track with variables. 

-- Map Characteristic

Allows you to find various map related information about an object. 

The drop down allows you to choose This Object, which will be the object that runs this command. The Hero is an available option, too. Followed by a list of all objects on the current map. It's not possible to target objects in a different map.

If you use Number in the first drop down menu, you can then make sure a certain object always has the same Object ID in each map. That way you can refer to it by number in your code and it you know it will target the correct object. 

The last drop down menu gives the following choices:

X, Y, and Z square position - This corresponds to the values you see in the editor. 0, 0, 0 is in the NW corner of the map at ground level. Squares will often be more useful, since commands like Move Object and Teleport Object will be measured in squares. 


Square = Tile
X, Y, and Z pixel position - This will depend on your square size. If your square size is 16 px, then a square position of 4 will be a pixel position of 4 x 16 = 64 px. 

Orientation - This gives you what direction the object is facing. It corresponds with the character sheet resources. 


Terrain - This gives you the Terrain ID of the tile below the object. 

-- Enemy

If you try to use this option outside of a troop reaction, the drop down list will be empty. As the enemies available will change with each battle. When used inside a troop reaction you will be given a list of the monsters in the troop. 


Once you have it's ID, you can then use other commands that target an object by it's ID such as Change Statistic and Transform Battler. 

The only limit is that you have no command to know which enemy the player is currently targeting.  

-- Other Characteristics
Here you can find various game information. 

Current Map ID - The map the hero is currently on. You can see ID in the Map Properties.


Number in Team - Gives the number of heroes currently in your party. 

Number in Hidden - Gives the number of heroes currently hidden from your party. 

Number in Reserve - Gives the number of heroes currently placed in reserve. 

Total number of steps - Keeps track of the number of steps walked by the player during the entire game. 1 tile is about 3-4 steps. 

Total number of seconds - Keeps track of total playtime.

Total number of saves - Keeps track of how many times you save the game. 

Total number of battles - Keeps track of how many battles the player has entered.

Camera Position X, Y, and Z - Gives a number for the current Camera position in pixels.

Total Second of Music - Tells you how long the current "Music" song has been playing. 

Total Second of Background Music - Tells you how long the current "Background Music" song has been playing. 


The wording is inconsistent, but Background Sound and Background Music are the same thing
Specific usage of all these options will be explained further in later sections. 

Parameters & Properties
Along with Variables, you also have Parameters and Properties. All of them hold data but have different ways of making use of it. 

- Variables
Variables are simple to use and global, meaning they can be accessed by all objects and reactions no matter where you place the code. 

To create a variable, click the Variables icon or open the Change Variables command:


The rest is explained above
- Parameters
Parameters work like variables, but are only available to the area they were created on (Events or Common Reactions). A parameter made in one area is not available to the other. 

There are 2 areas that have parameters.

Systems Manager > Event/States tab:


Double left click or right click the "< >" to create a new entry.

Then you will see it appear in the settings for your Event:


To change a parameter, you have to edit the value from Default to something else. 

The commands activated during this event will be using the new value for that parameter. 

Systems Manager > Common Reaction tab. 


That list will be separate and only show up when calling a Common Reaction.


Your common reaction would then reference the new parameter values in it's commands. 


There is no command to alter a parameter mid-game. You would have to use a variable/property as the value. Then you can change the variable to change the parameter. 


For some usage it can save you from having to create a variable, keeping your list of variables from getting bloated. Some of the other data types can be useful like Anything, None, or Keyboard, but that will be very specific and suited for advanced users. 

- Properties
Properties are local, meaning they can only be accessed by the object they are created on. That also means any conditions that want to read the value have to be on the same object. 

To create a property, open an object and create a new entry in the Properties box.


Double left click or right click to create a new entry. 
These are useful because you can have the same property on multiple objects and each one will store it's own value. Any commands using the property have to be on the object itself. This allows you to copy and paste completed objects and they will all function independently. 

For example you can give an object a HP property and every time the player attacks it, 1 is subtracted from it's HP. It has no effect on the HP property of other objects. You can't use external objects to check a property, it has to be check on itself. 

 You can make a property be a variable, write a property into a variable and use/edit that value, or write any existing variable into a property.

Another example is to create a space for commands that can only happen the first time it is activated. Such as keeping track of when an NPC has been talked to and having it say something extra the first time you talk to it. 


You can copy and paste this NPC and simply update the text. Each one will keep track of it's own property and only allow the condition to run once per NPC.

Most commands can reference variables, parameters, or properties. They won't show up in this list until they are created.  


Default Values
There are different defaults for the various types of data. 

Variables automatically start at 0.

Parameters ask you to choose the default value.

Properties ask you to choose the default value.

If you choose a certain type of data as the default, any type of data can be accepted and it becomes that data type moving forward. 

-- Conditions
Variables alone won't accomplish much. Aside from plugging variables into commands, conditions will check a variable and run some code based on the value inside. Let's refer to them as IF statements and you can think of them logically. 

IF the variable is equal to 0, THEN do X.
IF the variable is equal to 1, THEN do Y.
IF the variable is equal to 2, THEN do Z.

You have the option to add an ELSE statement, which decides what happens when the IF part isn't true. 

IF the variable is greater than 0, THEN do X. ELSE, do Y. 

If the value is 1 or more it will do one action, if it's less it will do something else. When to use ELSE will depend on what you are trying to accomplish. Usually you will only use ELSE when there are only 2 possible outcomes. If there are more than 2 outcomes, you might want to use multiple conditions with the ELSE part disabled.  

Check the box at the bottom of the condition window to enable ELSE. 



There will be many times where you only need the IF statement. It is good practice to disable the ELSE statement instead of leaving it empty. 

When using Conditions you start by choosing a type of data to look at. Most of them have different criteria. 

Variables / Parameters / Properties
This section will likely be the most commonly used. You will be using many variables to keep track of things in your game. Tracking hero actions, by increasing one as you swing a sword. Quest progress, by increasing one each time you talk to the next NPC or complete an action. All switches/messages are essentially variables.

If you don't have any parameters or properties set up, you will only have the option to choose a variable. 


Once they are added you will be able to select them from the drop down menu. 


When using these you will have the following standard mathematical options:

Equal to

Not Equal to

Greater Than or Equal to

Less Than or Equal to

Greater Than

Less Than

The final field is what you are comparing to. Generally, it should match the type of data that is inside the var/param/prop. If you write Switch:ON into a variable, you might want to compare it to another Switch data type. Not all cross combinations of types might work. 

For simple IF statements you will mostly be using a static number, like 4. But for complex and dynamic systems you will start comparing it to another var/param/prop. This will be explored in more detail later on. 

Heroes
This section contains many types of data related to your heroes, each with different criteria to check against. Not just math options like greater than. 

You start by choosing the target.


This will apply to all heroes, unless you check the optional box below that will choose which group of heroes to look at. You might want this to affect only your active party. 

The rest of the commands are self explanatory.


Possessions
This section is for checking what items the hero possesses, both in the inventory or equipped on the heroes. These only use math options like greater than and it's all self explanatory. 


Other
This section contains all other types of data that don't fit into the previous categories.

Keypress - Check if a key is or isn't being pressed. Set this to Switch:ON to know when the key is being pressed. The engine is always keeping track of these values automatically.


Object is looking at - Check which direction an object is facing. It's represented by a number starting at 0, counting up clockwise from south. The engine is always generating this value automatically.


Object is climbing - Check if an object is currently in it's climbing animation. Only works for tiles you enable climbing on in Data>Tileset.


Chronometer - Checks the value of an existing chronometer (timer). You must first use the Chronometer command to start one. Here you choose it's matching ID to monitor it and run code when it reaches a certain time. 


Escaped last battle - An internal switch is turned ON if you escape your most recent battle and this will check if it's currently ON. You might disable the bonus of a new battle if you ran away from the last one. 


Script - Check something using javacsript. 


Variable Substitution
In most of your commands you will have an option to pick a number or use a variable. By using a variable you can edit the variable elsewhere to change the outcome of it's usage. 

Here are some examples. 

Making a choice
You might give the player a choice of which hero to heal. 

Your team has 4 heroes with the IDs 1,2,3 and 4. You can use a show choice command with a variable set to a different value in each choice. 


You can use that variable to refer to whichever hero was picked by the player. 


Which one to check?
To check a single hero you could set a variable to a static number and reference the variable in the condition. 


You might want to check all 4 heroes for that Battle Sword. You could make 4 conditions, 1 for each hero. Or you could increment the variable and loop the code. As long as your hero's IDs are in sequence.


Sets the variable to the first hero in the sequence.

The condition checks the first hero for the sword.

If it's found, a message indicates who had it, then it's replaced with Empty (same as unequipping).

It increments the variable, so that it now points to the second hero.

It increments another variable, so that we can keep track of how many times the loop runs.

We have to check 4 heroes, so if the count is below 4 it needs to keep looping. So it jumps to the TOP.

It runs the same condition a second time, this time with the variable set to 2. So it checks the second hero for the sword.

It repeats this for each hero and when the count reaches 4 it stops looping and finishes.

 

The possibilities are endless. Keep in mind that the field a variable is replacing determines it's usage. Some fields ask for a new number value, which hero to choose, which skill to forget, etc. Using a variable is often the same as entering a static number/choice. Whatever the default usage is. 

-- Conclusion
How complex you make use of these is up to you. For those just learning, start simple and slowly work your way up to complex. Good external note taking can help you keep track of everything, especially when you need to look at your code after a long time has passed.  

Objects & Events
You know how to create beautiful maps, but you want to make it be alive by adding NPCs, treasures, etc. These elements are called objects. These objects will also react to events (hero action, chronometer, attack, etc.). Objects and events are here to galvanize your maps and create your game stories!

Events
/! Events in RPG Paper Maker are a different notion than in RM classic series.

You can access to events in Systems manager > Events / States.


Events represent the fact that something important just happened and the objects in the map can react or not to it. An event can be for example the fact that your hero pressed the action button, or even the fact that a rain tempest just started. These events are sent to objects by other objects. There are two types of events:

System events (time, keyboard pressure, etc.) that are not sent by objects in the map, but by the game system itself.

User events (quest completed, sword hit) that you can be created by yourself and sent thanks to local objects.

An event also takes some parameters. For example, if you want to play a sound each three seconds in the background, you can use the time event with the parameter time = 3000 (milliseconds) and repeat = ON. Imagine such amazing things you can do with parameters (a sword hit event taking a power parameter for example). You can choose the default value of a parameter when editing parameters of an event.

/! Don't confuse physics and events. You should not use events for wind animations or gravity, etc.

Reactions
Reactions are a tree of commands that will be executed one by one. For example a command can be to display text on screen or to move specific objects in the map. Here is an example of reaction:


This reaction will check if the variable myValue is equal to 2. If it's OK, this will display the message "It's OK!". If not, this will display the message "Go back later.".

To edit / add a new command in a reaction, Double click on a corresponding node. This will open this window containing a large list of commands:


We will see later all these commands details one by one.

There is also a way to find your commands faster with keyboard search:


You can also copy / paste / delete by Right-clicking on the corresponding command node.

Common reactions
If you see that you are often copying the same set of commands a lot of time maybe you should consider creating a common reaction. You can access to these in Systems manager > Common reactions.


This way you will be able to call this common reaction instead of always copying it. It's even taking parameters if you have some variations in your reaction.

Block hero when reaction: If checked, the hero will not be able to move until the reaction is finished.

Objects
An object is something that can move or/and react to some events in a map. So basically a tree is not an object (except if you can cut it so it would have a reaction to an axe hit) but only a static element. It can be a NPC, a monster, or anything else. Note that your hero is an object itself so you can perfectly program its reactions.

To add an object in a map, select the Object map editor section. Point on a map square and Double click or press Enter after clicking on the square. This will open a new window.


Name: Choose a name for your objects. This can help later if you want to execute actions on this object externally.

Only one event per frame: We will see what are events, if checked the object will have only one reaction per frame and not several in the same time.

Model: Choose a model for this object. We will see later how to configure models.

Events
You can configure which event the object can react to in the Events section. Double click on a node:


You can select if you want a user or system event and change parameters value:


System events are the following:

Time: Event sent when time interval is cleared.

Interval (default: 0): Time to wait in milliseconds.

Repeat (default: ON): Send the event after each interval or once.

Chronometer: Not available yet.

KeyPress: Event sent when pressing a key on keyboard.

ID (default: anything): The ID of the key.

Repeat (default: OFF): If ON, this event will be sent as long as you press the key with a small offset at the first pressure.

Immediate repeat (default: OFF): If ON, this event will be sent as long as you press the key without any offset.

KeyRelease: Event sent when releasing a key on keyboard.

ID (default: anything): The ID of the key.

MouseDown: Event sent when the mouse is pressed down.

X (default: 0) : Mouse X position when event is triggered.

Y (default: 0) : Mouse Y position when event is triggered.

Left (default: ON): If ON, this event will be sent only if it's from mouse left click.

MouseUp: Event sent when the mouse is up.

X (default: 0) : Mouse X position when event is triggered.

Y (default: 0) : Mouse Y position when event is triggered.

Left (default: ON): If ON, this event will be sent only if it's from mouse left click.

MouseMove: Event sent when the mouse is moved.

X (default: 0) : Mouse X position when event is triggered.

Y (default: 0) : Mouse Y position when event is triggered

States
An object has a set of States. For exampleero can be in a normal state, or poisoned / vulnerable. Note that an object can be in several states at the same time.

You can add a new state on this list. There also is a Update complete list... button if you want to create new common states.


For each state, you have to choose different reactions to specific events. You can copy / paste reactions through states by using Copy reaction and Paste reaction buttons. These different options are also available for each state:


Graphics: Select the object graphics here (character picture). Choose below the kind of element (Sprite etc.).

Moving: Options linked to the object moves when there is no reaction.

Type: The type of moving.

Fix: The object will not move at all.

Random: The object will move randomly in the map.

Route: The object will loop on a route that you can edit with the Edit route... button. Check out move object command documentation here that is exactly the same.

NOTE: You can edit speed and frequency list in Systems manager > System:

Speed: The speed value when the object is moving. This value is multiplied with the traveled distance with equal time. This also is multiplying the frame duration. Default value is 1.

Freq: The frequency value when the object is moving. This value is changing the time in second(s) to wait before executing the next move. Default value is 0 (second(s)).



Name: The name of the speed / frequency.

Value: The value of the speed / frequency (can only be a number).

Move animation: If checked, all the frames of the character will be drawn for move animation. If not, this will only draw the first frame of the character animation.

Stop animation: If checked, all the frames of the character will be drawn for stopped animation. If not, this will only draw the first frame of the character animation.

Climb animation: (not available yet) If checked, all the frames of the character will be drawn for climbing animation. If not, this will only draw the first frame of the character animation.

Direction fix: If checked, the graphics will not change direction to look at the hero. If not, it will look at the hero.

Set with camera: If checked, the graphics will update orientation according to the camera orientation. If not, the camera orientation changes nothing.

Pixel offset: If checked, the move animation will go 1px down after two frames. This adds an interesting effect.

Keep position: If checked, the object always keep its position after moving, even after loading save or changing map. If not, the object position is reinitialized after loading save or changing map.

Detection: A detection to select for sending an event each frames.

Properties
The object also has a set of properties. It can be HPs, age, gender, etc. It all depends on what you need and your type of game.


Name: The property name.

Initial value: The initial value of the property when the object is loaded for the first time.

Example: create a chest
Here is a simple way to produce a chest:

Be sure to have a state for the chest in the systems manager when it is opened:


Complete reactions for each state and don't forget to replace state at the end of the normal state:



Edit / Copy / Paste / Delete an existing object
You can open a context menu by Right clicking on an object:


Models
Models are objects that can be commonly used. You can have models list in Systems manager > Models.


For example, if you want to add flowers that can be picked in your maps, you can create a model "Flower", and use this model for an empty object in your map:

Create model:


Use model flower for a map object:


Default model
The model with ID 1 is the default model when you create a new object. You can change here the default information to have in an object creation.

Hero model
The hero is also an object and reacts to a lot of systems events:

KeyPress > Up, Down, Left, Right Hero: Move the object hero to the pressed directions thanks to move object command.

KeyPress > Left, Right Camera: Change the camera orientation thanks to move camera command.

KeyPress > Action: Send the custom event HeroAction to the facing square objects thanks to the send event command.

KeyPress > MainMenu: Open the main menu thanks to the open main menu command.

Inheritance
If an object uses a model but also has content, this new content will replace some of the model content. Models themselves can have models.

State: If there is a state with the same ID, the model reactions for this state ID will be replaced by the current content.

Property: If there is a property with the same name, the model reactions for this property name will be replaced by the current content.

Event: This has no influence.

Map startup reactions
In map properties, you can see this section:


This simply is an invisible object that will be useful for kinematics when entering a new map, for example. This is invisible, so there are no state graphics. By default, it is reacting to the event Time with 0 for interval parameter and OFF for repeat parameter. That means that these reactions will be executed in high priority when entering the map. This can be used for kinematics and some other stuff.

Detections
It is important to use detection with objects. In fact, you are already using it when you react to Hero Action event. Hero Action event is an event that is sent by the hero itself to the objects that are in front of him. In order to determine where the events are sent, we use what we call detection.

You can access to detection list in Systems manager > System:


And here is the front detection! You clearly see here that your event can be sent in front. There is an arrow indicating the square position of the object sending the event, and also the orientation. You can add detection boxes by using left click and right click to delete existing detection boxes.

Name: The detection name.

Field: The detection field that you can increase/decrease.

Left: Number of squares on the left side of the object sending the event.

Right: Number of squares on the right side of the object sending the event.

Top: Number of squares on the top side of the object sending the event.

Bot: Number of squares on the bot side of the object sending the event.

New box length/width/height: The height that will be applied on the next boxes.

Square(s): Number of squares for detection box length/width/height.

Pixel(s): Number of pixels in addition for detection box length/width/height.

Automatic: A way to automatically generate detection boxes adding.

Circle: Draw a circle with given radius.

Rectangle: Draw a rectangle with given length and width.

Generate: Clicking on this button will generate the selected form and options.

3D Objects
You can manage the 3D objects list by clicking here on the main toolbar:


The options for your 3D objects are different according to the shape you choose.

Box: A simple box.

Texture: The box texture. Box textures have a specific template. You can check it at any time in the Basic Ressource:

Screenshot

Collisions: Choose the kind of collision you want to have with that box.

None: No collision.

Perfect: Perfect collision with the box faces.

Size: The size of the box. You can choose by number of squares and additionnal pixels.

Width: The box width.

Height: The box height.

Depth: The box depth.

Texture: Select the texture application kind:

Stretch: Stretch your texture. You can use it if you follow the template with a different size that doesn't take account of size proportions.

Perfect size: Use it if you want to always respect pixels proportions. See the cupboard example which is 2x2x1 size:


Sphere (not available yet)

Cylinder (not available yet)

Cone (not available yet)

Capsule (not available yet)

Custom: Import your own 3D objects models (with .obj).

Object: Select your associated .obj.

MTL (not available yet)

Texture: Choose the texture corresponding to the object UVs mapping.

Collisions: Choose the kind of collision you want to have with that custom object.

None: No collision.

Simplified: Simplified bounding box collision for the object. The collision will represent a single box which is the smallest possible that can contains all the 3D object vertices.

Scale: The scale size to multiply with. By default, the value is 1.0 so the multiplying has no effect on the 3D object size.

Don't forget to add your objects in the tileset:


(or use the texture selector)

Event commands list
An overview about event command

Now that you are a pro for objects and event, you can have here a description of ALL the possible event commands. If there's a command or an option that you don't understand, you can go back here and search for a description.

Show text

Displays a text in a dialog box with the current dialog box options.

Interlocutor: This will display a text inside a small box on top of the text box for indicating the interlocutor's name. If empty, this will not show the box.

Faceset: The faceset to display inside the dialog box on the left.

Message:

 : Apply bold effect on the selected text.

 : Apply italic effect on the selected text.

 : Apply left align effect on the selected text.

 : Apply center align effect on the selected text.

 : Apply right align effect on the selected text.

Font size: Apply the selected font size on the selected text.

Font name: Apply the selected font name on the selected text.

Text color: Apply the selected text color on the selected text.

Back color: Apply the selected back color on the selected text.

Outline color: Apply the selected outline color on the selected text.

Variable: Display the value of the current selected variable.

Parameter: Display the value of the current selected parameter.

Property: Display the value of the current selected property.

Hero name: Display the name of the selected hero instance ID.

Icon: Display the selected icon.

Render in game:


Display a choice

Choices: The list of choices texts.

Options:

Cancel auto index: The choice index to select when pressing cancel button.

Using adapted show text command:



Using without show text command before:



Input number

Display spinboxes so the player can choose a number. Like Display a choice command, you can have a Show Text command before it so you have the text box and input number in the same time.

Stock value in variable ID: The variable ID where the entered number will be stocked

Digits: The number of digits for the number

Render in game:


Set dialog box options

Set all the dialog box options.

Window skin ID: The window skin ID to display.

Transform:

X: The x position of the window.

Y: The y position of the window.

Width: The width of the window.

Height: The height of the window.

Padding:

Left: The left padding of the window.

Top: The top padding of the window.

Right: The right padding of the window.

Bottom: The bottom padding of the window.

Faceset:

Position: The position of the faceset. You can choose if it's behind or above the window.

X: The additional x position of the faceset.

Y: The additional y position of the faceset.

Text:

Outline: Select if texts should have outlines.

Color ID:

Text: The color ID to use for texts.

Outline: The color ID to use for outlines.

Background: The color ID to use for backgrounds.

Size ID: The size ID to use for texts.

Font ID: The font ID to use for texts.

Change screen tone

Change the screen tone (dominant color). The RGB color (0, 0, 0) changes nothing on the screen tone.

Red: The red dominant color.

Green: The green dominant color.

Blue: The blue dominant color.

Grey: The grey dominant color (saturation). If grey = 0, then no changes. If grey = 100, then the screen will only have grey colors.

Adding color ID: You can combine the previous color with an existing color.

Wait the end of the change before the next command: If checked, the command will end only after Time number.

Time: Time to wait for changing the screen tone.

Shake screen

This is useful for staging your cinematics by simulating earthquakes, for example.

Offset: The number of pixel offset for each shake.

Shake number: The number of shakes per second.

Wait the end of the move before the next command: If checked, the next command will be executed when the shakes ends.

Time: Duration of the total shakes.

Flash screen

This will simply fill your screen with a color and linearly go back to normal screen color.

Color ID: The color ID to display on screen.

Wait the end of the move before the next command: If checked, the next command will be executed when the flash ends.

Time: Duration of the flash.

Change weather

Change the current map weather by adding particles.

None: Remove current map weather.

Custom: Add a custom map weater.

Options:

Texture: The weather particle texture.

Color ID

Image

Number per portion: Number of particles in each portion (16x16 squares)

Ray portions: Number of portions (16x16 squares) ray around the camera to display particles.

Size: The particles size (texture).

dephTest: https://threejs.org/docs/#api/en/materials/Material.depthTest

depthWrite: https://threejs.org/docs/#api/en/materials/Material.depthWrite

Initial velcity: The initial velocity of the particle when it's created.

Velocity addition: Velocity addition after each frame.

Initial Y rotation: The initial Y rotation around the portion.

Y rotation addition: Y rotation addition after each frame.

Wait the end of the move before next comand: Wait the end of the time before running next command if checked.

Time: Time (in seconds) to make the weather transition. There will be more and more particles appearing.

Change map properties

Change some of a map properties.

Map ID: The map ID that you want to change

Properties:

Tileset ID

Music

Background sound

Camera properties ID

Sky

Color ID

Skybox ID

Wait

Wait during a specific time.

Time: Time to wait in seconds.

Change chronometer


Start, pause, continue, or stop a chronometer. 

If you choose to start a new chronometer:

Stock chronometer ID in variable ID: The variable ID where you want to stock this new chronometer ID

Time: The time count for this new chronometer

Display on screen: If checked, display the chronometer on screen

If you choose to pause, continue, or stop an existing chronometer:

Chronometer ID: The existing chronometer ID to edit

Stock current chronometer value in variable ID: Stock the current value (in seconds) in the variable ID.

Teleport object

This will teleport an object on an existing map with a new position.

Object ID: The object ID to teleport.

Position:

Select...: Choose map and position thanks to a map previewer.

ID map, X, Y, Y plus, Z: Choose map ID an position to go manually.

Object (ID): Choose an object to teleport on.

Transition:

Direction: Select the direction of the object after teleportation

Start / End: Start / End type of transition:

None: Immediate transition.

Fade in / out: Transition on a color.

Zoom in / out: Transition by zooming in / out.

Move object

This will move an object in the current map with a specific route. You can also temporary change some properties linked to the object state.

Object ID: The object ID to move.

Ignore if impossible: If checked, the moves that can't be executed (example: a wall blocking the route) would be ignored. If not checked, this will try the impossible move as long as it become possible (example: use for NPCs moving).

Wait the end of moves: If checked, the command would end only when all the moves are executed. If not, the command would end immediately (moves executed in parallel).

With camera orientation: If checked, the direction moves (north, south, west, east) would take account of the camera orientation. If not, the direction moves would not take account of the camera orientation.

Step / square moves:

Square: Change all the direction moves unit to square.

Step: Change all the direction moves unit to step.

1 to North / South / West / East / North-West / North-East / South-West / South-East: Move the object to 1 square / step in the selected direction.

1 to random: Move the object to 1 square / step in a random direction.

1 to the hero: Move the object to 1 square / step in the hero direction.

1 opposite to the hero: Move the object to 1 square / step in the opposite of the hero direction.

1 in front: Move the object to 1 square / step in front.

1 back: Move the object to 1 square / step back.

Jump...: Make the object jump:

Final position offset: The final position offset in the end of the jump

Peak: The peak Y values (offset)

Time: The time execution of the move

Change direction:

Turn North / South / West / East: Turn the object in the selected direction

Turn 90° left / right: Turn the object 90° in the left or right

Look at the hero: Turn in the hero direction

Look at hero opposite: Turn in the opposite of the hero direction

Change object options:

ON / OFF: For some options, you can use the option ON or OFF

Permanent: If checked, the object option will be conserved even after saving

Change speed / frequency: Change the speed or frequency value

Move animation: Change the move animation to ON or OFF

Stop animation: Change the stop animation to ON or OFF

Climb animation: Change the climb animation to ON or OFF

Direction fix: Change the direction fix to ON or OFF

Through: Change the through to ON or OFF

Set with camera: Change the set with camera to ON or OFF

Pixel offset: Change the pixel offset to ON or OFF

Keep position: Change the keep position to ON or OFF

Change graphics: Change the obejct graphics

Wait / Play sound / Script: Use the following commands

Display an animation

Display an animation in the current map.

Object ID: The object ID where the animation will be played.

Animation ID: The animation ID to play.

Wait the end of the animation before next command: If checked, the next command will be executed only after the animation end.

Move camera
Check out the camera guide here.

Reset camera
This command will simply reset the camera properties after using move camera command, but it won't change the current camera target.

Create object in map

Create an object in the map. Note that this object will be removed after changing map or quitting the game.

New object model ID: The model ID for the object that will be created

Position: Select the position of the new object

Stock ID in variable ID: The variable ID where you will stock the new object generated ID

Remove object from map

Remove an object from the map. This removing is effective as long as you don't change map or load the game in saves.

Object ID: The object ID to remove in the map.

Display a picture

Display a picture on top of the screen.

Image ID: The image ID to display.

Index: The index of the image to display. You can display several images in the same time if they have different index. The more the index is high, the more the image is displayed on top. If two images have the same index, then the ancient image will be removed.

Origin:

Top / Left: The origin position will be (0, 0) (= top left of the screen).

Center: The origin position will be the center of the screen.

Coordinates:

X: The x position according to the origin.

Y: The y position according to the origin.

Effects:

Zoom: The % zooming of the image.

Opacity: The % opacity of the image.

Angle: The ° angle of the image.

Set / Move / Turn a picture

Set / Move / Turn a picture that is already displayed on top of the screen.

Image index: Select the index of the image to set / move / turn.

Set:

Image ID: Change the image ID to display.

Zoom: Change the % zooming of the image.

Opacity: Change the % zooming of the image.

Move:

X: Change the x position according to the origin.

Y: CHange the y position according to the origin.

Turn:

Angle: Change the ° angle of the image.

Wait the end of the actions before the next command: If checked, the command will end only after Time number.

Time: Time to wait for updating the picture.

Remove a picture

Remove a picture that is displayed on top of the screen.

Image index: Select the index of the image to remove.

Play a video

Play, pause, or stop a video. The video will be displayed on top of the screen.

Video: The video ID to play.

Operation: The kind of operation to do: Play, Pause, or Stop.

Start: If checked and using Play operation, the video will be played at the indicated value (in seconds).

Wait the end of the change before next command: If checked, the next command will be executed only when the video is finished/paused/stopped.

Start shop menu

This will open a menu for a shop where the player can buy or sell items.

Buy only: Indicate if you want to enable selling items or not

Shop ID: Indicate the shop ID. This will be used only if you want to use command Restock shop later.

Items / Price / Stock: Select the items to sell with their price and stock


Item:

Item ID

Weapon ID

Armor ID

Price:

Default: The default price indicated in the item datas

Specific: A specific price that you can indicate here

Stock:

Unlimited: An unlimited stock

Specific: A spercific stock that can indicate here

Render in game:


Restock shop
Mostly the same options than Start shop menu command, but you can use this command to update the stock of a shop thanks to shop ID.

Enter a name menu

This will open a menu in order to change the name of a specific player.

The hero with instance ID: Select the variable containing the player instance ID

Max characters: The max number of characters that you can edit

Render in game:


Open main menu
This will open the main menu.

Render in game:


Open saves menu
This will open the saves menu.

Render in game:


Title screen
Go to the title screen.

Game over
Go to the game over screen.

Play a music

This will play a music on the current map.

Select song by ID: Instead of using the left list, you can select by ID values.

Options:

Volume: The music volume (in %).

Start: The beginning time of the music in seconds.

End: The end time of the music in seconds.

Stop music

This will stop the music played in the current map.

Disappear with time: Number of seconds for music played for disappearing.

Play a background sound
This will play a background sound on top of the current music.

Check out the play music command here that is similar.

Stop background sound
This will stop the background sound played in the current map.

Check out the stop music command here that is similar.

Play a sound
This will play a sound on top of all the songs.

Check out the play music command here that is similar.

Play a music effect
This will play a music by pausing the current played music. When the music effect is finished the previously played music is unpaused.

Check out the play music command here that is similar.

Change battle music
Select a music to change the battle music for every next coming battles.

Change victory music
Select a music to change the battle victory music for every next coming battles.

Send event

This will send an event to the selected target.

Target:

All: Send the event to all the objects visible in the map

Detection: Send the event to a specific detection.

Sender can't receive: The detection is not applied to the sender.

Only the closest: If checked, this will only send event to the closest object detected. If not, this will send event to all the objects detected.

Object: Send the event to a specific object.

Event:

Event system: Select a system event (events sent by the game system itself).

Event user: Select a user event (custom events sent by the map objects).

Parameters values: Select the event parameters values. You can keep the default value.

Change state

This will change the state of the current object. An object can have several states at the same time.

Object:

Map ID: The map ID to change state.

Object ID: The object ID to change state.

Selection:

State ID: The new state ID.

Operation:

Replace: Remove all the current states of the object and add the new state.

Add: Only add the new state.

Remove: Remove the object state having this ID.

Change property

This will change a property value of the current object.

Selection:

property ID: The property ID to change.

Operation: The operation to use according to the current property value.

Value:

New value: The new value to apply to the property with the corresponding operation.

Modify currency

Change the currency value.

Selection:

Currency ID: The currency ID to change value.

Operation: The operation to apply to the currency value.

Number: The number value to apply to the currency.

Modify inventory

This will update inventory containing. You can for example add items to it.

Selection:

Item ID: An item to select.

Weapon ID: A weapon to select.

Armor ID: An armor to select.

Operation: The operation to use according to the current number of the selection in the inventory.

Number: The value to use for updating the selection number.

Modify team

This will update team organization.

Create new instance with level ... in team / reserve / hidden of: Create a new instance of a hero or monster in team, reserve, or hidden.

Stock instance ID in: Choose a variable where you want to stock the instance ID. This can be useful to move or remove characters in team.

Add enemy with instance ID ... in team / reserve / hidden: Add an enemy that is in a current battle in team, reserve, or hidden

Modify: Move or remove a character with instance ID

Allow / Forbid saves

Allow: If checked, the saves menu will be allowed.

Allow / Forbid main menu

Allow: If checked, the main menu will be allowed.

Change general options
Not available yet.

Start a battle

This will start a battle with your team against a troop (group of monsters).

Troop's ID:

ID: Fix troop ID.

Random (in map property): Random ID indicated in map property window.

Battle map:

ID: Fix battle map ID.

Select...: Choose battle map and position thanks to a map previewer.

ID map, X, Y, Y plus, Z: Choose battle map ID and position to go manually.

Options:

Allow escape: If checked, it would be possible to use battle command Escape in this battle.

Defeat causes Game Over: If checked, losing in this battle will automatically direct to game over. If not checked, there will be two commands container : one for the winning state, and the second for the losing state.

Transition:

Start / End: Start / End type of transition:

None: Immediate transition.

Fade in / out: Transition on a color.

Zoom in / out: Transition by zooming in / out.

Display / Hide enemy
Not available yet.

Force an action

During a battle, this will force an hero or enemy to execute an action on a target.

Battler: The battler that should execute the action

Enemy: Select an enemy of the current troop

Hero / Enemy instance ID: Select the instance ID of a character. They are mainly stocked into a variable

Action: The action to execute

Use skill ID: Select a skill with a specific ID

Use item ID: Select an item with a specific ID

Do nothing

Target:

Random: A random target

Last target: The last target that the battler selected

Custom:

Enemy: Select an enemy of the current troop

Hero / Enemy instance ID: Select the instance ID of a character. They are mainly stocked into a variable

End battle
You can use the end battle command in troops reactions to force a defeat.

Change battle music
You can select a battle music for the next battles.

Change victory music
You can select a victory music for the next battles.

Change a statistic

You can here change a statistic value to one or several characters (heroes or enemies).

Statistic ID: The statistic ID to change value.

Selection:

Hero / Enemy instance ID: Select the instance ID of a character. They are mainly stocked into a variable.

The entire: Select a group, this can be the team, reserve, or hidden.

Operation: Select the operation to apply to the current statistic value.

Value:

Number: Choose a dynamic number value.

Formula: Enter a formula as a value.

Maximum statistic value: Take the maximum value of a statistic (used to heal maximum HP, for example)

Can go above maximum value: If checked, the given value can be superior to maximum value of the statistic.

Change experience curve

Change the experience curve table of one or several players.

Selection:

Hero / Enemy instance ID: Select the instance ID of a character. They are mainly stocked into a variable

The entire: Select a group, this can be the team, reserve, or hidden

Level:

Range: The level range to apply the experience curve changes

Operation: The operation to use according to the current experience value

Total experience:  The total experience to change in the table

Change status

Add or remove a player status.

Selection:

Hero / Enemy instance ID: Select the instance ID of a character. They are mainly stocked into a variable.

The entire: Select a group, this can be the team, reserve, or hidden.

Operation: Choose to add or remove the status

Status:

Status ID: The status ID

Change a skill

Choose if you want a character to learn or forget a specific skill.

Skill ID: The skill ID to learn or forget.

Selection:

Hero / Enemy instance ID: Select the instance ID of a character. They are mainly stocked into a variable.

The entire: Select a group, this can be the team, reserve, or hidden.

Operation: Choose here if you want to learn or forget the selected skill.

Change name

Choose a character you want to change the name. This isn't like the command enter hero name, this doesn't open any HUD so the player can enter a name.

Name: The new character name.

Selection:

Hero / Enemy instance ID: Select the instance ID of a character. They are mainly stocked into a variable

The entire: Select a group, this can be the team, reserve, or hidden

Change class

Change one or several players class. This will apply changes on statistics and learned skills.

Class ID: The new class ID to apply

Selection:

Hero / Enemy instance ID: Select the instance ID of a character. They are mainly stocked into a variable

The entire: Select a group, this can be the team, reserve, or hidden

Change equipment

You can force a character to equip a weapon or an armor.

Equipment ID: The equipment slot ID to force equip.

with Weapon ID / Armor ID: The weapon or armor ID to force equip (according to equipment ID).

Selection:

Hero / Enemy instance ID: Select the instance ID of a character. They are mainly stocked into a variable.

The entire: Select a group, this can be the team, reserve, or hidden.

Apply only if in inventory: If checked, the equipment is not equiped if not in inventory. If not checked, the item will be added to inventory and then equiped.

Condition
Create a container for commands that will be executed only if the indicated condition is true.

Add "else" when conditions do not apply: Create another container for commands that will be executed only if the indicated condition is false.

Variables / Param / Prop:


This: Compare a variable or a parameter or a property with any other type of value.

Heroes:


Hero(es): Select all the heroes or none of the heroes or at least one hero or the hero with instance ID. in team or reserve or hidden.

Are named: Check if the selection have this name.

Are in: Check if the selection is in the team or reserve or hidden.

Are able to use the skill ID: Check if the selection is able to use the selected skill ID.

Are equiped with:

weapon ID: Check if the selection is equipped with the selected weapon ID.

armor ID: Check if the selection is equipped with the selected armor ID.

Are under effect of status ID: Not available yet.

Have the statistic ID: Compare a selected statistic of the selection with any other type of value.

Possessions:


Currency ID: Compare a selected currency number with any other type of value.

Item ID: Compare a selected item number in inventory with any other type of value.

Weapon ID: Compare a selected weapon number in inventory with any other type of value.

Check weapons equiped too: If checked, the equipped weapons will be included in the number of weapons.

Armor ID: Compare a selected armor number in inventory with any other type of value.

Check armors equiped too: If checked, the equipped armors will be included in the number of armors.

Others:


Key ID: Check if selected key is ON or OFF.

Escaped last battle: Check if the player escaped last battle (using escape battle command).

Script: Check according to the script return value (for programmers).

Loop
Create a container for commands that will be executed on a loop.

Break loop
If inside a loop container, this will go out of the loop and go to the next command after the loop.

Label

Add label to your reaction, you will combine it with jump to label command. You can choose any name you want.

Jump to label

Combined with label command, you can choose to move to the named label. Here is a nexample that will create a loop:


The commands will be executed like this:

Condition ? > No > End if >Jump to label loop > Label loop > End if > Jump to label loop > Label loop > ...

Stop the reaction
Stop the current reaction.

Comment

Comments won't be interpreted in game, it's only here for you. You can leave a comment in specific places to remember why you used specific commands.


Call a common reaction

This will call a common reaction with the corresponding parameters.

Common reaction: The common reaction to call.

Parameters values: The parameters to apply with the common reaction.

Change variables

This will change one or several variable(s) value.

Selection:

One variable: The unique variable to change

Range: The range of variables IDs to change

Operation: The operation to use according to the current variable(s) value

Value:

Number: A simple number

Random: A random number between two selected values

Message: A simple message

Switch: A simple switch

Number of ... in inventory: The number of item / weapon / armor that are currently in the inventory

Total currency ... with ID: The total number of a specific currency (owned, earned, or used)

Hero / Enemy instance ID ... statistic ID: Get a statistic value according to a player instance ID

An object in the map ... characteristic: The selected object characteristic:

X square position: The x square position of the selected object.

Y square position: The y square position of the selected object.

Z square position: The z square position of the selected object.

X square position: The x pixel position of the selected object.

Y square position: The y pixel position of the selected object.

Z square position: The z pixel position of the selected object.

Orientation: The orientation of the selected object.

Enemy ... instance ID: The selected enemy instance ID

Other characteristics:

Current map ID: The current map ID

Number in team: Number of players in team

Number in hidden: Number of hidden players

Number in reserve: Number of players in reserve

Total number of steps: Number of steps made by the hero

Total number of seconds: Number of seconds playtime

Total number of saves done: Number of saves done since starting the game

Total number of battles: Number of started battles

Camera X position: The camera X position

Camera Y position: The camera Y position

Camera Z position: The camera Z position

Total seconds played of the current music: The total number of seconds played of the current music

Total seconds played of the current background music: The total number of seconds played of the current background music

Script

Execute a script code (for advanced programmers). Note that you can use $object local variable to get the Core.MapObject current object! 

Use dynamic: Non-static code (in variable, or parameter, or property).

Camera control
In your 2D games, you are limited to screen moves for adding dynamism to your important scenes. A 3D camera offers a lot of opportunities for your scenes (moves, rotations, zooms...) and you need to know some easy basics to use it correctly.


The camera
First, you should know what is a camera. Just imagine that you are a cameraman for a great movie. The first two things required for filming a scene are:

The camera position

The target position (= where the camera is looking at)

Thanks to the scripts, these two positions are always calculated thanks to algorithms. These positions will be calculated according to:

The target position and a potential offset

The distance between the camera and the target

The horizontal angle between the camera and the target

The vertical angle between the camera and the target

The distance

The distance is simply a positive value indicating the distance between the camera and the target. This should take account of the three axis. This will be used for zooms. The default value is 125.

The horizontal angle

The horizontal angle is only applied to the X and Z axis. For example, if you want to turn around your target horizontally, you will have to change this value. The default value is -90°.

The vertical angle

Same as the vertical angle but only applied to the Y axis. For example, if you want to turn around your target vertically, you will have to change this value (to go down you have to increment the value, and to go up you have to decrease the value). The default value is 55°.

The move camera command
Here we are, now that you know a bit more about the camera properties we can see how to dynamically move it. The Move Camera event command is here for it!


Camera target: By default, the camera is always looking at the hero.

Unchanged: Keep the current camera target.

Object ID: If you are selecting a new object ID to focus, the camera will move to its position and will consider it as the new target after it.

Operation: You can select here the kind of operation you want to apply to the modified values. For example, if you choose (+) and you set distance to 5, if the previous distance value was 125 it will become 125 + 5 = 130.

Move: You can modify here the camera position on the three axis (you can choose squares by squares or pixel by pixel).

Target offset: if this option is checked, you will move the camera and the target offset positions at the same time. In 2D games, it's like if you only wanted to move the screen and ignore the hero position.


Moving X+10 squares with target offset OFF

Moving X+10 squares with target offset ON
Take account of camera orientation: (not available yet) This is simply considering that the axis are modified according to the camera position (see the same option for Move Object command).

Rotation: You can here modify the horizontal and the vertical angle of the camera in order to apply rotations.

Target offset: Same as for moves. This time, the target will turn around the camera.


Adding 360° to the horizontal angle with target offset OFF

Adding 360° to the horizontal angle with target offset ON

Adding 360° to the vertical angle with target offset OFF

Adding 360° to the vertical angle with target offset ON
Zoom: You can set the distance between the camera and the target to create a zoom effect.

Distance: The distance to update in pixels.

Wait the end of the move before the next command: Wait the end of the move before the next command (same as for the move object command). It can be used to execute commands while the camera is moving (display texts, sounds...).

Time: Indicate here the time in seconds for the camera to move to its final position. If 0, the move will be immediate.

Camera properties
You can control the default properties of the camera when you are going into a new map. You can set the camera ID in map properties. You also have access to the camera properties list in Systems manager > System:


Name: The name of the camera properties.

Distance: The distance between the camera and the hero.

Horizontal angle: The horizontal angle between the camera and the hero.

Vertical angle: The vertical angle between the camera and the hero.

Target offset: A position on every axes for adding an offset to the target position.

Field of fiew: The angle used to determine the angle vision limit of the camera. We recommend to keep the default value.

Near: Min distance between camera and elements for being drawn. We recommend to keep the default value.

Far: Max distance between camera and elements for being drawn. We recommend to keep the default value.

Battle system
If you want to create to create a RPG, you may need a battle system. Here, we will see all the features linked to the battle implementation.


Note: if you want to do an action RPG (battles directly on maps), you can do it through object & events

Battle system datas
A lot of battle system datas can be found in Systems Manager > Battle System:


Elements

You can manage here all the elements that you want to have in your game for influencing your damages effects.

Name: Name displayed in game UI.

Icon: Icon displayed in game UI.

Efficiency: You can edit here how efficient is the current element against all the other existing elements. This is pretty usefull when the element is assigned to a class. By default, it's x1.0 (normal effect).

Common statistics

You can manage here all the statistics that you want to have in your game for influencing your battles (HPs, lvl, strength, etc.).

Name: Name displayed in game UI.

Script abbreviation: Choose here an abbreviation. This will be used for game scripts, choose something without capital letter if possible.

Properties:

Fix: If checked, this statistic would be a fix value (not a bar).

Bar: If checked, this statistic would be a bar value (an actual value + max value).

Common battle commands

Choose which battle commands you want to have after selecting a hero to do something.

Skill: Choose the corresponding skill.

Render in game:


Common equipment
Choose the name of common equipment so you will be able to equip weapons / armors on these equipment slots.

Weapons / Armors kind

Create a weapon / armor kind and also choose on which equipment you can assign it.

Name: Name for this kind of weapon / armor.

Selection of equipment you can assign.

Battle maps

Battle maps are in fact maps associated with a specific position (representing the center point of the battle). Select a map (by default in the Battle Maps folder in the map selector) and a position to add a new battle map.

Statistics associations
Statistic associated to level: Choose one of your fix statistic to associate with level. Level is a statistic that is increasing for the character evolution: leveling up will increase other statistics.

Statistic associated to exp: Choose one of your bar statistic to associate with experience. Experience is something earned generally after finishing a battle. Once experience goes to its maximum value, the character is leveling up and the map experience bar increases too.

Formulas
Is dead: Formula in JavaScript defining conditions to consider that a character is dead. u corresponds to the character.

Critical influence: Formula in JavaScript defining the new damages value after having a critical hit. damage corresponds to the damages done without critical influence.

Heroes battlers center offset: Formula in JavaScript defining the position of heroes battlers according to the center of the map battle.

Heroes battlers offset: Formula in JavaScript defining the position of heroes battlers according to other heroes position (where i is the hero index).

Troops battlers center offset: Formula in JavaScript defining the position of troops battlers according to the center of the map battle.

Troops battlers offset: Formula in JavaScript defining the position of troops battlers according to other enemies position (where i is the enemy index).

Battle musics
Battle: Battle music used during the battle.

Level up: Sound used when a hero is leveling up.

Victory: Music used during the victory end battle phase.

Currencies
Go to Systems Manager > System.


Currencies can be used in the game for trading with NPCs or any other way.

Name: Name of the currency.

Icon: Icon associated with the currency.

Skills / Items / Weapons / Armors
Go to Datas Manager.

In Skills tab:


In Items tab:


In Weapons tab:


In Armors tab:


These four data have common properties:

Name: Name of the data.

Type: Select the type of item / armor / weapon.

Consumable: If checked, the data will disappear after using the data.

One hand: Not available yet.

Icon: Icon associated with the data.

Description: Description of the data that will be displayed in game.

Conditions formula: The conditions to be able to equip or use the skill / item / weapon / armor

Target: Target for applying associated effects.

None: No target selection.

The user: Select the user only.

An enemy: Only select one ennemy.

An ally: Only select one ally.

All enemies: Select all enemies.

All allies: Select all allies.

Target conditions formula: The conditions to be able to use the skill / item / weapon / armor according to the target

Available: Available kind of the data.

Battle only: The data can be used only in battle.

Main menu only: The data can be used only in main menu.

Always: The data can be used in battle and main menu.

Never: The data can never be used.

Sound (main menu): The sound to play when using it in the main menu.

User animation ID: The animation ID to display on the user before attacking.

Target animation ID: The animation ID to display on the target(s) when attacking.

Can be sold: Indicate if the item can be sold in a shop

Battle message: The message to display on the top bar when using a skill or item. [item] will display the item name, and [skill] will display the skill name.

Price: Price of the data when it can be bought / sold in a shop menu.

There also are three more common properties that can be listed: Costs, Effects, and Caracteristics.

Costs

Choose the cost of using a skill. This is generally used for HP, MP, and TP statistic. A character will not be able to use a skill if he doesn't have enough for the use cost.

Apply cost on: Select which data will be influenced after using the skill. It can be a statistic, a currency, or a variable.

with value: Select the value required for the selected data.

Effects

Choose the effects done for the target(s) data.

Damages on: Select which data will be damaged. It can be a statistic, a currency, or a variable.

with formula: Select the value damage for the selected data.

Minimum: Minimum value that can have final damages.

Maximum: Maximum value that can have final damages

Element ID: Element applied for these damages.

Variance: The variance damages in percent. This adds random on your damages. For example, if you choose 20% variance, your damages range would be : [damage - (20 * damage / 100) | damage + (20 * damage / 100)]. If not checked, there is no variance (= 0).

Critical: The critical hit chance in percent. If not checked, there is no chance to do critical hit (= 0).

Precision: The precision hit in percent. If not checked, you have 100% chance to hit.

Stock value in: You can stock the damages value in a variable. This can for example be used for a next effect.

Status Add / Remove: Add or remove a status to the target

Skill Add / Remove: Add or remove a skill to the target (learn or forget)

Perform skill: Execute another skill to the target

Call common reaction: Call a common reaction

Special action: Execute one of the following special actions:

Apply weapon(s) effects and properties: This will use all the effects of the currently equipped weapon. If the is no weapon equipped, this will apply the next effects following this one.

Open skills choice: Open the skills choice for battle command.

Open items choice: Open the items choice for battle command.

Escape: Escape from the battel.

End turn: End the team turn.

Script: Execute a script

Temporarily change target: You can temporarily change the target for this effect only. You have to return an array of battlers. Example: [u.battler] will be the user of the item/skill/weapon.

Characteristics
Choose the characteristics added to the character when equipped.


Buff increase / decrease: Select which data will be influenced. This can be:

Statistic value: Select a statistic. If bar statistic, this will increase the max value.

Element resistance: Select an element to apply resistance on it.

Status resistance: Select a status to apply resistance on it.

Experience gain: Change experience gain after each battle.

Currency gain: Change currency gain after each battle.

Skill cost: Select a skill to apply skill cost change.

After selecting the data influence, you can choose how this is influenced according to the base value:

* / +: Choose operation by multiplying by or adding a value.

% / Fix: Choose unit value.


Equip: Choose to allow or forbid a weapon or armor to be equipped

Change equipment: Choose to allow or forbid an equipment slot to be editable

Begin equipment:  Choose a begin equipment (when the player is instancied)


Script: Execute a script

Classes

Each character has a class. The class defines a lot of attributes that a character can have.

Experience: Define experience progression according to level. Note that you can edit the experience column manually by double clicking on the cell.

To next level: The table indicates the number of experience to gain for going to the next level.

Total: The table indicates the total number of experience that should be accumulated for going to the next level.

Initial level: The initial level possible.

Max level: The maximum level possible.

Base: The number of experience to have at initial level.

Inflation: Inflation value changing experience progression according to base and level.

Reset: Reset to default values.

Statistics progression: Change the statistics progression for level ups.

Informations:

Statistic: Select one of the system statistic.

Maximum value: The maximum possible value. This doesn't always corresponds to the final value because items could add bonus values.

Fix:

Initial value: The initial value at initial level.

Final value: The final value at max level.

Slider progression:

Slow: The experience increases slowly at the begining and increase faster at te end.

Linear: The experience increases constantly.

Fast: The experience increases fast at the begining and increase slowly at te end.

Random variation: The variance applied on the progression function. Note that this will always lead to the max value.

Formula: Use a formula to define the value. u corresponds to the character.

Characteristics: Defines the class characteristics

Skills to learn: Defines the list of skills that can be learned according to levels.

Skill: The corresponding skill to learn.

Level: The level for learning this skill.

Heroes

Class: Select an existing class.

Description: A description that will be displayed in the state menu ingame.

Faceset: Select a faceset for battles.

Battler: Select a battler for battles.

All the other properties inherits from the class properties. For Experience, the values by default are the class values. The Set to class values button updates the values to the class values. For Statistics progression list, you can add additional progressions. If the statistic already existed, the progression would be replaced. For Skills to learn list, you can add additional skills to learn. If the skill already existed, the level would be replaced.

Monsters

Monsters are exactly like heroes but with extra information for battles:

Rewards:


Experience: Choose experience progression that your team can get at the end of a battle.

Currencies: Choose currencies progression that your team can get at the end of a battle.

Loots: The loots that your team can get at the end of a battle.

Number: The number of items to loot.

Probability: The probability to loot.

Level between: Choose range level of loot availability.

Loot: Select Item, Weapon, and Armor.

Actions:

You can manage your monster's AI here. You can specify monster actions with these following options:


Priority: The priority of the action. You can see Probability below that will give you the percent chance of the actions according to all the other actions priorities. Warning: Il you put a priority as a variable a ? will be displayed.

Target:

Random: Will attack on random target without any AI.

Weak enemies: Will attack targets with lower HPs. Warning: do not remove or change hp abbreviation in common statistics to have this working.

Action:

Use skill ID: The monster will use the selected skill.

Use item ID: The monster will use the selected item.

Number max: The number max of item that can be used by the monster. If < 0, will be infinite.

Do nothing: The monster will do nothing.

Conditions:

Turn value: This action can be done according to the current value of turns in the battle.

Statistic ID: This action can be done according to the specified statistic percentage. Note: this should be only bars (with max value).

Variable: This action can be done according to the current value of a variable.

Is under effect of status ID: Not available yet.

Script: This action can be done according to the script return.

Troops

Troops correspond to a monsters group and some states with reactions.

Test button: You can test a troop battle at any moment with the test button. It will open a small window when you can choose a team fighting this troop. When it's done, just press ok and it will open a game battle with the selected troop.


Monsters list:

Monster: The monster in the group.

Level: The level of the monster.

Reactions: a list of reactions to trigger in this battle troop

Name: The reaction name (only to help for ordering everything)

Conditions: The condition(s) to validate to trigger the reaction:


Number of turns + x : The turn number. The first turn is turn 1. The (+) turn is the fix base turn, and the (x) is the number of time it's trigerred. 1 + 2 x will for example be triggered in turn 1, 3, 5... etc.

The heroes/monsters all players/none of the players/at least one player/the player with instance ID:

Are under effect of status ID: Check if the status is applied

Have the statistic ID: Compare a statistic value

Frequency: The frequency of trigerring

One time: Only triggered one time in the beginning of the first turn

Each turn (begin): Triggered in the beggining of each turn

Each turn (end): Triggered in the end of each turn

Always: Triggered in each frames

Status

Status can be applied after using particular skills or items. This can be KO, poisonned, paralized, etc.

Animation ID: Select an animation to display with a loop when the player is affected by this status. Since you can't display more than one animation on a player if there is several status, the priority will decide which one to display.

Restrictions: You can add restrictions for the player when it is affected by the status. It can be:

Can't do anything: The player will pass their turn everytime

Can't use skills: The player won't be able to open skills menu

Can't use items: The player won't be able to open items menu

Can't escape: The player won't be able to escape

Attack random target: The player will use a random attack to attack a random target (ally or enemy)

Attack random ally: The player will use a random attack to attack a random ally

Attack random enemy: The player will use a random attack to attack a random enemy

Priority: Defines which Animation ID and Battler position to display. If you have several status, the one with higher priority will be displayed.

Battler position: The column to display in Battler picture when the player is affected by the status

Release conditions: Defines all the status release conditions

Release at the end of battle: The status will disappear after the end of a battle

Release with X% chance after being attacked: The status will disappear with X% chance after being attacked (receiving positive damages)

Release at the start of turn: The status will disappear at the start of a turn according to a list of conditions depending on a chance according to the turn number.

Messages: Defines messages to display according to the status situation

Ally affected

Enemy affected

Status healed

Status still affected

Effects: The effects to apply at the beginning of a turn if the player is still affected by the status

Characteristics: The characteristics (buffs etc) to apply when the player is affected by the status

Animations

Animations are used for: weapons, skills, items, and event command display an animation. You can customize these 2D animations with several different options.

Picture: The texture used for the entire animation.

Position: Choose the origin position. You have an indicator of this position with the battler example drawn in the panel.

Frames: List of different frames of the animation.

Graphics: You can add elements in the panel by left clicking:


You can right-click and click on Edit... to edit properties of an element:


Index: The index of the element. An element is always drawn on top of other elements that have lower index.

X: The x position center of the element.

Y: The y position center of the element.

Zoom: The zoom % the element.

Angle: The angle ° of the element.

Flip vertically: If checked, the element will be flipped vertically.

Opacity: The opcaity % of the element.

Before left clicking, you can choose the texture thanks to this selector:


Options:

Change battler: Change the battler to display in the panel.

Copy frames...: Copy frames with the following options.

Screenshot


Frames to copy: Select all the frames to copy.

Paste from frame: Paste from this frame.

Clear frames...: Clear frames with the following options.

Screenshot


Create transition...: Create a transition on several frames with the following options.

Screenshot


Frames: The frames begin and end transition.

Elements index: The elements index to apply transition.

X, Y, Zoom, Angle, Opacity: The optional values at the end of the transition. You can use the progress slider to choose how fast is the transition.

Apply texture: Apply the selected texture to the selected element.

Play hit: Test the animation when hit.

Play miss: Test the animation when miss.

Play crit: Test the animation when critical.

Rows: The number of rows to split the texture animation. Default value is 5.

Columns: The number of columns to split the texture animation. Default value is 5.

Sound effects / Flashs: You can add a list of effects (sound effects or flashs) here:

Screenshot

Effect:

Sound effect: Select a sound to play at this frame.

Flash: Not available yet.

Condition: Select a condition for playing this sound or displaying this flash:

None: No condition.

Hit: When hitting an attack.

Miss: When missing an attack.

Critical: When doing a critical attack.

Windows skins
Window Skins
A WindowSkin is a picture that is cut for being used as a design for window boxes (text dialog for example), arrows (end of message, target selection, up/down), texts in battles (damage numbers with normal, critical, heals, and miss). RPG Paper Maker doesn't have a fix template, you can edit the cutting of each element of your WindowSkin by yourself.

Here is the default Window Skin image used:


Create a Window Skin and / or change default Window Skin
Got to Systems Manager > System.


On left: Change default.

On right: Manage all WindowSkins.

Edit WindowSkin
To view a cutting, put your mouse on the widget associated (example: top-left border). You'll see a red rectangle. If you want to change it, there are two ways.

Enter
Click on the Enter... button to open a dialog box and edit the rectangle with input numbers.


Select
Click on the Select... button and draw the rectangle with your mouse directly on the picture preview.


Properties
Picture: The picture used by the WindowSkin.

Side borders: The side borders used for the window boxes.

Borders: The borders used for the window boxes.

Background:


Normal: The background image used for the window boxes.

Selection: The background image used for the window choices / tabs when selected.

Option:

Repeat: Repeat the background image for larger windows.

Stretch: Stretch the background image for larger windows.

Arrows:

Target selection: The arrows animation used for the battle target selection.

End of message: The arrows animation used for the command show text command.

Up / Down: The arrows used for the input number.

Texts:

Normal damage: The texts numbers used for normal damages.

Heal damage: The texts numbers used for heal damages.

Critical damage: The texts numbers used for critical damages.

Miss: The texts numbers used for miss damages.

Title screen & Game Over
Got to Systems datas > Title screen / Game over:


Title Screen
In the first section, you can edit some of the title screen properties.

Background
Image: Picture used for title screen background.

Video: Video used for title screen background.

Music: Music used when player is in title screen.

Menu commands
Customize here the commands to display in the title screen.


Name: The displayed text in-game.

Type of command: The type of command.

New game: Run a new game.

Load game: Open saves menu.

Options: Open the settings menu.

Exit: Quit game.

Script: Execute custom script that can be entered in the appropriate textarea.

Settings configuration

Settings configuration: The settings menu can be customized here by reordering and / or displaying some of the options.

Keyboard assignments: Configuration of the keyboard assignements proposed in the Keyboard manager.


Game Over
In the second section, you can edit some of the game over screen properties.

Background
Image: Picture used for game over screen background.

Video: Video used for game over screen background.

Music: Music used when player is in game over screen.

Menu commands
Customize here the commands to display in the game over screen.


Name: The displayed text in-game.

Type of command: The type of command.

Continue: Load the last save of the current slot. If there's no current save on this slot, this will run a new game.

Title screen: Open title screen menu.

Exit: Quit game.

Script: Execute custom script that can be entered in the appropriate textarea.

Main menu
You can customize your ingame main menu by going in Systems manager > Main menu:


Items types
Items types are a list of all the types that you will be able to select when editing an item.


Inventory filters

You can edit the tabs content filters when you are in the inventory.


Name: Select the name that you want to display ingame

Kind: The kind of filter

All: No filter applied

Consumables: All the consumables

Custom: Select an associated item type ID

Weapons: All the weapons

Armor: All the armors

Weapons and armors: All the weapons and armors

Script: Use a custom script filter that should return true or false according to item given variable that is a Core.Item type. Example:

Copy
return item.system.id === 1;
Main menu commands

The main menu commands are the commands choices box that are displayed on the top left when opening the main menu.


Name: The name to display ingame

Kind: The kind of action to do when clicking on it:

Inventory: Open inventory menu

Skills: Open skills menu

Equip: Open equip menu

States: Open states menu

Order: Select heroes list to reorder it

Save: Open save menu

Quit: Go back to title screen

Script: Call a special script. Should return true for success and false for impossible. You can use the menu variable that is a Scene.Menu type. Example:

Copy
menu.windowChoicesTeam.select(0);
return true;
Heroes statistics to display

You can customize the statistics to display on the right side of the hero description.


Statistic ID: The statistic ID to display

Multi languages
RPG Paper Maker contains a languages manager, so you can have several possible translations in your game.

Languages manager
You can open the languages manager in the tool bar by clicking on Languages:


Languages: Edit the list of available languages:

Name: The language name (for inside the engine)

Type: The language type, that can be any available language in the engine, or a custom one

Edit a translatable name
You can then edit a translatable name according to your created languages. Example with a class name:


Name: Edit the main language translation directly

Language button: Edit specific languages translation:

All: Edit for all the languages

... and then use the tabs for editing for a specific language

Title screen setting option
You can enable or disable languages change ingame in title screen settings in Systems Manager > Title screen / Game over:


Render in game:

Action battle system
/! Be aware that this tutorial will be updated constantly with new coming updates for having the best representation of the engine possibilities. Currently there are only basic possibilities so this won't look really attractive in the first place (no animations etc.).

Also, be aware that you will need to have a look on the Objects & Events tutorial before reading this.

What is an Action Battle System?
An Action Battle System is the type of battle used for Action-RPG or simple Action games. One example is Zelda series, except for Zelda 2 which is a platformer, which is using a battle system with sword attack, bombs, arrows, etc.


How to create my hero and enemies characteristics
We will start with one basic characteristic: HP (health points). There is actually not the command to be able to set statistics values, but there is another way to do: use properties. Go to Systems manager > Models and select Hero model. You can add a property HP this way:


You can do the same things with enemies in your maps:


NOTE: We strongly recommend to use models here!

How to create sword attacks
Now, let's say that the Action key will use your sword. We need three things:

Create an event sword attack that will be sent to nearby enemies. Go to Systems manager > Events / States and add a new event named Sword attack with a parameter Power that can be anything as default value. This parameter will be useful to change attack swords power.


Create a dead state so the enemy won't be displayed after he got 0 HP. Go to Systems manager > Events / States and simply add a new state named Dead.


Create a detection for sword that will indicate the area where your sword attack will be effective. Go to Systems manager > System and add a new detection named Sword that is like that:


Now, go back to your Hero model. The event Action keypress is already used for sending Hero action event, but we can use it to send sword event too. Let's do a reaction to this so the Hero will send the event Sword attack with power 5 to enemies that are in the detection sword area:


Done. Now, the enemy should be able to react to sword attack if we want to have something to happen. Let's make him react to sword attack event with any power value by losing HP and dying if HP is lesser than or equal to 0:



The dead state is simply an empty object without graphics, but it could have been a dead asset too. So there it is, you have your sword attack!

How to create loots left by enemies in map
What you can do instead of having the enemies instantly dead is replacing them by loots that they could have dropped! Just add a state loot that will react to hero touch and replace dead state by loot state:


You can even add random effect with 80% of chance to having a loot for example:


Result:


How to create projectiles (bullets, arrows)
Not available now (requires create / delete objects in map command)

How to create bombs
Not available now (requires create / delete objects in map command)

How to create an AI
Not available now (requires more move command(pathfinding))

How to create an intrusion system
Not available now (requires send detection to a specific object command for better use)

Plugins tutorials:

Getting started
In this section, we will learn how to create plugins and understand the System code.

This guide is not a guide to learn Javascript programming language. The following steps will suppose that you know the basics. You can check Javascripts tutorials here:

JavaScript Syntax and Constructs Overview:


Discovering JavaScript Talk:

First 3.5h of a video course about JS:


You Don't Know JS (book): 

https://github.com/getify/You-Dont-Know-JS 

You know the JS basics? Now you can keep going! :)

First of all, we strongly recommand you to use Visual Studio Code as your IDE (Integrated Development Environment). This will help a lot for auto-completion. You can download it here: https://code.visualstudio.com/.

Open it and go to File > Open Folder and select YourProject/resources/app/Content/Datas/Scripts


Now you'll be able to start your code learning!


You can keep an eye on the doc API here: https://rpg-paper-maker.github.io/

Scripts organization
Understanding how the scripts are organized.

System
The System code is using ECMAScript modules, so every modules are packed into a folder with the module name. Checkout the System folder:


Here are the following modules:

Common: Every static classes mainly used to get static properties and methods (Mathf, Paths...)

Core: Every core classes that will be directly used in the game run (Autotiles, WindowBox...)

Datas: Every datas classes grouping every System classes that will read JSON game files

 (Heroes, Systems...)

EventCommand: Every event commands that can be interpreted in reactions (ShowText, Wait...)

Graphic: Every graphic classes that are used to be drawn inside WindowBox classes (Text, Player...)

Manager: Every manager classes used to manage specific game events (Collisions, Plugins...)

Scene: Every scenes classes where everything is drawn (Map, Menu...)

System: Every systems classes that will read JSON from datas (Color, Monster...)

We will gradually see how these modules are used in this tutorial.

Each file *.js also comes with a *.d.ts :


You don't need to care about the *.d.ts. These files are just here to help Visual Studio Code to correctly type your auto completion.

In fact, the original RPG Paper Maker code is in TypeScript, which is JavaScript but with typing restrictions. The TypeScript code is compiled to JavaScript Standard code and also provide these *.d.ts.

Shaders
The Shaders folder contains all the shaders used by for 3D. To keep it simple, shaders are small programs executed in the graphic card instead of CPU. We will see later how it's used.


Libs
The Libs folder contains every external libraries used by RPG Paper Maker.


We are using he following:

howler.js: It's a library managing every songs playing very easily.

three.js: The most important library. It provides a lot of functions and classes to handle webGL (3D) very easily. We will see it a lot in our code. You can check out the doc here: https://threejs.org/docs/ and easily understand the RPG Paper Maker use.

Plugins
All your future plugins will be in this Plugins folder:


We'll see later how it's managed.

Where does the code start?
Now the question is: where does all the code start? It's in System/main.js. Let's quickly see what's happening inside it.

Copy
let loaded = false;
/**
 *  Initialize the game stack and datas.
 */
async function initialize() {
    await Manager.Plugins.load();
    Manager.Stack.loadingDelay = 0;
    Manager.Songs.initialize();
    Manager.Stack.clearHUD();
    await load();
}
First, we define the initialize function. The first thing it does is to load the plugins, and then it initialize some managers (Manager.Stack and Manager.Songs) and then load the datas (that are inside the game JSON) thanks to this load function:

Copy
/**
 *  Load the game stack and datas.
 */
async function load() {
    await Datas.Settings.read();
    await Datas.Systems.read();
    await Datas.Variables.read();
    await Datas.Pictures.read();
    await Datas.Songs.read();
    await Datas.Videos.read();
    await Datas.Shapes.read();
    Manager.GL.load();
    Manager.GL.initialize();
    Manager.GL.resize();
    await Datas.SpecialElements.read();
    await Datas.Tilesets.read();
    await Datas.Items.read();
    await Datas.Skills.read();
    await Datas.Weapons.read();
    await Datas.Armors.read();
    await Datas.Classes.read();
    await Datas.Heroes.read();
    await Datas.Monsters.read();
    await Datas.Troops.read();
    await Datas.BattleSystems.read();
    await Datas.TitlescreenGameover.read();
    await Datas.Keyboards.read();
    await Datas.Animations.read();
    await Datas.CommonEvents.read();
    await Datas.Systems.getModelHero();
    await Datas.Systems.loadWindowSkins();
    Manager.Stack.pushTitleScreen();
    loaded = true;
    Manager.Stack.requestPaintHUD = true;
}
When everything is loaded, the title screen scene is initialized and we notify that the loading is finished. The game main loop is the loop function:

Copy
/**
 *  Main loop of the game.
 */
function loop() {
    requestAnimationFrame(loop);
    // Update if everything is loaded
    if (loaded) {
        if (!Manager.Stack.isLoading()) {
            Manager.Stack.update();
        }
        if (!Manager.Stack.isLoading()) {
            Manager.Stack.draw3D();
        }
    }
    Manager.Stack.drawHUD();
    // Elapsed time
    Manager.Stack.elapsedTime = new Date().getTime() - Manager.Stack
        .lastUpdateTime;
    Manager.Stack.averageElapsedTime = (Manager.Stack.averageElapsedTime +
        Manager.Stack.elapsedTime) / 2;
    Manager.Stack.lastUpdateTime = new Date().getTime();
}
It is called thanks to:

Copy
// -------------------------------------------------------
//
// START LOOP
//
// -------------------------------------------------------
requestAnimationFrame(loop);
It's basically updating and drawing the current scene (when starting, it's Scene.TitleScreen).

Finally, inputs are managed thanks to:

Copy
Inputs.initialize();
We will see in the next tutorial how the Manager.Stack is handled.

Stack and scenes
Let's see how is handled the stack manager.

The stack
We've seen that the main.js was using a class named Manager.Stack. First, what's a stack? It's a simple array containing scenes.


The top of stack is the current scene that will be drawn. You can add a new scene on top of the stack by using push and remove the top scene by using pop. You can check the Manager/Stack.js.

A base scene
Now open the Scene/Base.js. Every Scene class will extend this base. This will handle the reactions interpretation (objects reactions in maps, common reactions). Every scene will contain these functions:

Copy
update() {
    ...
}
The update is for making every data update before drawing the scene.

Copy
onKeyPressed(key) {
    ...
}

onKeyReleased(key) {
    ...
}

onKeyPressedRepeat(key) {
    ...
}

onKeyPressedAndRepeat(key) {
    ...
}
Every input handle. onKeyPressed is for when a key is pressed. onKeyReleased is for when a key is released. onKeyPressedRepeat is when a key is pressed repeatedly. onKeyPressedAndRepeat is when a key is pressed repeatedly but with a small wait after the first pressure (generally used for menus).

Copy
draw3D() {
    ...
}

drawHUD() {
    ...
}
After updating datas, the draw functions are called. draw3D is for drawing 3D stuff, and drawHUD is for 2D one.

Copy
close() {
    ...
}
And finally the close function contains all the things to do when the scene is removed from the stack.

WindowBox & WindowChoices
How to have windows in scenes.

WindowBox
You can use the WindowBox class in Core module to draw window boxes with specific content. You'll be able to draw stuff like that:


Here is an example of window box declaration in a scene:

Copy
this.exampleWindow = new RPM.Core.WindowBox(x, y, w, h, { 
    // The following options are optional
    content: new Graphic.Text("myText"), // The content is a Graphic.Base
    padding: [0, 0, 0, 0], // [x, y, x, h] for box padding
    limitContent: true // If checked, the content will be cut according to padding
});
And then you can draw this window, in drawHUD of the scene:

Copy
drawHUD() {
    this.exampleWindow.draw();
}
WindowChoices
You can also use WindowChoices class in Core module for displaying several WindowBox as a choice.


Here is an example of window choice use in a scene:

Copy
this.exampleChoices = new RPM.Core.WindowChoices(x, y, w, h, [new Graphic.Text("A"), new Graphic.Text("B")], { 
    // The following options are optional
    listCallbacks: [myfunction1, myFunction2], // List of all the callback functions to excecute when pressed.
    orientation: OrientationWindow.Vertical, // The orientation of the window (horizontal or vertical)
    nbItemsMax: 2, // Max number of items to display on the choice box
    padding: WindowBox.SMALL_SLOT_PADDING, // Padding of the box
    space: 0, // Space between each choice in the box
    currentSelectedIndex: 0, // The current selected index position in the choice box
    bordersInsideVisible: true // If checked, each choice will have an individual window box
});
Handle the inputs:

Copy
onKeyPressed(key) {
    this.windowChoicesCommands.onKeyPressed(key, this);
}

onKeyPressedAndRepeat(key) {
    return this.exampleChoices.onKeyPressedAndRepeat(key);
}
onKeyPressed is for handling callbacks (functions) when pressing enter in a choice. The 2nd argument here is this but you can replace it by whatever you want to repalce the this inside the callback. onKeyPressedAndRepeat is for handling move keys to switch between choices.

And then you can draw the choices, in drawHUD of the scene:

Copy
drawHUD() {
    this.exampleChoices.draw();
}
Graphics
In the examples for WindowBox and WindowChoices, we are using Graphic.Text class. In fact there's a lot of classes in the Graphic module. Here are the most interesting.

Graphic.Text
Display a simple text.

Copy
new Graphic.Text('mytext', { 
    x: 0, 
    y: 0, 
    w: 0, 
    h: 0, 
    align: Align.Left, 
    fontSize: Utils.defaultValue(Datas.Systems.dbOptions.v_tSize, Constants.DEFAULT_FONT_SIZE), 
    fontName: Utils.defaultValue(Datas.Systems.dbOptions.v_tFont, Constants.DEFAULT_FONT_NAME), 
    verticalAlign: AlignVertical.Center, 
    color: Utils.defaultValue(Datas.Systems.dbOptions.v_tcText, System.Color.WHITE), 
    bold: false, 
    italic: false, 
    backColor: Utils.defaultValue(Datas.Systems.dbOptions.v_tcBackground, null), 
    strokeColor: Utils.defaultValue(Datas.Systems.dbOptions.tOutline, false) ? Utils.defaultValue(Datas.Systems.dbOptions.v_tcOutline, null) : null
});
Graphic.TextIcon
Display a simple text with an icon.

Copy
new Graphic.TextIcon("myText", iconID, { 
    side: Align.Left, 
    align: Align.Left, 
    space: Constants.MEDIUM_SPACE
});
Graphic.Message
Display a complex text with tags. It's used in ShowText command.

Copy
new Graphic.Message("<b>myText</b>", facesetID);
Graphic.Player
Drawing the player in choice box like in the main menu or drawing the player informations like in battles.

Copy
new Graphic.Player(player, reverse);
Graphic.PlayerDescription
Drawing the player in choice box or drawing the player description.

Copy
new Graphic.PlayerDescription(player);

Datas & System
The JSON files handle.

The Datas folder mainly contains every System lists associated to a JSON file. The System folder contains classes in Datas lists, so it always contains a read function with json as parameter. Example with System.Animation:

Copy
/**
 *  Read the JSON associated to the animation
 *  @param {Record<string, any>} json Json object describing the animation
 */
read(json) {
    this.pictureID = Utils.defaultValue(json.pid, 1);
    this.positionKind = Utils.defaultValue(json.pk, AnimationPositionKind
        .Middle);
    this.frames = [];
    Utils.readJSONSystemList({ list: json.f, listIDs: this.frames, cons: AnimationFrame });
    this.rows = Utils.defaultValue(json.r, 5);
    this.cols = Utils.defaultValue(json.c, 5);
}
In MVC (Model View Controler) pattern, you can see System and Datas classes as Model one.

It will contain all the datas read from JSON files. Those files are generated thanks to RPG Paper Maker engine. The difference between System and Core classes is that System are always dependent to a JSON file.

Common classes
How are used the Common classes in Common folder.

Constants
This countains only static properties. It's used to get very general constants.

Enum
This contains every Enumeration classes.

Interpreter
The interpreter used to evaluate formulas. This only contains the evaluate method.

IO
This contains every methods linked to file readding/writting.

KeyEvent
This class is used to replace the Web KeyEvent class. We can use it to convert Qt keys (Qt is the framework used for RPG Paper Maker engine) to JavaScript keys.

Mathf
This contains every methods related to math calculation.

Paths
This contains every paths values and especially JSON files paths.

Platform
This class is specific to the platform (desktop, web, android, iOS). This contains properties and methods very specific to the platform you are currently using.

ScreenResolution
By default, the screen resolution is 640x480. So when the screen resolution is different, we need to recalculate the elements size. For that we are mainly using getScreenX and getScreenY.

Utils
This contains a lot of general utilities methods.

Event commands
Event commands handling.

The folder EventCommand contains every Event command class. Those classes are interpreted thanks to Core.ReactionInterpreter. The Manager.Events will be the one sending events to objects. Then, when receiving the event, the object will instanciate a new Core.ReactionInterpreter.

An EventCommand class will contain these methods:

Copy
initialize() {
    return null;
}

update(currentState, object, state) {
    return 1;
}

onKeyPressed(currentState, key) {
}

onKeyReleased(currentState, key) {
}

onKeyPressedRepeat(currentState, key) {
    return true;
}

onKeyPressedAndRepeat(currentState, key) {
    return true;
}

drawHUD(currentState) {
}
The initialize method is the Object that will be named currentState in the other methods parameters. In the update method, you need to return the number of node that will be added to the current node position in the reaction. So if you return 0, you won't move and keep updating this command. If you return 1, you'll go to the next command after the current one.

How to create a plugin
Here are the steps to make a new plugin

Now that you have all the keys to start your own plugins, let's do it!

Open the scripts manager:


You can also check the System, Libs and Shaders folder files in the different tabs.

Let's create our first plugin now. Double click on an empty plugin and create an empty one.


You'll have an access to several options with the Edit tab:


Name: The plugin name. It should be unique in your project.

Author: You can put your name here.

Description: Describe what is doing your plugin.

Version: The plugin version. It should have the following format: X.X.X.

Website: A website url related to your plugins.

Tutorial: A tutorial url related to this specific plugin.

Category: The plugin category. It can be:

Battle

Menus

Map

Others

Parameters: The plugin parameters. We'll see more how it works below.

Commands: The plugin commands. We'll see more how it works below.

You also have access to Code tab if you want to directly edit the plugin code inside the engine instead of Visual Studio Code.


If you check in Visual Studio Code, you will see that a new folder was created in the Plugins folder.


Everytime you create a new plugin, a folder with the plugin name is created. This folder will contain:

code.js: The JS file containing your plugin code.

details.json: All the details of the plugin (like author, description, parameters, etc...).

Let's try to just create a plugin displaying "Hello world" in the console!

Copy
import { RPM } from "../path.js"

const pluginName = "MyFirstPlugin";
const inject = RPM.Manager.Plugins.inject;

console.log("Hello world!");
Now you can play test. To display the console, press CTRL + ALT + I.


You can also access to RPG Paper Maker datas thanks to RPM module import:

Copy
import { RPM } from "../path.js"
So you'll have to use RPM module before any other System module. For example:

Copy
import { RPM } from "../path.js"

const pluginName = "MyFirstPlugin";
const inject = RPM.Manager.Plugins.inject;

console.log("Hello world: " + RPM.Core.MapObject.SPEED_NORMAL);

Great! It works!

Inject code in the app
Let's see how to extend the System app. We can use the inject function imported by default when you create a new plugin (line 4):

Copy
const inject = RPM.Manager.Plugins.inject;
Inject function syntax
The Inject function is designed to replace the prototyping that'd normally be required to alter existing classes, inject is more streamlined and doesn't require you to alias as it does this for you.

Here is how it would look like to inject an existing method without the inject function:

Copy
let alias_load = RPM.Scene.TitleScreen.prototype.load;
RPM.Scene.TitleScreen.prototype.load = async function() {
    await alias_load.apply(this);
    console.log("Title screen loaded!")
}
This will create an alias alias_load, then we'll rewrite the prototype of load method from RPM.Scene.TitleScreen. We use apply to call the alias, which is the default RPM behaviour when loading title screen, and then we add our own code after that, so it will display "Title screen loaded!" when title screen finished loading.

Now, here is how it looks like when using inject function:

Copy
inject(RPM.Scene.TitleScreen, "load", async function() {
    console.log("Title screen loaded!");
}, false, false, true);
It looks more simple and clear!

Here are the details of each arguments in comments:

Copy
inject(
    RPM.Scene.TitleScreen, // The class that you want to inject/overwrite code into.
    "load", // The variable/function name you want to inject/overwrite code into.
    async function() { console.log("Title screen loaded!");}, // The new variable/function you want to inject/overwrite.
    false, // Indicate here if the variable/function is static (NOTE: Both a static and non static variable/function can exist at the same time with the same name). (DEFAULT: false)
    false, // (FUNCTIONS ONLY) If true, overwrite the code (no original code will be called). If false, inject the code. (DEFAULT: false)
    true); // (FUNCTIONS ONLY) Excecute original function's code before your code if true. (DEFAULT: true)
Do not use arrow function syntax (() => {}), arrow functions do not have "this" and therefore will not work when injecting, use function instead (function() {}) as in the examples. 

Extension of 'this'
Due to the nature of inject there are two new values added to it's this:

callResult: if loadBefore is set to true and the function is a return function this will give the result of the first function, this way you could alter/pass through it's value.

super:  If you want the alias call to be conditional, or happen in the middle of your code, it's recommended you only call super if overwrite is set to true or you will call the alias twice

Example of use:

Copy
inject(MyClass, "myFunction", function() {
    if (this.isOk()) {
        console.log("this is my class :)");
    } else {
        this.super(); // Will not overwrite in some condition
    }    
}, false, true, false); // Overwrite use
 
inject(MyClass, "myFunction2", function() {
    if(this.callResult === 2) {
        return 4;
    } else {
        return this.callResult; // Return the original code return
    }
}, false, false, true); // No overwrite, loadBefore
Let's try an example of use!
Now, let's try to edit an existing function prototype in RPM code. As an example, let's try to display an icon in the title screen. What we will need to do is extend two functions:

load: To load the icon to display

drawHUD: To draw the icon loaded

Copy
import { Datas } from "../../System/index.js";
import { RPM } from "../path.js"

const pluginName = "MyFirstPlugin"; // Change the plugin name here
const inject = RPM.Manager.Plugins.inject;

// Load the icon
inject(RPM.Scene.TitleScreen, "load", async function() {
    this.pictureIcon = RPM.Datas.Pictures.getPictureCopy(RPM.Common.Enum.PictureKind.Icons, 1);
}, false, false, true);

// Draw the icon
inject(RPM.Scene.TitleScreen,"drawHUD", function() {
    this.pictureIcon.draw(200, 200);
}, false, false, true);
And it works!


Static functions / variables
Not every variable / function is part of the class instance, some are statically assigned to the class and can therefore be accessed without the need for a instance of that class.

Copy
const inject = RPM.Manager.Plugins.inject;

class myClass {
    static myStaticFunction() {
        return 2;
    }
}

inject(myClass,"myStaticFunctions", function() {
    return 4
}, true, true, false);
Parameters
Let's go back to our previous example with icon diplayed on title screen. Imagine that we would like the user (people that would use this plugin) to be able to choose the icon ID to display. Here the parameters can be used!


In the code side, you'll need to edit the load function to get the iconID parameter. To get a parameter value, use getParameter(pluginName, parameterName).

Copy
inject(RPM.Scene.TitleScreen, "load", async function() {
       this.pictureIcon = RPM.Datas.Pictures.getPictureCopy(RPM.Common.Enum.PictureKind.Icons, RPM.Manager.Plugins.getParameter(pluginName, "iconID"));
}, false, false, true);
So now, the plugin users can change the parameter value like this:


Commands
You can also associate your plugin to a custom event command! Awesome! Let's create a very simple example. We'll create a command named print that will print the wanted text in console. Here we create on the editor side:


Now that it's created, let's edit the plugin code again to register the command action. We need to define it thanks to registerCommand(pluginName, commandName, commandFunction).

Copy
RPM.Manager.Plugins.registerCommand(pluginName, "console", (text) => {
    console.log(text);
});
To use this command, create an event command Plugin... and select your plugin and your command.


When triggering it, this will print your text to the console!


Complex parameters
You can choose to specify more complex values for parameters. The first one is Custom structure, this is similar to an Object in JavaScript.


Don't forget that the returned parameters are System.DynamicValue after deep parameter searching. So if you want to get the x value, you'll need to do RPM.Manager.Plugins.getParameter(pluginName, "Size").x.getValue().

The other one is Custom list. It's similar to an Array in JavaScript.


Same thing for custom lists, don't forget to get the dynamic value! In this example you can get the first list value withRPM.Manager.Plugins.getParameter(pluginName, "Size")[0].getValue().

All the other values like Hero, Monster, Weapon will simply return the ID value.

Export a plugin (online submission)
To submit an online plugin, please follow this github wiki guide: https://github.com/RPG-Paper-Maker/RPG-Paper-Maker/wiki/Online-plugins-submission.

FAQ
Frequently Asked Questions

Can I make my character sprite object bigger?
Are there similar features found in mainstream RPG Makers?
*Because this engine is still in development, some classic features are currently missing. However as time goes on you can expect to see most of what you need*

Yes. The engine automatically cut the picture so you can make it any size. Just make the picture be multiple of the square size (16px).

Are there all features from RPG Maker?
Yes, but with a twist. 

Where it counts, instead of giving you limited, exact replica features - this engine gives you a framework that allows full customization and creation of old features along with some new ones. Some features are of course replicas, because you can't always improve what works. 

Many commands allow use of variables in place of static numbers. You can create a database of hitboxes, fonts, camera angles, etc; and then reference them in event commands for easy access. 

You will find familiar database windows and layouts. Familiar 'Move Hero' and 'Change Variable' commands. All slightly enhanced. 

What are the supported pictures formats?
It can take a bit of time to get used to, but this type of framework allows you to make gameplay systems in a fraction of the time and code. And it's close enough to mainstream editors to reduce the learning curve. 

.png, .jpg.

How large of a game can I create?
For now the max map size is 1000 x 1000 squares. But there will be a feature for connecting large maps to create really huge maps, like open world games.

Is 4K resolution supported?
No. The engine can support up to 1080p. 

Is there a built-in image editor?
Not at this time. You will have to use external programs then import the resources. 

Can you use GIF files for animations? 
GIFs are not supported at this time. You will have to use standard methods like any RPG Maker. 

Is it possible to make real time battles?
For the default battle system, turn based is the only option at this time. Other types of combat systems are planned, such as tactical battle system. 

There are enough commands to create a custom battle system to mimic most games, from Pokemon to Star Ocean. But with more planned commands this will become even easier. 

What is the tile size?
By default the value is 16x16, but you can change it to any value. Your resources should match, being multiples of whatever you set the tile size to. (32x32, 48x48, etc)

Questions from Discord
---Q---
How to create footstep sound effects?
---A---
This depends on how your hero moves. By default this movement is in the "Hero" model, in the code for pressing the keys for each direction. It moves you by 1 step. If you add a sound effect here, it will play too fast. 

You could change the movement from step to square, moving in one full tile. If made to wait until complete, you can put the sound effect after the move and it plays with the correct timing. However this causes bugs with collision(try walking up slopes). 

---Q---
How to import a custom file?
---A---

One possible solution for step movement is that every time you take a step it turns on a switch. This switch is contained in a conditional branch that checks itself to be OFF, so it can only run one at a time. 
Another event is turned on by the switch and plays the sound effect. It waits the proper amount of time, around .4 seconds, and turns OFF the switch. This allows your next step to trigger another sound effect. If you have stopped moving, no further sounds. 


---Q---
How to create item drops? (I assume in an ABS style game)
---A---
For repeat drops, use the "Create object in map" command. This will allow you to spawn as many copies of the same thing as you want. 
Start by creating a new Model. Name it and assign the graphic. Add the code. 
Now go to the map object that spawns the item drop. Set up the trigger for dropping. 
Add the "Create object" command and choose your item drop model. 
A drop will be spawned out of thin air using the graphic and code set up in the model. 
Using this method you will need to manually keep track of IDs if you want to do anything other than spawn them. Despawn, move around, change, all require an ID to be assigned. 

When you make a new project you determine the folder path. To find your project's resource folders navigate to that folder and open /resources/app/Content/ and you will see all the subfolders for each type of resource. Start by adding your files here. 

Let's say we're talking about killing an enemy and it drops an item. You can use states to simply change the graphic and code without adding any new objects. This means both can't be displayed at once(the coin laying next to the dead body). 

In the editor some of these resources will be ready to use right away. Some have their own lists and you need to add the resources to this list. 

Another method is to create an object in advance and make it invisible. When activated it is moved to any place on the map it is needed. This has the benefit of having preset IDs that can be organized in advance. 

You can drag files into these folders while the engine is open. You may need to need to save, open a database window, or reload the project for changes to appear. Most things are safe to add. If a resource has been added to one of the lists, make sure you update the list before removing the resource from the folder to avoid problems. 

---Q---
How to zoom out the camera, or do anything with the camera? first person view
---A---
One method is to make multiple copies of the same Camera Property and change the zoom level in each. Then use the "Change Map Properties..." command to switch between Camera Properties of varying levels of zoom. A variable can keep track of the current zoom level and the code to change map properties also changes this variable. This might be useful in a game that otherwise limits how much you can turn the camera. It can carry between maps with some extra code.

---Q---
How to create footstep sound effects?
---A---

The straightforward method is to use the "Move Camera..." command. However each time you teleport to a new map these changes will be lost. 
When using the equals operation, any box with a 0 will change the camera. So use plus or minus so it only alters the fields we use.
Put a number only in the Distance field. This is the distance between the target object and the camera. A larger number moves the camera farther away. 0.5 is first person view and 600+ is a bird's eye view. The default number is 300. 

This depends on how your hero moves. By default this movement is in the "Hero" model, in the code for pressing the keys for each direction. It moves you by 1 step. If you add a sound effect here, it will play too fast. 

The default camera is whichever Camera Property is set to the Map Properties of the starting map. Under Systems/Camera Properties is where you can create different presets. Each map is assigned one and it can be changed by command. 

You could change the movement from step to square, moving in one full tile. If made to wait until complete, you can put the sound effect after the move and it plays with the correct timing. However this causes bugs with collision(try walking up slopes). 

Moving the camera in every other way with the "Move Camera" command can be complicated. You should learn some of the basics and figure out what is needed for each situation. 

One possible solution for step movement is that every time you take a step it turns on a switch. This switch is contained in a conditional branch that checks itself to be OFF, so it can only run one at a time. 
Another event is turned on by the switch and plays the sound effect. It waits the proper amount of time, around .4 seconds, and turns OFF the switch. This allows your next step to trigger another sound effect. If you have stopped moving, no further sounds. 

*Link to a detailed guide for moving the camera around*

---Q---
How to create item drops? (ABS game style)
---A---
For repeat drops, use the "Create object in map" command. This will allow you to spawn as many copies of the same thing as you want. 
Start by creating a new Model. Name it and assign the graphic. Add the code. 
Now go to the map object that spawns the item drop. Set up the trigger for dropping. 
Add the "Create object" command and choose your item drop model. 
A drop will be spawned out of thin air using the graphic and code set up in the model. 
Using this method you will need to manually keep track of IDs if you want to do anything other than spawn them. Despawn, move around, change, all require an ID to be assigned. 

---Q---
How to import a resource file?
---A---
When you make a new project you determine the folder path. To find your project's resource folders navigate to that folder and open /resources/app/Content/ and you will see all the subfolders for each type of resource. Start by adding your files here. 

Let's say we're talking about killing an enemy and it drops an item. You can use states to simply change the graphic and code without adding any new objects. This means both can't be displayed at once(the coin laying next to the dead body). 

In the editor some of these resources will be ready to use right away. Some have their own lists and you need to add the resources to this list. 

Another method is to create an object in advance and make it invisible. When activated it is moved to any place on the map it is needed. This has the benefit of having preset IDs that can be organized in advance. 

*Show video of new in-engine pop up hints*

You can drag files into these folders while the engine is open. You may need to need to save, open a database window, or reload the project for changes to appear. Most things are safe to add. If a resource has been added to one of the lists, make sure you update the list before removing the resource from the folder to avoid problems. 

---Q---
How to set variables/run code right away when starting a new game?
---A---
There are 2 possible locations where the first lines of code can be run. The starting map is going to be which ever map the object marked as hero starts on. On this map you can use the Map Properties or a map object. 
*Show examples*
Needs testing, but in the past having both of these run at the same time caused a problem and it wasn't consistently picking the same one to run first. So you should only have one to avoid conflict. 

---Q---
How to speed up various animations?
---A---
In Systems, you will find a group of settings called Frames. This applies to most animations in the game. Some other animations have their own settings that override these. 

The first box is "Map frame duration". By setting this to a number you are making it static throughout the whole game. By setting it as a variable, you can adjust in game before displaying a certain animation to possibly get varied speeds. Needs testing. 

The "Animation frames" applies to all charsets. They all have to match. 

The remaining settings apply to each labeled area. 

*There should be more detailed information somewhere else*

---Q---
How to do line of sight and proximity detection?
---A---
Proximity detection is the easy part. There is a built in command called "Send event". You can create hitboxes of any size, summon them, and see if any objects are hit by them. By creating a circle hitbox and summoning it on the player, it will detect anything within that range. Followed by any code for a reaction. 

A simple form of line of sight can be done with the above method, plus some code to track which direction the object is facing. The object has to be facing the target(likely the hero) in order for the reaction to trigger. This won't allow walls to block sight. 

A method that does allow walls and certain objects to block the line of sight is more complicated. This will likely have to be a built in feature for future release, or added via script/plugin. It might be possible with event commands, if someone was motivated enough. 

---Q---
How to heal characters?
---A---
This one works a little different from most engines. There is no specific command to heal because HP is altered the same as every other stat. You use the "Change a statistic" command as needed. 


---Q---
How to disable camera movement in certain rooms only?
---A---
This will depend on how you handle camera movement. By default it's found on the "Hero" model. 

The easiest way would be to put a conditional branch around the code for moving the camera so you can disable it all with a switch. When you enter a map where the camera should be disabled you simply turn ON the switch. However using conditional branches on models in this way causes a bug, so we can't do that. 

You can use another state on the "Hero" model that is a duplicate of the normal model except the code for moving the camera is removed. Don't forget to switch it back. If you use many states for other things in your game this can become very complicated. 

If you want to change the default way, you can move the code to another object. Then you can do more with it. One example is that on the model when you press the key to turn the camera, it doesn't contain any code. Only a call out to another object that does contain the code, where using conditional branches should work. Needs testing. 


---Q---
How to change what hero the player controls?
---A---
This is going to depend on a few things. 

Remember, the object you control at the start of a new game is something you designate. On this first map that object will have it's normal ID. However when you teleport to any other map, the ID changes. If it was 10, and you teleport into a new map that also has a 10, there would be a conflict. So the hero object becomes ID 0 and each new map retains it's normal ID. This need confirming.

The reason this matters is because several other commands reference "Hero", like "Move object" and "Send event". Which is this special object you are teleporting around the maps. If you want to change the object you are controlling, it will change how certain things interact. 

You can use the "Move object" command to simply change the sprite used and all the other code will remain the same. 

The main way you will change what the hero sprite looks like is to change the state on the Hero object/model. If you make a new state it will not contain any code for moving. So you always want to copy the state and change the graphic. Then remove any code that doesn't apply.

You can create other objects to use as placeholder for the other members of your party when switching. The Hero object state is changed and it's teleported to another spot, where one of the placeholders was standing. 

*I created a test project where 4 different objects are used for 4 heroes and the player can switch between them. In my experience if you plan to use this method, abandon the object designated as Hero and do not use "Hero" in the target drop down for anything. You have to create a system that uses variables to determine the target. *

---Q---
Why can't I move the hero?
---A---
I'm going to assume it was already working and suddenly stopped working. If you are new to the engine and your first play test has a non-moving hero - check out *some guide for making a new project TBD*

Did you change anything related to hero movement? 
Have you been tweaking the code for key inputs or the hero model? 
Check your code and undo the changes if possible. Consult a default project to see how the hero model works. 

A common problem is that a different object on the map has the 'Block hero when reaction' option enabled, and it's running all the time. Meaning the hero is frozen while that object is processing. Check all recent objects you added. If it's enabled by mistake go ahead fix it, otherwise you will have to change how that object is coded. 

There could also be another object that is trying to move the hero. Perhaps a cutscene triggering when it shouldn't. Check any objects/common reactions that alter the hero in any way; move hero command, changing the state, etc.  

-If this only happens on a certain map, and this map allowed walking on that spot before, but now it doesn't- 
Make sure there are tiles actually painted there and they can be walked on.
Make sure you painted the correct tile where the hero is getting stuck. Some tilesets can have duplicate tiles that can't be walked on. 
Make sure there are no layered tiles on top that can't be walked on. You can try to erase and redraw, ensuring the correct layer is chosen.  
Check the database/tilesets section to ensure the tiles are correctly configured.

Check the collisions for hero and map objects.

If you still can't move, report it. It could be a bug. 

 
---Q---
What size are the resources? make templates for all resource types and list sizes
---A---
For most of your resources there are no set sizes. The size will be determined by tile size, image size, frames, etc. There is no simple list like some other RPG Makers. 

The most relevent factor is tile size. All your resources should be divisible by the tile size. In the editor when you work with various elements like tilesets, hitboxes, collisions; your selection box size is determined by the tile size. If your graphics aren't divisible you won't be able to select whole pieces. 

There are many reasons to change the tile size but I recommend using the tileset as the base value. Drawing maps is pretty important and you need to be able to draw a single tile of the smallest size by default. For larger sprites, they occupy multiple tiles on the tileset and you simply draw them in a group. For most of the other resources the tile size doesn't matter. You simply create a canvas in multiples of the tile size and draw images of any size within them. 

This allows you to draw maps with tiles of 16x16 and make characters of any size. 

The effects of making a larger tile size need testing. 

WIP 

Does it require more processing/cause lag? Make a test map and find out how large you can make the tile size/chars before a basic map shows signs of lag. Then change the tile size to 16, changing nothing else, does it still lag?

If you make tilesets and characters really large, how does it affect other resources like battle animations?

With larger tile size, do maps need to be made larger to compensate? 
Or is the map width tied to tile size? (Tested, and it is)

Does it change how "move object" commands work? Perhaps more of a problem if tileset and characters have a large difference in size.

Does it affect the camera? Perhaps just larger values needed to move the larger distance?

/WIP

Types of Resources

        Tilesets
A single tile is equal to the tile size setting. Your tileset resource file can be of any size in multiples of the tile size. 

To determine the width and height of your resource file consider the following:

        How will it look in the editor? 

The display box for your tileset can be resized and you will have a scroll bar if it's too large for the display box. Since it's much easier to scroll up and down, you might want to consider a tall, skinny file. 

Find out how much map editor space you want to balance it with, and use that to determine how many tiles wide your file is. I like about 11 tiles wide, then infinitely expanding down. When I need more room I simply make a larger file by adding to the bottom. 

The height limit is unknown, but so far has reached 912px without any sign of a problem. That's a single tileset file with 627 tiles in it. 

        How large of an object do I want to draw on the map?

In a typical retro game your character is 16x16. A tree might be 16x16. You might see some larger things like mountains or buildings at 32x32. When you add these things to a tileset it's possible to highlight the entire sprite and paint it in the map with a single click, instead of drawing each individual tile. So you may want a very wide tileset to make room for all the large sprites you will be drawing.

Drawing in this way can be tricky when it comes to centering. If you selected a large section of the tileset, let's say it's a house, it will always be drawn flush with the ground. The door touching the ground. If it's an even number of tiles, it will fit to the grid. If it's an odd number of tiles, it will not align one side to the grid. It will place it centered within the grid. You may need to adjust the position on the tileset to get the result you need. 

*Some large sprites are better placed as objects/character sheets, but some things are easier on the tileset. Find what works best for you.*

        Characters
The first step in making a character resource file is to make a single frame. The minimum size of this frame is equal to the tile size. 

Draw your sprite. If the sprite needs to be larger than the minimum tile size, then increase the size of the frame by multiples of the tile size. This can be done in either direction, as long as it's divisible by the tile size. 

16 x 16, 16 x 32, 32 x 16, 32 x 32, etc. 

If you increase the size of the frame, make sure you center the sprite inside the new frame. If it's not flying, make sure the bottom of the sprite is at the bottom of the frame. 

Once you create this frame, all other frames in the resource file MUST be the same size. If the sprite inside one of the frames is smaller, it still needs the uniform frame size. 

Now that you have a single frame, you will copy and paste it multiple times for form a grid. Each row is a direction so there will always be 4 rows. The number columns depends on System/animation frames. By default it's 4. So for a default character sheet paste it enough times to form a 4x4 grid of frames. If it's animated you would update each frame as needed.

The frame on the left is the starting frame. 

When the engine reads a character resource file it calculates all that in reverse to determine the size of a single frame and how to animate. It cuts it into 4 rows for direction, and divides by animation frames. That is why you can make a character of any size. 

When making characters in new sizes, test how a single frame looks in game. You might need to make adjustments to it's position within the frame and it's best to figure it out early in the process. 

        Battle Sprites
This works like Characters. Each row being a certain stance: idle, attacking, getting hit, etc. The number of columns depends on a different setting, Systems/battler frames. The main difference is that there is also an option for battler rows, allowing you to create more stances. 

There is no size limit. You can make large battlers by increasing the frame size to allow for larger sprites, just like above. 

         Battle Animations
There is no size limit, but any animation file has to be a grid of 5x5 frames. The frames can be any size and do not have to match the tile size. However if your game uses large tile size and large resources, you will need to scale up the size of animations. 

          Pictures
These can be any size up to 4096x4096 pixels. This is a hard limit. 

You can use .png and .jpg file types. 

WIP

list of other types

bars
facesets
gameover
icons
titlescreen
windows skins
autotiles
mountains
3d objects
particles
skyboxes
walls

all these need further testing and information

/WIP

---Q---
How to see sprites during top down view?
---A---
Not available at this time. There are planned features to alter how sprites are drawn relative to the camera so they are always visible. 

---Q---
How to create a clock/timer?
---A---
To create a timer you have a few methods. 

There is a built in timer command, but it's limited in scope. You can set timers and then use events to set a trigger. Needs further information/testing. 

The other main method is to use waits and variables. Have an object run on a loop where the code is:

wait 1sec
variable TIMER +1
IF TIMER =10
    put your code here

Every second the variable increases by 1 and you use a conditional branch to check when the timer reaches a certain amount to trigger some code. You can decrease the wait to 0.1 for milliseconds, you then have to increase the IF to 100. Or 0.01 for more accurate time. This will depend on what it's used for. 

That is for a variable counting up. If you want a variable to count down: 

Object 1
variable TIMER =10

Object 2
wait 1sec
variable TIMER -1
IF TIMER =0
   put your code here

You would set it to 10 somewhere that only triggers once, change the code to subtract instead, and a branch to tell when it reaches 0. Again, which method and accuracy you choose will depend on what you're trying to do. 

For a clock, perhaps a feature or script will be added in the future. 

Using basic commands, the variable counting method works well. Have a common reaction that always runs and simply has:

wait 1sec
variable TIME +1

This will have a single variable keeping track of seconds. You might add exceptions so time doesn't count when in battle for example. Just put this inside a conditional branches that makes sure a certain Switch is OFF. Like battle. When you get into a battle turn the switch on so time doesn't continue. After battle turn the switch ON to resume time. You can also change the speed of time by increases the variable by a larger amount. You can increase the TIME variable by other variable, so the player has control of time. 

There might be a way to make a formula to divide by 60 and so on to turn seconds into a readable time like 3:28 PM. But I accomplish like so:

wait 1sec
variable TIME +1
branch - IF TIME equals 60
    variable MINS =1
    variable TIME =0

Every 60 seconds a minute is counted and the seconds are reset. Then you add a branch to check if MINS =60 and add an HOUR. If HOUR equals 12, or 24, reset them all. You get the idea. 

To see the current time the most basic method is a Show Text command where you input variables instead of text:
[var=1] : [var=2]   : [var=3]

(hours  :  minutes : seconds)

You could create a complex system that shows pictures for each number. Hopefully future features will allow direct drawing of text or numbers on screen using variables so this can easily be drawn on the screen without any downsides. 

---Q---
Where are the default resources located?
---A---
If you didn't change the install directory you can find them at:
C:\Program Files (x86)\RPG Paper Maker\Engine\Content\BR\Content\

It's best not to edit these directly or remove them from this folder. You can copy them to your project folder and edit the duplicates. 

---Q---
How do I place objects in the air?
---A---
In RPM the width and height of the map are the X and Z coordinates. The height of an object is the Y coordinate. In the editor you can hold CTRL and UP/DOWN ARROWS to change which plane you are drawing on. If enabled, you will see the grid move up and down. This will help you pick the right Y level. (You can also use CTRL + Scroll wheel). 

Make it a habit to reset the Y back to ground level after you draw something at a different height. It's not fun to draw a lot of tiles on the wrong level and have to redo it all. 

---Q---
How do I change the font?
---A---
First make sure the font files are in your projects /Font folder. Don't put them in the engine folder. 

Then click the Fonts button along the top of the editor. Move the fonts from the right side to the middle. You can rename the files here, but you will also have a chance to give them names in another spot. 

Now go to System and you will see the 2 groups that deal with font. Size and Names.

It's a good idea to set the sizes early on. Some fonts won't look good in the default sizes because they are rather small. Be aware that this will affect menus and shops, so do some testing for your specific fonts.

The first item in Font Names is your default font. Therefore this is where your title screen font is set. You can add many other fonts to the list and change them with commands. Double click or edit an item and give it a name. Basic allows you to name the font or use a variable. Font ID allows you to choose from a dropdown. 

When you use a "Show Text" command, one of the dropdowns here let's you choose the font. You can even use different fonts in the same text box. Any changes here are temporary and won't affect the menu or future show text commands. 

To change the font for good use the "Set dialog box options" command. You can change size and font by checking only those boxes and nothing else. Anything that shows words will use this new default value. 

---Q---
How do I connect 2 maps?
---A---
The most common method is to use an object placed on the tile the player will step on to move to another map. It might be the edge of a map, a hole in the ground, or a door to a house. 

The type of object will determine how it's triggered. A door might require the event be "Hero Action". A typical map transition will use a "Hero touch" event. 

In the code you will have a "Teleport Object" command. At the top make sure the player object is selected(usually Hero but can be something else). You have multiple options to choose which map you end up on. Most of the time you will click the select button and pick a specific spot. 

Sometimes there may be many tiles that the player can touch to be teleported to another map. Maybe the entire edge of the map. You could make copies of the above event and paste them along the entire edge, but there is an easier way. If you are not already, track the player's coordinates. Have some object always running with the following code:

Variable(HEROX) = object HERO x square position
Variable(HEROZ) = object HERO z square position
wait 0.1 sec

The size of that wait determines how accurate the coordinates are. A smaller values checks the coordinates more often, but can cause lag if it's checking too much. You can only move so fast anyways. Too high and you might move 2 tiles before it checks again. 0.1 is usually good for all purposes. To reduce lag you might try 0.2 and it will still be fairly ac

The top left corner of the map is 0,0. The X coordinate is the first number and it runs from left to right. The Z coordinate is next and runs from top to bottom. Lets assume a map of 20x20. All the tiles along the right side of the map will have a X value of 0. So at any point if the hero coordinates have 0 as a value for X, that means the player is touching the left edge. So you would put in the code for teleporting to that map. And a single object is covering the entire edge. 

Where you end up is going to be a problem. You probably want it to match the same area on the next map. For that you need to use the "Map ID" section of the teleport command. You will need the number value of the map you're going to. The X value is going to be the right edge of the new map, so you will need to look that up. (remember the first tile is 0, so the 20th tile will be X=19). You can then plug in the Z variable, which was part of the tracking, to place the hero on the same Z tile as the previous map. This creates a system similar to early Zelda games. 

There is mention of a future feature for linking maps that might be easier than the above. 

It's also possible to not use objects at all and instead put multiple branch checks after each coordinate update. If X = 12 AND Z = 4, then you know the hero is stepping on a doorway and you put the teleport code here. That way you can keep all teleport related code in a single object, although it becomes a little abstract. Add comments that say which teleport each branch is, like "enter hero house", or "fall in well". It also allows you to reduce the number of objects on a map, which in some cases can cause lag on large maps if you have too many objs.   

---Q---

---A---

---Q---

---A---







I got an error message, how can I report it?
How do I stop X from walking through Y?
How do I put things on walls?
How do I change the default player sprite?
How to make quick time events?
How to make puzzles, mini-games?
How to make custom menus?
How to make custom battle system?
How to make caterpillar system/visible teammates?
How to make skill system/level up system?
How to make item crafting?
How to make ammunition for gun type weapon in battle?
How to make quest/journal system?
How to make options for volume, etc?
How does TP work?
How to make team/combo attack?
How to make summon magic?
How to make weather?
How to make projectiles?
How to make party switching menu?
How to display a variable on screen?
How to track hit detection?
How to display a map / minimap?
How to make events move on long complicated routes?

What file types can be used for music?
How to use battle formulas?
How large can a sprite be?
How do I make the enemies bigger in battle?

How to do actions like:
Jump
Push
Pull
Pick Up
Throw
Slide
Climb
Swim

How to make a:
Chest
Door
House
Bridge
Stairs


List of YouTube tutorials
Wood

This is a tutorial based on Paper Maker 1.6.1 and the game I made with it, Goblin Quest. Download the game and the assets used with it in #projects https://drive.google.com/file/d/1jwdLfHUBIpbazcFTrcSwXz42D9QyA7BU/view?usp=sharingGoogle DocsRPG Paper Maker Tutorial #1 - Goblin Quest.pdf
 

!Marc🦈: 

https://www.youtube.com/playlist?list=PLgifsmdb86qtMVTCW3J14dfWeNdPGGoeh Useful tutorials by Cid. (Maybe still up to date?)(edited)YouTubeCid's RPG Paper Maker TutorialsComplete playlist of all my RPG Paper Maker tutorials.

 Cid331: 

https://youtu.be/56BeodBay60YouTubeDigital ContainerRPG Paper Maker Tutorial - #013 Transportation

terikumo: 

i messed up in the previous video, so i remade it https://youtu.be/ynVupoA5ApUYouTubeterikumoRPG Paper Maker Tutorial - Beginner: The Basics (#1)


Placeholder
Tutorials from Discord




Copy
RPG PAPER MAKER - how to have/make custom sprites. by Reptile
 So... Let we go to to System menagement (shortcut: 1) - and there we have System tab. On the very left, there is dialog options frame MAP PROPERTIES There you find Square size (in px), this is where you say what is the size of your tiles (map elements). By default, it is 16x16 pixels. And as you take a look at the sample tileset, it goes like this

Every square of the tileset is 16x16. Your tileset file (PNG) it has to be made in similar way. 8 columns, and as rows as many as you wish. But here is the deal - if your tile in the map properties is set to example: 20 then remember, every element in the tileset it has to be 20x20 if you set 22, then 22x22 etc. USUALLY! Tilesets are 16x16, 20x20, 24x24, 48x48...

This is for tilesets, now let we talk about CHARSETS CHARSETS Again in the System management, System tab, below this Map properties there is another dialog box group option called FRAMES This is what you are interested in, if you want to change your characters frames etc.



Map frame duration - this is the speed animation rate for our charset, you can change the numbers to see the result. Usually I do not touch this since I am ok with it. Default: 150 Animation Frames - this decides for how much frames your charsets (all charsets!) in the game will have. Default: 4 Default charsets in RPM are using 4 frames.



the animation it goes like: 1 - 2 - 3 - 4

Notice that frame 1 and 3 is the same.

Now if you wish to have MORE FRAMES of animation, you can insert there (in animation frames) 5 So the animation will be: 1-2-3-4-5 Charset while not moving - has frame #1 as idle.

CHARSET TEMPLATE

The same rule as above for tilesets, user is deciding the size of the charset. It can be whatever you want. BUT there is one rule: EVERY FRAME it has to have the same size (width x height) As here in this template take a look:

Every square frame in this charset template has size: 32x32 if you would like to have taller charsets - hey, no problem, just you have to make first square bigger (example: 32x100), if you make like this, then remember - EVERY SQUARE HAS TO HAVE THE SAME SIZE (32x100)

EXAMPLE OF MAKING MORE FRAMES

So let we give more frames to our characters...

In animation frames I set "5", so every charset will have 5 frames.

My charsets look like this:



and this is also the animation, when it walks: it is 1-2-3-4-5 when it stands and wait, it is 1





of course this is just a test, as you can see I used a taller charset model (rip from suikoden) and I had change the last frame to standing green outfit. The animation is not good of course :wink: but it works and you can use them for some tests.

BATTLERS



Battler frames - how many frames the battler should have. Default: 4 Battlers rows - how many rows, animations poses the battler should have Default: 9 As for animation, and size - rules are the same as for charsets. Animation play like: 1-2-3-4 As it goes for Battler rows, battler animation poses, notice that some states require this option. Take a look at Datas manager, Status tab. There is Death and notice the option Battler possition is set to 8



Why 8? Because take a look at the Kate.png battler - 8 is the last pose, and it is "death" or "KO"

But in options there was 9, why 8?

Because I believe RPM is still in development, and battler poses it counts starting from "0"

BATTLER TEMPLATE



Take a note, it is the same rule as charset when it goes to size, and animation. Default frames are 32x32 - you want bigger battlers? No problem, set your 1st frame bigger (example: 50x50), and then also the rest of the frames also have to be 50x50. You want to have more animation frames? Chenge the option Battle frames, and in the file make more frames. Simple as that. Now last note, Battler rows, as for now I do not see more options for it. I mean you can use it in State (Death/KO), later on once there will be other states (Sleep/Dizzy/Poison etc) I believe it will be handy to set your own pose for that state. Maybe it would be also cool to have a feature to set your own animation (battler position) for skills! :slight_smile: But we will see.

* * * @Darkand - there you go, hope those infos were bit helpfull.

To the others moderators ( @Wano :smile: ) if you think this tip/notes are ok/useful, you can copy them and post on site, or pin them on discord or something.



---



 MadToastCrunch: 

How would I make an entrance to a cave?

MadToastCrunch How would I make an entrance to a cave?

 Draw a map, where you will see the entrance to the cave. On the entrance to the cave make a OBJECT (event) that looks like this: - no graphic - On the right you have events change that to hero touch - command: Teleport object - choose Hero - choose CAVE MAP - Position select and OK Done. Do not forget to make the same way EXIT from the cave.

in my experience the teleport happens so fast that I add a small wait of around 0.4 after it, so the player doesn't accidentally walk back into the teleport if they are holding a movement direction. depending on where they end up on the other side


--------


SaltedSporks: 

Eyy I found out how to copy and paste between projects! https://saltedsporks.itch.io/our-pigmented-bonds/devlog/241022/entry-9-dev-log-replace-copy-and-paste-maps-between-projects-tutorial-rpg-paper-makeritch.ioEntry 9 - Dev log + Replace /Copy and Paste Maps Between Projects ...There have been come major updates to the game. One of them gaining our new member to the team, Strange Sentinel! He's going to be helping me code some of the levels of the game. I've decided to find...


 SaltedSporks: 

Realized I made a tutorial about how I made rain in RPG paper maker, so I thought I'd share it! https://saltedsporks.itch.io/our-pigmented-bonds/devlog/226687/entry-4-devlog


KevinOfNine:

Using Weather

texture can be anything of course. it's actually possible to make it alternate between different texture by running another command with all the same values, but a different texture. however it needs to run in a loop for as long as it should be raining. you may want to use the wait and time feature, as needed. I made a test where it rains cats and dogs xD had to 

number of portions. simple, how many objects to have on the screen at one time, in one ray portion(explained below). dont make it too low, other wise you end up with big gaps(10 is too low for rain, imo). 

ray portion, is how much of the map gets the effect. or, how far out from the center it displays. when set to 1, it only rains on a small rectangle centered on the player. this is the default for rain. for snow it does 2 portions, therefore it draws snow further out from the player. you can kind of tell when it's swirling that it extend far out. I dont know the exact benefits of changing this, I suppose more gives depth but also would cause lag if too high. and you probably wouldnt see it all anyways 

size is the scale of the texture. you want to keep it small. but it depends, maybe you want it to rain down large rocks and lava from an erupting volcano. 

depthtest, this determines if it interacts with the map or if it shows the particles on top of everything. when ON, its a bit more laggy. I have a low end PC and when it's ON I get slight lag and if its OFF there is no lag. but when it's OFF, it looks TERRIBLE. when on, the particles will disappear when they touch part of your map 

depthwrite, not sure. probably a way of storing values of how far the textures are falling? probably not for the average user

Initial velocity - its default speed. negative values for falling. I suppose you could make bubbles and have them go up with a positive velocity, for an underwater map. 

velocity addition, better known as acceleration. by default this is a very very very small value with good reason. it will keep going and accelerate itself into a blur if allowed to go too high. if you adjust this, keep the numbers small initial 

y rotation. this determine how straight the textures fall. 0 is normal falling, like snow with 0 wind. as you increase it, it puts a spin on how it falls, like snow with some wind. although it appears to always move in a cyclone. again, use small values. 0.5 makes it rotate pretty hard 

y rotation addition, acceleration of this value. another one you want to keep very very small. I put something like 0.005 and it only took a few minutes for the slow cyclone to turn into a blur. probably not something to mess with, change the initial rotation and leave it be.