OpenBOR Manual

From Beats Of Rage

(Difference between revisions)
Fight'nWords (Talk | contribs)
(OpenBoR Manual)
Next diff →

Revision as of 22:06, 24 April 2008

Contents

OpenBoR Guide

by Fugue & Bloodbane Last updated on 2008-04-19-

General Info

Beats of Rage

Beats of Rage (sometimes referred to as BoR) is a 2D beat 'em up game engine originally made by Senile Team. It is inspired by the Streets of Rage series, the popular 2D beat 'em up games made by SEGA for the Genesis console. This game uses SNK made King of Fighters (one player versus/fighting style game) characters as its sprites for heroes and enemies. It features combos which are performed by tapping the attack button sequentially after the first hit, jumping and jumpattacks, SoR2 (Streets of Rage 2) style special attacks, Capcom fighting game style grabattacks and SoR2 style throws. There are various different enemies in the game, some of them can perform upper attacks to hit jumping heroes, break free from grabs, grab or throw heroes; SoR2 style bikers will also attack you. You can find useful items like food and 1Up's throughout the game.

This game is moddable, which means people can modify an existing mod Pak or even create a whole new one. The idea behind modding is simple: it involves providing pictures, sprites, wavs and animated gifs sometimes converting them for use in the mod and controlling different actions with text files for making heroes, enemies, levels etc. This game engine has attracted many people who together, have formed the BoR (Beats of Rage) community. Due to the desire for more features from the original BoR engine and because of many requests, some coders and programmers stepped in to improve BoR, adding many new features and functionality. The new features came in the form many different BoR engine variations e.g OpenBoR, DarkBoR and HOR. OpenBoR has by far the most features and so this manual was created to describe them.

The Beats of Rage mod is comprised of a Pak file or files (the game file(s), to be placed in the Paks directory) and engine (the BoR.exe and other files). The reason why mods are kept in Pak files apart from the engine is because you can keep as few or as many as you want. The completed Pak isn't initially editable as is, so before you begin modding you first need to unpak it. After modding is finished, the mod should then be packed so it can be played. It is possible to play a mod without packing it, but it's best to pak it in order to make it neat. Even though the idea of modding is simple, BoR has many features which have their own usage and their own place, usually declared in text files. This manual is for explaining these specific features and exactly how they are declared. The latest OpenBoR build supports scripting but it's features are not yet included here.

Getting Started

Before you can begin modding, you'll need a few things. Because there are so many required files and the complexity of using them, it's highly recommended to start modding by editing an available mod or Pak instead of creating everything from scratch. One helpful tool is the BoREdit pack located at http://www.senileteam.com/ . The pack contains enough basic information to start a mod.

Extracting an existing PAK File:

  • You'll need a program called PAXPLODE.exe which can be downloaded from http://www.lavalit.com/. You need to register there first before you can download anything.
  • Put this program in the same folder with the .Pak that you want to 'explode'.
  • Run this command: paxplode.exe [pakname] to 'explode' the Pak. [pakname] is the name of .Pak file (.Pak is included).
  • If you do it right, a window showing DOS messages about extracting files will appear.
  • The extracted files should appear in a new folder named DATA.
  • NOTE: Some people using Windows XP report that the files aren't always found in the same folder. If that happens, find the folder named DATA on your harddisk. It's unknown why this would happen, although it does seem to work with Windows 98SE.

Inside the DATA folder, there should be various other folders: BGS, CHARS, LEVELS, MUSIC, SCENES, SOUNDS and SPRITES. There should also be some text files i.e models.txt, levels.txt, lifebar.txt and video.txt and pal.act. Each text file has it's use which will be explained below. Pal.act is the global palette which every sprite in a mod, or even used per level, must share. You need Adobe Photoshop or a comparable program to view and make .act files. Each folder contains files and texts related to the folder name- so BGS contains background pictures and palettes, CHARS contains character's sprites and texts, etc.

NOTE: Some folders aren't required, meaning you can place all of your files in the same folder (but still within the DATA folder) and it would still work (provided the paths are correct). However it's recommended you use different folders like the above examples to make modding easier. You can add other folders if you need to, just make sure the paths are correct. Mods that are paxploded can be played as is.

Playing paxploded PAK:

  • Put bor.exe in same folder as DATA folder (if you are still using old BoR engine).
  • If you are using OpenBoR, put OpenBoR.exe, every .dll and other folders like LOGS, MENU, PAKS, SAVES and SCREENSHOTS which come with it in same folder as DATA folder. Don't forget to put empty .Pak in PAKS folder. You can get empty .Pak from BoREdit pack.
  • No matter which engine you're using, you can play the mod by running the .exe.
  • NOTE: This is how modders test their mods without packing them.

As for modding itself, the easiest method is to modify certain files instead of making new ones. Since there are many files you might need to modify or make, read the explanation of what each text does below to know what to do with them. Once you're done and satisfied with your mod, the last step is packing it.

Creating a PAK File:

  • You'll need a program called PACKER.exe.
  • Put the program in the same DATA folder that contains your mod.
  • Run the command: packer.exe [packfile] DATA. [packfile] is the name of the Pak you want to create. The name DATA can be replaced with another name if you like, but let's use that name.
  • If you do it right, a DOS window showing messages about packing files will appear.
  • The .Pak file should then appear in the same folder.

MODELS.txt

This text file determines which entities are loaded and when. This file is mandatory and determines general settings for models. The Models.txt must be placed in the DATA folder. How this is used is described in the Entity Files section below.

ajspecial {bi}

Input mapping for special attacks and blocking.

  • {bi} (default: 0)
    0 = Players use their Special animation with the special key, Attackboth animation with Attack + Jump keys and cannot Block.
    1 = Special key will play Block animation if available. The Special attack is mapped to Attack + Jump keys. Attackboth is not available.
  • This has no effect if the entity does not have a Block animation.
autoland {int}

Ability of entities to land after being thrown or hit with certain attacks.

  • {int} (default: 0)
    0 = Players can input Up + Jump when hitting the ground after being thrown or hit with certain attacks (see damageonlanding) to land safely.
    1 = Same as 0, plus players automatically land safely if thrown by another player. Pits will still be a danger, of course.
    2 = Safe landing is not available.
  • If available, the Land animation will be played. This is highly reccomended, as otherwise the entity will instantly return to Idle upon landing, which will probably look rather silly.
colourselect {bi}

Availability of the color map select feature.

  • {bi} (default: 0)
    0 = Players cannot select color maps.
    1 = Players can select color maps on the select screen by pressing up and down to cycle through available choices.
  • If a remap is used for a character's fmap or some remaps are hidden with hmap, they will not be selectable.
  • That's "colour" with a u, not "color". Some countries spell it different ways.
nocost {bi}

Energy cost behavior for Special (loss of mp or health). See energycost for details.

  • {bi} (default: 0)
    0 = Special always costs energy to use.
    1 = Special will only use energy if it hits something.
nodropen

Enemy falling behavior on respawn.

  • No argument. By default all enemies onscreen are knocked down (no damage) when a player respawns. Simply declaring nodropen will leave enemies standing on player respawn instead.
nolost {bi}

Weapon loss behavior when grappling.

  • {bi} (deafult: 0)
    0 = weapon is lost when grappling opponents.
    1 = weapon is retained when grappling opponents.
blockratio {bi}

Damage behavior when blocking attacks.

  • {bi} (default: 0)
    0 = Blocking nullifies all damage.
    1 = Entity recives .25 of intended damage when blocking.
mpblock {bi}

Resource consumed by block damage (see blockratio).

  • {bi} (default: 0)
    0 = Block damage is applied to health only.
    1 = Block damage is applied to mp. If mp is insufficient, damage will be applied to health.
  • This has no effect if blockratio is not active.
nochipdeath {bi}

Behavior when entity has insufficient resources to withstand block damage (see blockratio).

  • {bi} (default: 0)
    0 = Block damage can reduce the entity's health to 0.
    1 = Block damage cannot reduce the entity's health below 1.
  • This has no effect if blockratio is not active.
noaircancel {bi}

Ability to cancel jumpattacks with other jumpattacks.

  • {bi} (default: 0)
    0 = Jump attacks can be canceled by other jump attacks at any time.
    1 = Jump attacks can be canceled, but only when the current attack animation is complete.
    2 = Jump attacks cannot be canceled.
versusdamage {bi}

Ability of players to attack each other. Overrides in game options menu.

  • {bi} (default: 0)
    0 = Players can't hit each other.
    1 = Players can hit each other.
spdirection {b1} {b2} {b3} {b4}

Direction of entitys in character select menu.

  • {b1} (default: 1)
    0 = Player 1's entity faces left.
    1 = Player 1's entity faces right.
  • {b2} (default: 0)
    0 = Player 2's entity faces left.
    1 = Player 2's entity faces right.
  • {b3} (default: 1)
    0 = Player 3's entity faces left.
    1 = Player 3's entity faces right.
  • {b4} (default: 0)
    0 = Player 4's entity faces left.
    1 = Player 4's entity faces right.
maxattacks {max}

Maximum number of normal attacks (attack#).

  • {max} (default: 4)
    Available attack#.
  • By default, a player entity uses attack(1-3) as it's basic attack chain and an AI controlled entity performs attack(1-4) randomly. These defaults can be changed with atchain.
maxattacktypes {max}

Maximum number of attack/pain/fall/death types. When entity is hit with a given attack type, it will play the appropriate reactive animation.

For example, if entity is hit with an "attack6" attack box:
-If the attack does not knock entity down, it will play its Pain6 animation.
-If the attack knocks the entity down, it will play its Fall6 animation.
-If the attack kills the entity, it will play its Death6 animation.
-If the entity does not have the matching Pain#/Fall#/Death#, it will default to Pain/Fall/Death.

  • {max} (default: 10)
    Maximum available attack types.
  • Attack type is determined by a numbed attack box command (see attack#) within an animation. Do not confuse this with the attack# animations, as they have nothing to do with each other.
  • Burn and Shock are simply pre-labeled attack types (thus there are actually 12 available attack types by default). They have been retained for backward compatibility. There are also Blast, Steal, and Freeze types, but these have special effects and lack corresponding reactive animations.
maxfollows {max}

Maximum number of available followups.

maxfreespecials {max}

Maximum number of available freespecials.

lifescore {int}

Score and extra life ratio.

  • {int} (default: 50000)
    >0 = Points required to gain a life.
    0 = Player's cannot gain a life through scoring.
credscore {int}

Score and extra credit ratio.

  • {int} (default: 0)
    >0 = Points required to gain a credit.
    0 = Player's cannot gain a credit through scoring.
Load/Know:

Loading and caching of entities.

  • know {name} {path}
    {name} is a name that the game will use to identify the entity.
    {path} is the location relative to OpenBoR of the entity's .txt file.
    These entities are only placed in memory when actually needed. Used for everything but FLASH.txt and heroes.
  • load {name} {path}
    {name} is a name that the game will use to identify the entity.
    {path} is the location relative to OpenBoR of the entity's .txt file.
    The entity is always in memory. Used for flashes, heros, weapon-holding heros, and hero's projectiles.
  • You don't need to load music, sound, system, or stage files. This is used only for entities.

LEVELS.txt - General Settings

This text file determines how many game modes (or difficulty) are declared in the mod and what levels and scenes each game mode has. This file is mandatory and determines general settings for levels and HUD. Due to so many features, it's divided into two parts. This part is for general level settings and HUD settings while the second part (Level sets below) is for game modes settings. Levels.txt must be placed in the DATA folder.

noslowfx {bi}

Type of sound playback on a hit.

  • {bi} (default: 0)
    0 = Hit sounds will be played slower for higher damage.
    1 = Hit sounds always play at same speed.
hiscorebg {bi}
  • If set to 1, the high score screen will have a background. Normally, it's just text on black.
completebg {bi}
  • Determines whether custom stage complete screen is used or not.

0 = no custom screen is used. A black screen with texts will be shown instead.

1 = custom screen is used.

  • The custom stage complete screen must be named complete.gif, must be non-animated gif and placed in data/bgs/ folder.
maxplayers {int}
  • Determines how many players could play at same time.
  • {int} could be 1, 2, 3 or 4.
  • This setting can be overriden by same command in level sets (see below).
showcomplete {x1} {y1} {x2} {y2} {x3} {y3}
  • Determines the position of "STAGE # COMPLETE".
  • {x1} and {y1} determines "STAGE"'s position.
  • {x2} and {y2} determines the number's position. This number shows the completed stage's number.
  • {x3} and {y3} determines "COMPLETE"'s position.
  • x and y are the number of pixels, right and down respectively, from the top left corner of the screen to the top left corner of the life bar.
clearbonus {x0} {y0} {x1} {y1} {x2} {y2} {x3} {y3} {x4} {y4}
  • Determines the position of "Clear Bonus" and its scores for each player.
  • {x0} and {y0} determines "Clear Bonus"' position.
  • {x1} and {y1} determines Player 1's score bonus' position.
  • {x2} and {y2} determines Player 2's score bonus' position.
  • {x3} and {y3} determines Player 3's score bonus' position.
  • {x4} and {y4} determines Player 4's score bonus' position.
  • x and y work exactly like they are for 'showcomplete'.
  • The score will only be shown if the respective player is present when stage completes though.
lifebonus {x0} {y0} {x1} {y1} {x2} {y2} {x3} {y3} {x4} {y4}
  • Determines the position of "Lives Bonus" and its scores for each player.
  • {x0} and {y0} determines "Lives Bonus"' position.
  • {x1} {y1} {x2} {y} {x3} {y3} {x4} {y4} works exactly like for 'clearbonus' except that they are for life bonus.
totalscore {x0} {y0} {x1} {y1} {x2} {y2} {x3} {y3} {x4} {y4}
  • Determines the position of "Total Score" and its scores for each player.
  • {x0} and {y0} determines "Total Score"'s position.
  • {x1} {y1} {x2} {y2} {x3} {y3} {x4} {y4} works exactly like for 'clearbonus' except that they are for Total Score.
p{#}life {x} {y}
  • Determines the position of player's life bar.
  • {#} determines which player this setting is for and its possible values are 1, 2, 3 and 4. There's no space around {#} though.
  • {x} and {y} are the number of pixels, right and down respectively, from the top left corner of the screen to the top left corner of the life bar.
p{#}icon {x} {y}
  • Determines the position of player's icon.
  • {#} determines which player this setting is for and its possible values are 1, 2, 3 and 4. There's no space around {#} though.
  • {x} and {y} are the number of pixels, right and down respectively, from the top left corner of the screen to the top left corner of the icon.
p{#}mp {x} {y}
  • Determines the position of player's MP bar, if player has MP that is.
  • Works exactly like p{#}life, except it affects player's MP bar instead.
p{#}lifex {x} {y}
  • Determines the position of player's "x". Which "x"? the "x" between lifebar and number of lives player has that is.
  • {#} determines which player this setting is for and its possible values are 1, 2, 3 and 4. There's no space around {#} though.
  • {x} and {y} are the number of pixels, right and down respectively, from the top left corner of the screen to the top left corner of "x".
p{#}lifen {x} {y}
  • Determines the position of player 1's current number of lives. In case you haven't figured it out, the number on the right of lifebar is player's lives.
  • {#} determines which player this setting is for and its possible values are 1, 2, 3 and 4. There's no space around {#} though.
  • {x} and {y} are the number of pixels, right and down respectively, from the top left corner of the screen to the top left corner of the number.
p{#}score {x1} {y1} {x2} {y2} {x3} {y3}
  • Determines the position of player's status.
  • {#} determines which player this setting is for and its possible values are 1, 2, 3 and 4. There's no space around {#} though.
  • {x1} and {y1} determines player's name position.
  • {x2} and {y2} determines player's "-" position. Yes, there is "-" between name and score.
  • {x3} and {y3} determines player's score position.
  • x and y are the number of pixels, right and down respectively, from the top left corner of the screen to the top left corner of the name, "-" or the score.
p{#}namej {x1} {y1} {x2} {y2} {x3} {y3}
  • Determines the position of player's "Select Hero", Name text, continue, credits and "GAME OVER" when joining the game.
  • {x1} and {y1} determines player's name position.
  • {x2} and {y2} determines "Select Hero"'s position.
  • {x3} and {y3} determines "Press Start"'s position. These also sets "GAME OVER" and credits position.
  • {#} determines which player this setting is for and its possible values are 1, 2, 3 and 4. There's no space around {#} though.
  • {x} and {y} are the number of pixels, right and down respectively, from the top left corner of the screen to the top left corner of the text.
p{#}shoot {x} {y}
  • Determines the position of weapon's counter when shootnum is used.
  • {#} determines which player this setting is for and its possible values are 1, 2, 3 and 4. There's no space around {#} though.
  • {x} and {y} are the number of pixels, right and down respectively, from the top left corner of the screen to the top left corner of the text.
mp{#}icon {x} {y}
  • Determines the position of magicbar's icon.
  • {#} determines which player this setting is for and its possible values are 1, 2, 3 and 4. There's no space around {#} though.
  • {x} and {y} are the number of pixels, right and down respectively, from the top left corner of the screen to the top left corner of the icon.
p{#}iconw {x} {y}
  • Determines the position of player's icon for players with weapon.
  • {#} determines which player this setting is for and its possible values are 1, 2, 3 and 4. There's no space around {#} though.
  • {x} and {y} are the number of pixels, right and down respectively, from the top left corner of the screen to the top left corner of the icon.
e{#}life {x} {y}
  • Determines the position of the life bar for the entity which most recently hit/was hit by/touched/interacted with player. Nothing will be shown if that entity hides his/her/its status though.
  • {#} determines which player this setting is for and its possible values are 1, 2, 3 and 4. There's no space around {#} though.
  • {x} and {y} are the number of pixels, right and down respectively, from the top left corner of the screen to the top left corner of the life bar.
e{#}icon {x} {y}
  • Determines the position of the icon for the entity which most recently hit/was hit by/touched/interacted with player. Nothing will be shown if that entity hides his/her/its status though.
  • {#} determines which player this setting is for and its possible values are 1, 2, 3 and 4. There's no space around {#} though.
  • {x} and {y} are the number of pixels, right and down respectively, from the top left corner of the screen to the top left corner of the icon.
e{#}name {x} {y}
  • Determines the position of the name for the entity which most recently hit/was hit by/touched/interacted with player. Nothing will be shown if that entity hides his/her/its status though.
  • {#} determines which player this setting is for and its possible values are 1, 2, 3 and 4. There's no space around {#} though.
  • {x} and {y} are the number of pixels, right and down respectively, from the top left corner of the screen to the top left corner of the name.
p{#}smenu {x1} {y1} {x2} {y2}
  • Determines the position of players in select screen.
  • {#} determines which player this setting is for and its possible values are 1, 2, 3 and 4. There's no space around {#} though.
  • {x1} and {y1} determines player's position.
  • {x2} and {y2} determines player's "Ready!" position.
  • x and y are the number of pixels, right and down respectively, from the top left corner of the screen to the player's offset (for x1 and y1) or to the top left corner of "Ready!" text.
noslow {bi}
  • Determines whether or not the level slows down when the boss is defeated.
nohit {bi}
  • Determines whether or not players can hit each other.
  • This is overridden by the main menu option controlling the same feature.
lbarsize {w} {h} {noborder} {type} {orientation} {border} {shadow} {graph} {backfill}
  • Controls the size of lifebars.
  • This applies to players, enemies, items, etc (their lifebar will all have the same width, height, etc). If 'olbarsize' is declared, this only applies to players.
  • {w} is the maximum amount of health the bar can display. Defaults to 100.
  • {h} is the height of the lifebar in pixels. Defaults to 5.
  • {noborder} turns on or off the border and shadow around life bars. {0} means there is, {1} means no outline or shadow.
  • {type} is a flag that sets how lifebar show health. 0 (default) means if an entity's health goes over width, the life bar will wrap around and 'double up' on top of itself (1 unit of health is 1 pixel long.). 1 means the lifebar is shown in percent based.
  • {orientation} is a flag that sets lifebar's orientation. 0 (default) means horizontal while 1 means vertical.
  • {border} sets layer adjustment of outer border. Default to 0.
  • {shadow} sets layer adjustment of border shadow. Default to 0.
  • {graph} sets layer adjustment of graph fill. Default to 0.
  • {backfill} sets layer adjustment graph background. Default to 0.
  • The last 4 variables can be used to place lifebar behind player 'icon' or 'bgicon'. To do that you need to give value like -300.
mpbarsize {w} {h} {noborder} {type} {orientation} {border} {shadow} {graph} {backfill}
  • Controls the size of mpbars.
  • Works exactly like 'lbarsize'.
olbarsize {w} {h} {noborder} {type} {orientation} {border} {shadow} {graph} {backfill}
  • Controls opponent's lifebars size. If not available, 'lbarsize' will be used.
  • Works exactly like 'lbarsize'.
timeloc {x} {y} {w} {h} {noborder}
  • Controls the position of the clock timer.
  • To change the font, you'll need to work with the font file, not this command.
  • {x} and {y} control how far right and down (respectively) the timer is from the top left of the screen.
  • {w} and {h} control the dimensions of the border placed around the timer. If your timer is being displayed under the border or is off-center, try editing this.
  • {noborder} turns on or off the outline around the timer. {0} means it's there, {1} takes it away.
  • The default values are 149, 4, 21, 20, and 0, respectively.
timeicon {path} {x} {y}
  • Determines the position of timeicon. Timeicon is optional icon that can be place d behind timer to make timer looks cooler ;).
  • {path} is the location relative to OpenBoR of the icon's .gif.
  • {x} and {y} are the number of pixels, right and down respectively, from the top left corner of the screen to the top left corner of the icon.
rush {flag} {duration} {text1} {f1} {f2} {text2} {f3} {f4}

This sets up a hits/combo counter. If it is activated, text will appear onscreen indicating the number of current consecutive hits and maximum consecutive hits the player has achieved.

  • As long the player hits something consecutively, the hit counter will keep incrementing. It doesn't matter if player hits the same enemies/obstacles, others, etc.. Juggling hits are also counted.
  • {flag} is integer value which activates this counter.
    0 = counter is off.
    1 = counter is on.
    2 = counter is on and maximum hits is always displayed.
  • {duration} sets how long the counter will be on before it expires.
  • {text1} sets what text to be displayed for hits counter.
  • {f1} sets which font to be used for {text1}.
  • {f2} sets which font to be used for hits counter's number.
  • {text2} sets what text to be displayed for maximum hits.
  • {f3} sets which font to be used for {text2}.
  • {f4} sets which font to be used for maximum hit' number.
  • Fonts are selected by reference number. Fonts available as of version 2.1796 (04/18/2008):
    0 = font.gif
    1 = font2.gif
    2 = font3.gif
    3 = font4.gif
    4 = font5.gif (optional)
    5 = font6.gif (optional)
    6 = font7.gif (optional)
    7 = font8.gif (optional)
    *Make sure the optional fonts are available before using them!
loadingbg {set} {bx} {by} {bsize} {tx} {ty} {tf}
  • This command allows custom loading background to be displayed while models are being loaded.
  • The background must be named loading.gif and placed under data/bgs/ folder.
  • {set} determines how loading screen would be.

-1 = default black screen with loading and status bar.

0 = no loading screen.

1 = loading screen background and status bar.

  • {bx} and {by} determines x and y coordinates of loading bar top left's location respectively.
  • {bsize} determines loading bar's length.
  • {tx} and {ty} determines x and y coordinates of "LOADING" text location respectively.
  • {tf} determines used font for "LOADING" text.

0 = font.gif

1 = font2.gif

2 = font3.gif

3 = font4.gif

loadingbg2 {set} {bx} {by} {bsize} {tx} {ty} {tf}
  • This command allows custom loading background to be displayed while levels are being loaded.
  • The background must be named loading2.gif and placed under data/bgs/ folder.
  • The other variables have same effect with 'loadingbg'.
itemtrans {bi}
  • This makes dropped items transparent. Make sure the items have transparency set before setting this.
custfade {int}
  • {int} determines how long it takes for music to fade out.
musicoverlap {bi}
  • Determines if the music fades in and out when changing (1), or stops and restarts (0). Defaults to 0.
scrollspeed {spd}
  • {spd} was either 1 or 2. It determined how fast the screen scrolled when a player reached the edge of the screen.
  • This command has been removed. The screen will now automatically speed up if your character is fast enough.
single {bi}
  • Sets 'maxplayer' to 1.
  • This command is outdated. Use 'maxplayer' instead.

LEVELS.txt - Level Sets:

Just to reiterate, this is the second part of levels.txt section. This part is for game modes settings.


set {name}
  • Marks the start of a difficulty level.
  • {name} is the name of the difficulty which will be selectable from the difficulty select menu.
nosame {bi}
  • Determines whether or not Player 2 and Player 1 can use the same character at the same time.
noshare {bi}
  • Determines whether or not Player 2 and Player 1 both use the same credits. If set to 1, each player will have their own supply of credits.
lives {int}
  • The player will start with {int} lives.
credits {int}
  • The player will start with {int} credits.
ifcomplete {bi}
  • Can be used to create 'secret' levels if {bi} is set to 1.
  • They aren't really secrets, as the players will still be able to see them on the menu, but they won't be able to select it until they've beaten the game at least once.
  • 'secret' characters can only be used in difficulty settings with 'ifcomplete'.
z {zmin} {zmax} {BGheight}
  • Changes the location of stage boundaries.
  • {xmin} is how high up entities can walk. It starts at the top and works down, so larger numbers mean less room. Defaults to 160.
  • {xmax} is how far down the character can walk. It also goes down from the top. Defaults to 232.
  • {BGheight} changes where the bottom of the background is drawn. Defaults to 160. By changing this value, you can make the background match an altered {xmin}.
  • This can be set once per level. You can change it between two stages. If you need to change it during a stage, you should combine it with the "wall" command in the stage itself.
  • You can spawn entities outside of this range, but once they enter the playing field they can't escape again.
maxplayers {int}
  • Determines how many players could play at same time just for current level set.
  • {int} could be 1, 2, 3 or 4.
  • This setting overrides same command in general settings (see above).
file {path}
  • {path} is the location of a .txt file which describes a level.
  • Level to load here is declared with .txt. How to make and modify these texts are described in Level Files section below.
scene {path}
  • {path} is the location of a .txt file which describes a cutscene.
  • Cutscene to load here are declared with .txt. How to make and modify these texts are described in Cutscene Files section below.
select {path}
  • {path} is the location of a .txt file which sets custom select screen.
  • Select screen to load here are declared with .txt. How to make and modify these texts are described in Select Screen Files section below.
next
  • This command doesn't need any arguments.
  • When this command is reached, the Stage Complete scene will play, and Scores will be tallied.
branch {name}
  • Used to give name to warp destination for endlevel entities which uses 'branch'.
  • {name} is the name of the destination.
  • Used together with 'branch' feature.
end
  • When this is reached, the game will end regardless of the levels after it.
  • There's no point of using 'end' without 'branch' so use this together with 'branch'.
typemp {int}
  • Controls the conditions under which a player's MP can recover.

0 (or leave blank) = players will recover MP slowly over time.

1 = players will recover some MP when they hit an enemy.

2 = players can't recover MP without using items or dying.

cansave {int}
  • Defines how save states work in this level set.

0 = Save state is disabled

1 = Only saves last level (Default value). It's buggy currently though.

2 = Strict save. Lives, credits, HP, MP, weapon, remap color etc are saved. When this saved state is loaded, players immediately enter last level without going to select screen. If it's multiplayer game, you will need partner.

skipselect {name} {name} {name} {name}
  • This command makes select screen and join in selection skipped in current level set. Players will automatically use certain defined player.
  • {name} is the name of loaded player in models.txt (see above). The 1st one is for 1st player, 2nd for 2nd player and so on.
  • MAKE SURE the defined player are loaded before using this!
  • You can empty all values to skip default select screen. However don't forget to set select screen text right after it.

Lifebar.txt

This text file is an optional file for setting lifebar colors. This is for OpenBoR only (not for use in the original BoR). Lifebar.txt must be placed in the DATA folder- make sure it's lifebar.txt, and not lifebars.txt. {R}, {G} and {B} which are used below are color values from 0 to 255 for Red, Green, and Blue. If you don't know what that means, try thinking of them as brightnesses. If you had 0 255 0, then there would be no red, no blue, and all green, so you'd have green. If you had 0 0 0, there wouldn't be anything (no light/all colors), and you'd have black. 255 255 255 would be everything (all light/no color), so it'd be white. 255 0 255 would be red + blue = purple. 128 128 128 would be halfway between white and black, so it'd be grey. If it still doesn't make sense to you, try opening up Microsoft Paint, go to Colors -> Edit Colors -> Define Custom Colors. Try messing around with the Red, Blue, and Green values. It works like that. NOTE: Setting a color to the transparent color doesn't actually make it transparent. The color settings must match one of the colors in the default pallete exactly. If your colors aren't correct, try decreasing every color value by 1- some programs report color values to be higher or lower depending on what they start at, either 0 or 1.

blackbox {R} {G} {B}
  • Determines the color of the 'shadow' around the lifebar and the bar at 500 health.
whitebox {R} {G} {B}
  • Determines the color of the outline around the lifebar and the bar at 600 health and up.
color{#} {R} {G} {B}
  • Determines used color by certain health value. For instance, 'color100' determines used color if health is 100 or less.
  • There's no space between "color" and {#} in color{#}.
  • {#} is the health value at which the color will be displayed and its possible values are 25, 50, 100, 200, 300, 400 and 500.
  • color500 is also used as the background of the lifebar, and is displayed with transparency.
  • If lifebar is displayed in percentage mode (see 'lbarsize' above for info about it), color reference changes to:

color25 = 0-20% health

color50 = 21-40% health

color100 = 41-60% health

color200 = 61-80% health

color300 = 81-100% health

color400 and color500 aren't used.

colormagic {R} {G} {B}
  • Controls the color of the MP bar.
colormagic2 {R} {G} {B}
  • When a player's MP bar is longer than their health, the extra MP is overlaid on top of the first bar in this color, like with health.
shadowcolor {R} {G} {B}
  • Specify default gfxshadow color.

PAL.act:

PAL.act
  • This is the ingame pallete.
  • There are two ways to change or use this file. The first is to use Photoshop, which has built-in support for this format. The second is to use Roel's free online .bmp/.png/.act conversion page. You can find this page at

http://www.senileteam.com/boredit/act.php.

  • If you need the complete original BoR pallette, you can find a copy of the first 128 colors in the lobster boss' alt5.gif frame. Most other frames are missing many colors past 100.

Entity Files

Header Data:

This text is for setting characters or entity's stats and animation and is mandatory. Due to the complexity and number of features, it's divided into three parts. This part is for the entity's stats. The second part is for animation types and describes what animations entity must have or could have. The third part is for the animation settings. Damon V. Caskey has made a useful Character Template. This should help you to get started with your characters. I've been using this template since starting work on mods, and have updated it gradually as new features came online. It saves me a lot of time and hassle keeping my character animations organized, and I figured it might help someone else.

name {name}
  • {name} is the name given to the entity by default.
  • It is a string of 1 to 21 characters. You can actually use up to 40 characters, but the name will stretch off the screen or under the timer, making it look silly. You can also make the name even longer than that, but anything past 40 won't be displayed, so you'll really just be making your life harder.
  • Program will crash on accessing the entity if you try to put a space in the name. You can safely use an underscore (_) instead.
  • It is required- program crashes on access without it.
  • Used for Players, Enemies, Items, Projectiles, and obstacles. Basically, everything.
type {type}
  • {type}
    player = The entity is a human-controlled player.
    enemy = The entity is a CPU controlled enemy or enemy projectile.
    npc = The entity is a CPU controlled ally that will seek out and attack enemies. The entity is otherwise functionally identical to enemy entities with the chase subtype. You can change the NPC allegiance via hostile setting. Npc types do not count toward groups.
    item = The entity is a stationary item which can be picked up. Items can only give one bonus per item. In other words, you can't make one item that both gives 2000 points AND gives a 1-up.
    none = The entity is a useless decoration.
    steamer = The entity constantly spews the object called Steam upwards with alpha transparency.
    obstacle = The entity is a stationary blockade which can (normally) be destroyed.
    text = The entity is a message object. When spawned, it will freeze all objects in play and show it's IDLE animation, then dissapear. It can be sped up by pressing attack or jump. Can be used for level intros, mid-level cutscenes, etc.
    trap = The entity is an obstacle which cannot be attacked. It can be made to attack, though, and will hit both players and enemies. If a trap is not set up to knock the entity down, the trap will only damage the entity one time. To hit them again, the target entity must take damage from another entity.
    endlevel = The entity is an item which, when touched by a player, will end the stage. It can be given a score value to be awarded for level completion.
    pshot = Outdated and does nothing. You can still use it, but it's ignored.
    panel = The entity will scroll together with level. If the entity's speed is 10, entity will stay with panel. If the speed is 5, it will stay with background (for direction left, right and both). This type is used to make multiple layers.
subtype {type}
  • {type}:

arrow: The entity flies from right to left off the screen. You can use the "flip" command when spawning it to make it fly left-to-right.

noskip: Used with text-type entities. It prohibits the player from using attack or jump to skip through text. weapon: Used for player weapons which can be picked up and used. biker: Used for Biker enemies. They fly left and right across the screen and must be knocked off their bikes to be stopped.

notgrab: Does the same thing as the cantgrab command: the entity can't be grabbed. touch: For items. The item will be collected just by touching it. You won't need to press the attack button.

flydie: For obstacles. When hit, the obstacle will fly horizontally offscreen while playing it's FALL animation. both: For endlevel items. If there are two players, both must be touching this item to end the stage.

project: For items. When picked up, this entity is treated like a weapon which doesn't actually change any of the character's attributes except for their projectiles. Works for both players and enemies (if they have a GET animation). chase: For enemies and projectiles. If given to an enemy, he/she will walk towards player all the time. If player is far from the enemy, he/she will run instead. If given to projectile, it will become homing projectile.

follow: For npcs. Will cause an npc to attempt to follow the entity that spawned or summoned it (see below). Uses range setting in idle animation to determine how close it will follow. If the npc exceeds the minimum range and no entities it is hostile towards are nearby, it will move to the spawning entity normally. If it exceeds maximum range, the npc will instantly warp to the spawning entity regardless of what it is currently doing and play it�s respawn animation if it has one. An npc without this subtype will behave exactly like an enemy with the chase subtype. It can potentially follow a hostile across the entire level, and will wander randomly if no hostiles are available.

health {int}
  • {int} is an integer, a number from -2147483647 to 2147483647 (which also happens to be (2^31)-1, if you're a math fan).
  • This is the total amount of damage this entity can take before they die.
  • Do not actually put a boss with 2147483647 health in your game. It's not funny.
  • You can use decimal numbers, but it will always round down, so there's no real point.
  • If you use a value less than one or greater than 2147483647, the enemy starts off dead. Now that IS funny, but not necessarily useful.
  • If the number is greater than the width of the life bar, the meter will "double up" the display. This can make it hard to tell how much life an enemy has remaining sometimes.
  • Not required, but it defaults to zero if it's not there, so that's kind of useless if you don't set it in the level's spawn point.
  • Used for players, enemies, items, projectiles, obstacles.
  • For items, this tells you how much life you regain when you pick it up.
mp {int}
  • {int} is an integer.
  • This is the total amount of MP this entity begins with.
  • MP is drained by attacks set to drain MP. It can be recovered in several ways.
  • You can use decimal numbers, but it will always round down, so there's no real point.
  • If the number is greater than the width of the life bar, the meter will "double up" the display. Since the MP bar is already pretty thin, this can make it hard to tell how much MP you have remaining sometimes.
  • Not required. If a player doesn't have it, they won't have an MP bar displayed.
  • Used for players and items.
  • For items, this tells you how much MP you regain when you pick it up.
credit {int}
  • For items.
  • If an item has this set, it will give player credit when player take it.
  • Keep in mind that only one bonus can be given to an item.
alpha {int}
  • If set to 1, this entity will be displayed with alpha transparency.
  • If set to 2, this entity will use negative alpha transparency (the darker colors are stronger, like shadows).
  • If set to 3, this entity will overlay transparency. It's described in the engine as being a combination of alpha and negative alpha, and the formula is "bg<128 ? multiply(bg*2,fg) : screen((bg-128)*2,fg)".
  • If set to 4, this entity will use hardlight transparency. Seems to be the opposite of overlay. The formula is "fg<128 ? multiply(fg*2,bg) : screen((fg-128)*2,bg)".
  • If set to 5, this entity uses dodge transparency. Described in the code as being "Very nice for a colorful boost of light."
  • If set to 6, this entity will use 50% transparency. The entire entity will be 50% transparent: every pixel will be averaged with the pixel right behind it.
  • This setting DOES NOT work with remaps.
speed {int}
  • {int} is a number from 5 to 300.
  • You can use numbers less than 5, but the entity will still move at the same speed. Same with using more than 300.
  • Somewhere between 100 and 300, the entity will gain the ability to run off the screen edges and out of the play area, killing it instantly. So that might not be a good idea.
  • Setting this to 0 will not stop an enemy from moving. You must use 'nomove' to do that.
  • Used for players, enemies, projectiles, and arrows.
  • This command doesn't support decimals though. For decimal value, use 'speedf' below.
speedf {int}
  • Determines entity's speed.
  • This have same effect with 'speed' but this one allows {int} less than 5 even negative value.
  • Moreover, decimal values are allowed with this. However its value is 10 times speed's value. For instance, 'speedf 1.5' equals to 'speed 15'.
running {speed} {height} {length} {move} {land}
  • Determines the character's running abilities.
  • Used for players and enemies with subtype chase.
  • If present, players can run by pressing left or right twice and holding the button. The free special attack's input also changes to left, right, attack and right, left, attack.
  • If this is not present, the character will be unable to run.
  • {speed} is an integer value which works just like speed.
  • Actually, unlike normal speed, running speed can be greater than 300. Of course, you'd still run off an edge into oblivion if you tried to set a running speed that high.
  • {height} determines how high a character can jump (if at all) while running. It works like jumpheight.
  • {length} is an integer value which changes how far a character can jump while running. It is multiplied by the current jump length.
  • {move} is a binary value.

0 = (default) Character stops running if up or down is pressed. Running enemies can't move up or down.

1 = Character will continue running if up or down is pressed, but will also move up or down at an angle. Running enemies can move up or down.

  • {land} is a binary value. 0 means they stop running after landing from a running jump. 1 means they can continue running if the player holds forward during the jump.
nomove {move} {flip}
  • Can be used to make a stationary enemy (one who does not move).
  • {move} is a binary value which determines if the enemy can or can't move. Setting it to 0 doesn't do anything, but setting it to 1 stops the enemy from moving.
  • {flip} is a binary value which determines if enemies can turn around to face players behind them.
  • If {move} is set to 1, the enemy's speed will default to 0.
jumpspeed {int}
  • This command determines entity's jump speed. This entity must be able to jump obviously.
  • This command doesn't support decimals though. For decimal value, use 'jumpspeedf' below.
jumpspeedf {float}
  • This command determines entity's jump speed.
  • This command supports decimals. However its value is 10 times jumpspeed's value. For instance, 'jumpspeedf 1.5' equals to 'jumpspeed 15'.
jumpheight {int}
  • {int} is an integer value which determines how high an entity jumps.
  • The default value is 4.
  • An entity's jumpheight also affects how far it flys when knocked down, and how high and far jumpframe moves you.
  • For Bomb entities, this controls how high the bomb arcs into the air.
grabdistance {int}
  • {int} determines many things:
  • How close this entity must be to another to grab it.
  • How far away this entity will stand while holding an enemy.
  • How deep this character's attack range is (the range which can be changed with 'z' in LEVELS.txt).
  • How close this entity must get to be stopped by obstacles or pick up items.
  • How close other entities must be to be damaged or blocked by this trap/obstacle.
  • The default value is 36.
throwdamage {int}
  • Changes the amount of damage this entity receives if it gets thrown.
  • Defaults to 21.
throw {dist} {height}
  • Controls the angle at which this player or enemy flies if they get thrown.
  • {dist} is the distance that this entity will fly.
  • {height} controls how high off the ground this entity will get before it starts falling back down.
throwframewait {frame}
  • Sets at which frame in character's throwing animation, throwing will start.
height {alt}
  • Affects an entity's ability to walk under platforms.
  • If the platform is higher off the ground than this entity's height, this entity can move under it. Otherwise, it will get pushed out.
  • Measured from the offset point up.
  • This can only be set once per entity, so test it under multiple animations to make sure nothing goes wrong.
secret {bi}
  • Used to make a 'secret' character who must be unlocked.
  • Secret characters are unlocked after beating any difficulty setting once, and can only be used in 'secret' difficulty levels.
shadow {int}
  • {int} is a number from 0 to 6.
  • Each number corresponds to a specific shadow in the SPRITES folder.
  • Normally, the lower numbers are smaller.
  • This determines which shadow graphic will appear centered at this entity's offset point.
  • 0 means there won't be a shadow.
fmap {int}
  • {int} determines which remap to use by the entity if it gets frozen by an freeze attack (See 'freeze' for more info about freeze attack).
  • You have to declare that remap with 'remap' before using this obviously.
  • If hero has 'fmap' set, the respective remap can't be selected at select screen and continue option.
  • If enemy has 'fmap' set, the respective remap can be used in levels. You might want to avoid using the remap unless you want to see Icemen on your levels.
load {name}
  • {name} is the name of an enemy which will be shot as a projectile.
  • The projectile's type should be "enemy".
  • The projectile must be named "shot", "knife", or "star". If you don't want to use those names (or they're already used), use the knife, star, and fireb commands.
project {name}
  • For subtype "project" items.
  • {name} is the name of the new projectile the player or enemy who grabs this can use.
shootnum {int}
  • For items which can be used as weapons.
  • This is the maximum number of times a weapon can be fired.
counter {int}
  • For items which can be used as weapons.
  • This is the maximum number of times a weapon can be dropped before it disappears forever.
  • To make weapons hang around basically forever, give them a high value like 100,000 or something. If somebody can drop it that many times, they probably don't deserve to hold onto it!
reload {int}
  • For items.
  • If a player picks up an item that has this command, it will restore their ammunition by {int}.
  • Does nothing if a player doesn't have a weapon.
  • Should be used with 'shootnum'.
  • Don't forget that items can only give one bonus.
typeshot {bi}
  • For weapons.
  • Determines if the weapon is a gun or a knife.
  • 0 means a knife, and ammunition will not be displayed, since you can only throw knives once.
  • 1 means a gun, so ammunition will be displayed. It will also appear on the ground if you run out of ammunition while using it.
animal {bi}
  • For players with a weapon.
  • Determines if the weapon is actually an animal to be ridden.
  • Animals will run away if they are knocked down enough times.
  • Players on an animal can't be grabbed.
playshot {name}
  • {name} is the name of an entity.
  • The player shoots this with pshotframe #.
  • This does exactly the same thing as a specifying {name} as a knife. Note: As of version 2.0691, playshot is no longer supported. Use knife instead.
playshotno {name}
  • {name} is the name of an entity.
  • The player shoots this with 'pshotframe #'.
  • Difference with 'playshot' is that the shot entity won't fly forward or in other word, it will stay on ground and not moving. That means it can fall to holes.
  • That also means setting a in 'pshotframe' is useless.
knife {name}
  • Used like "load". {name} will be thrown like a knife.
  • You'll need to use "load {name} {path}" instead of "know {name} {path}" when declaring the projectile in models.txt.
  • Knives can't be used by enemies during a jump. Stars are currently thrown instead.
star {name}
  • Used like "load". {name} will be flung like a ninja star in a jump.
  • This command actually causes three stars to be thrown at three different angles.
  • You'll need to use "load {name} {path}" instead of "know {name} {path}" when declaring the projectile in models.txt.
  • Stars can only be used during a jump.
bomb {name} pbomb {name}
  • This command is different for players and enemies. Players should use "pbomb" and enemies should use "bomb".
  • Used like "load". {name} will be tossed out like a grenade.
  • Bombs start off playing their IDLE animation until one of three things happens:

1: The bomb touches an entity

2: The bomb is hit by an attack

3: The bomb touches the ground

  • After 1 or 2, the bomb will play it's ATTACK2 animation.
  • After 3, the bomb will play it's ATTACK1 animation.
  • After playing it's attack animation, the bomb will disappear.
  • Bombs are thrown in an arc determined by their speed and their jumpheight.
  • You'll need to use "load {name} {path}" instead of "know {name} {path}" when declaring the projectile in models.txt.
hitenemy {canhit} {alt}
  • For enemy's projectile entities.
  • If {canhit} is 1, this entity can hit other enemies, even if they threw this. Obviously, it still can hit players as well.
  • If {canhit} is 0 or left out, this entity can only hit heroes.
  • If this entity is thrown as a bomb, it won't be able to hit the enemy who threw it until AFTER it explodes.
  • {alt} determines when this entity can hit other enemies: 0 means it can hit either while in air or on the ground. 1 means the attack can only hit on the ground.
rider {name}
  • For 'subtype biker' enemies.
  • {name} should be the name of an enemy in MODELS.txt.
  • When the bike is attacked, this entity will fall off.
  • Defaults to "K'" (Yes, with an apostrophe ')
  • If the rider is only loaded with 'know' in models.txt, you should add 'load {name} {path}' in this biker text to ensure that the 'rider' will fall off.
flash {name}
  • {name} is the name of flash animation this entity will use. Defaults to "Flash".
  • This is played when this entity is hit, not when it hits another entity.
  • 'noatflash' is required to make this command is activated.
bflash {name}
  • {name} is the name of flash animation this entity will use. Defaults to "Flash".
  • This is played when this entity blocks an attack.
dust {name}
  • {name} is the name of flash animation this entity will use.
  • This is played when this entity lands on the ground after being knocked down by an attack or after jumping.
  • If it's not specified, nothing will be shown.
nolife {bi}
  • Determines whether or not the player can see the entity's life when they make contact.

0 = they CAN see it. Defaults to 0.

1 = they CANNOT see it.

noquake {bi}
  • Determines whether or not the screen shakes if the entity hits the ground after being thrown.

0 = it shakes. Defaults to 0.

1 = it doesn't shake.

nopain {bi}
  • Used to make the character not playing his/her PAIN animation when hit by a non-knockdown attack. He will continue what he is doing when attacked.
nodrop {bi}
  • Set it to 1 to stop this entity from falling unless he/she/it dies and:

1: There's no DEATH animation

2: There's a DEATH animation, and its 'falldie' flag is set to 1.

  • This entity will play corresponding PAIN animation if knockdown attack hits him/her/it. For instance, attack3 will make this entity play PAIN3 even if it's a knockdown attack.
nodieblink {int}
  • Sets how entity's death animation is played.

0 = entity starts blinking as soon as entity die in respective FALL animation.

1 = entity won't blink until after the last frame of entity's FALL or DEATH animation when killed.

2 = entity won't blink at all during death, and entity will disappear after the last frame of their death animation.

3 = entity will play it's death animation without blinking, and will not disappear until scrolled offscreen. The enemy won't count towards 'group's after dying, even though they don't disappear. This setting ONLY works for enemies.

makeinv {int} {bi}
  • Determines whether or not the character is briefly invincible after being respawned. Otherwise, traps and enemies may be able to attack the player as they reappear- not nice.
  • (int) is how many seconds the player will be invincible for.
  • (bi) is flag which sets blinking

0 = Blinking (default)

1 = No blinking

  • {int} also controls how long the parrow and parrow2 are visible.
  • You can also use makeinv in item type entities. This will create an item that gives the player {int} seconds of invincibility , much like a star in Mario.
blockodds {int}
  • {int} is a number from 1 to 2147483647. It determines how often an enemy will block an attack.
  • 1 means they'll block almost all attacks. 2147483647 means they pretty much never, ever, ever block, ever.
  • Enemies can't block during attacks so don't hesitate using this ;).
thold {int}
  • {int} is the threshold for an entity's blocking ability.
  • If the entity tries to block an attack with an attack power higher than {int}, they will not be able to do so and will get hit anyway.
  • If {int} is 0, an entity will have infinite threshold. In other words, they can block any attacks.
  • Regardless of threshold, if an attack is set to be unblockable, it can't be blocked.
blockpain {bi}
  • Determines whether the entity plays pain animation during blocking or not.

0 = No pain animation during block.

1 = Pain animation is played during block.

falldie {value} or death {value}
  • Determines how DEATH animation will be played when the character dies.

0 = fall, blink on ground then disappear without playing DEATH at all (default).

1 = No FALL animation, DEATH animation will be played right after final blow

2 = Fall first then play DEATH animation. This only applies to enemies.

  • MAKE SURE that the character have DEATH animation when using this!
sleepwait {value}
  • Determines how long player must stand still in IDLE animation before SLEEP animation is played in centiseconds. Default value is 10 seconds.
aironly {bi}
  • If set to 1, this character's shadow will only be visible when it is off the ground (jumping, falling, etc.)
setlayer {int}
  • This entity will be displayed as if it were at z position {int}, regardless of it's actual position.
grabback {bi}
  • If set to 1, when grabbing, this entity will be displayed behind the other entity being grabbed.
grabfinish {bi}
  • This command determines whether entity's GRAB animation is interruptible or not (see GRAB below).

0 = Interruption is possible (default). If enemies use this, they will skip the rest of animation after they knockdown opponent. It's not recommended for enemies.

1 = Interruption is not possible. For players, they must wait their GRAB animation to finish before they can perform any grabattacks. For enemies, they'll finish their GRAB animation.

  • Use this with GRAB animation of course.
icon {path}
  • The graphic normally shown next to the entity's life bar.
  • Normally a 16 x 16 box with a picture of the entity's head.
  • {path} is the location relative to OpenBoR of the icon's .gif.
  • The position of the graphic can be changed in LEVELS.txt.
  • You can use a longer image to change the appearance of your character's lifebar, but remember that the box and shadow around it appear on top if you don't turn them off in LEVELS.txt.
  • Dimensions of the life bar relative to the icon in bbox format (if you haven't changed it in LEVELS.txt): 18 8 103 9
iconpain {path}
  • Same as icon, except this appears instead if the entity is being injured.
  • This only works for players.
icondie {path}
  • Same as icon, except this appears instead if the entity is dead.
  • This only works for players.
iconget {path}
  • Same as icon, except this appears instead if the entity is picking up an item.
  • This only works for players. Not like anything else has a GET animation.
iconw {path}
  • For players with a weapon.
  • {path} should point to a .gif file.
  • If a player has weapon with a limited number of uses, this icon will appear with a counter for the remaining uses.
iconmphigh {path}
  • Same as icon, except this appears when the entity's MP is full.
  • This only works for players. Other entities doesn't have MP.
iconmphalf {path}
  • Same as icon, except this appears when the entity's MP is half.
  • This only works for players. Other entities doesn't have MP.
iconmplow {path}
  • Same as icon, except this appears when the entity's MP is low.
  • This only works for players. Other entities doesn't have MP.
diesound {path}
  • {path} points to a .wav file that plays if the entity is defeated.
  • As with all .wav files, MAKE SURE TO KEEP THE FILE SIZE DOWN! Open the file with Microsoft Sound Recorder and cut off any blank or unneeded sections of the file. .wav is a large file format, don't waste all your mod's memory on it!
parrow {path} {x} {y}
  • When a player respawns, the image at {path} will flash over the player at {x},{y} compared to their offset.
  • The image will be visible for as long as the player is invincible after respawning (determined with makeinv).
  • I use -48 -130 for mine. You'll probably want yours to be somewhere around there, but I doubt you're using the exact same image and entity, so experiment.
parrow2 {path} {x} {y}
  • If player 2 is playing, and respawns, this will appear instead of parrow. You could just use parrow over again, or you could use something to mark that this is Player 2, not Player 1.
score {onkill} {multiplier}
  • Changes the score earned by killing this entity. Both {onkill} and {multiplier} are {int}s.
  • When the entity dies, the player who killed him/her/it will get {onkill} bonus points to their score.
  • Any hits landed on this entity by a player which would increase the player's score is multiplied by {multiplier}.
  • The default value is 5 for the multiplier. Setting {multiplier} to 0 makes it use default setting. Use -1 if you want to set 0 multiplier.
  • When used with an item, {onkill} changes the amount of score added when the item is picked up and {multiplier} is not used.
smartbomb (power) (type) (pause) (length}
  • This is for players. Enemies use the 'bomb' command for something else. Don't mix the two up!
  • If this is present, the player's special will work differently: it will become a "smart bomb" which damages all onscreen enemies, regardless of position.
  • {power} is an integer value which determines attack damage.
  • {type} is the attack's effect type:

0 knockdown1 (based on attack1) 1 knockdown2 (based on attack2) 2 knockdown3 (based on attack3) 3 knockdown4 (based on attack4) 4 blast 5 burn 6 freeze 7 shock 8 steal

  • {pause} is a binary value which determines whether or not all action onscreen pauses when you use your special. Used for a dramatic effect.
  • If {type} was set to 6 (freeze), {length} can be used to determine how long the enemies will remain frozen.
  • This command can also be used for items. In this way you can make "smart bomb" items to clear the screen. If you do use it with an item, {length} will replace {pause}
  • Exactly what is so smart about a bomb that just hits everything, anyway?
toflip {bi}
  • Used for hitflashes.
  • If {bi} is 0, this hitflash will always face the same direction when spawned. If set to 1, the hitflash will flip when the attack comes from the other side.
cantgrab {bi}
  • {bi} determines whether or not an entity can be grabbed and held (or thrown).
  • If set to 1, opponent who stand close to this entity will simply pass through.
paingrab {bi}
  • For enemies.
  • Determines whether the enemy can be grabbed normally or only in pain animation.

0 (default) = enemy can be grabbed normally, if the enemy is grabbable that is.

1 = enemy can only be grabbed in pain animation, if the enemy is grabbable that is.

noatflash {bi}
  • When {bi} is 1, this entity will always play it's personal 'flash' when hit, instead of the attacker's. Useful for obstacles.
remove {bi}
  • Only works for projectiles. Defaults to 1.

1 = the projectile will be destroyed when it hits an enemy.

0 = the projectile continues flying even after hitting an enemy.

escapehits {int}
  • For enemies
  • If you give this to an enemy, the enemy will perform SPECIAL2 when they get hit by int+1 hits. Don't forget to give the enemy anim SPECIAL2 if you're using this.
  • In case you haven't figured out, this feature is to make enemy counter attacks after they get certain number of consecutive hits.
  • The counter will reset if enemy plays any animation EXCEPT IDLE, FAINT and PAIN. The counter works even with grabattacks.
com {dir1} {dir2} ... {dir15} {action} freespecial{#}
  • Allows you to customize freespecial input commands.
  • The {#} should be the number of the freespecial you want to change. You can leave it blank for 1 or use 2 though 8 for 2 through 8. There is no space between freespecial and {#}.
  • The first part is direction button input while the 2nd is action button input. It supports 15 direction button inputs but you can use just 2 or 3 if you want. You can even not using direction button input at all.
  • Possible values for {dir#} are:

U: Up

D: Down

F: Forward

B: Back (The direction opposite your current direction. If used, the character will turn around.)

  • Possible values for {action} are:

A: Attack button

A2: Attack button2

A3: Attack button3

A4: Attack button4

J: Jump button

S: Special attack button

K: Alternate special attack button

  • You can use either S or K for the special attack button command. You can only use one or the other, so pick one and stick with it. This was done so that modders who use the special key for blocking can remember the key is used to blocK, not use Specials. (B would have been used, for Block, but B is already used for Back.)
  • Make sure that you don't have any conflicts with other commands. RUN, DODGE, and the directional ATTACKs all have inputs which can be the same as freespecials.
  • If you use B for {dir1}, flip the next input. The player changes direction, remember? So B, F, A would be 'turn around, move forward, attack', but since you turned around first, moving forward would mean moving in the direction you just turned to. If you wanted to have an input like Street Fighter's Guile or Charlie's Sonic Boom, you'd need to use B, B, A instead of B, F, A.
remap {path1} {path2}
  • Allows you to create alternate palletes for entities.
  • Each entity can have up to 14 palletes.
  • {path1} is a sprite of an entity in their normal pallete. {path2} is a sprite of the entity in an alternate pallete.
  • You should not change the file's pallete. The only changes should be to the pixels in the image, not the pallete data.
  • Player 2 normally uses the first alternate pallete, but both players can select their color when choosing a character with up and down if the colourselect option is on.
  • If your entity has sprites with incorrect colors in alternate palletes, the entity may use colors which are not in {path1}. Check the frames with incorrect colors and compare them. Then just add the colors somewhere in {path1} and the new colors in the same position in {path2}. If that sounds confusing, look at K9999's remaps. That's what I mean.
atchain {number} {number} {number} {number} {number} ...
  • Determines the attack chain order for player. The attack chain only starts if the first attack hits though.
  • The maximum length is 5 with 'combostyle 0' or 12 with 'combostyle 1' (see below).
  • {number} can be anything from 1 to 12. 1 refers to ATTACK1, 2 to ATTACK2 and so on. Note: before using number 5 to 12, set 'maxattacks' to 12 1st. See 'maxattacks' above.
  • You can repeat the same number if you need to.
  • You don't have to use all of them. Setting something like 'atchain 1 3 2' works.
  • Default combo is 'atchain 1 1 2 3'.
  • With 'combostyle 1', various attack chain can be set with this command. For instance, 'atchain 1 2 5 0 3 3 6 0 4 0' have 3 kinds of attack chain in it.
  • The attack chains are selected by 'range' specified in respective attack (excluding ATTACK1). In above example, if ATTACK2 can't reach target, attack chain will switch to ATTACK3. If the latter hits, the attack chain becomes '1 3 3 6'. If the latter misses, attack chain will switch to ATTACK4.
  • In any attack chain, if it goes to 0, the attack chain will reset to 1st step (ATTACK1).
combostyle {bi}
  • Changes how 'atchain' works.

0 = (Default), old attack chain system. Max attacks is 5.

1 = new attack chain system. Max attacks is 12.

chargerate {int}
  • Determines how fast MP recharge with CHARGE animation would be. Default value is 2.
mprate {int}
  • This sets how many MP player recovers (by time and by hitting enemy)
  • If typemp = 1, this is the amount MP player recover from hitting enemy.
  • If typemp = 2, this is the amount MP player recover on regular intervals.
risetime {value}
  • This is for altering risetime (wait time for character while lying down after falling before rising).
  • Positive value reduces risetime making the character rises earlier.
  • Negative value increase risetime making the character rises more late.
turndelay {int}
  • This sets how long the character performs BACKWALK before turning back.
  • {int} is time in centiseconds.
  • This is used together with TURN and BACKWALK.
facing {int}
  • This is for forcing the entity to face certain direction regardless where he/she is going.

0 = no force (default).

1 = force the entity to face right.

2 = force the entity to face left.

3 = force the entity to face same direction with level's direction.

  • Setting this allows players to play BACKWALK.
weaploss {flag}
  • Determines how weapon could be lost when the character is wielding a weapon.

0 (default) -> weapon is lost and dropped on any hit.

1 -> weapon is lost only on knockdown hit.

2 -> weapon is lost only on death.

3 -> weapon is lost only when level ends or character is changed during continue. This depends on the level settings and whether players had weapons on start or not.

  • This setting can also be declared in weapon text. If you do so, the setting will override similar setting in character's text and it will only be used for that weapon.
branch {name}
  • This is used to make endlevel entity warps players to certain level instead of the next level in a level set if player touch it.
  • {name} is name of the destination in a level set.
  • In case you haven't figure it out, this feature is to make branch for multiple paths.
fireb {name}
  • This was used like "load". {name} was launched like a shot.
  • This command has been removed. Use knives instead.
hostile {type1} {type2} ...
  • Optional.
  • Specifies what types an AI controlled entity will attack and what entities a projectile with the chase subtype will seek (this does not determine what the entity can hit, only what it will intentionally attack).
  • Available types are enemy, player, npc, obstacle, shot and you can use as many as you need.
  • Be aware if you use this setting, you must provide all types you wish this entity to be hostile towards. That is to say, an enemy with â��hostile npc obstacleâ�� will only attack npc and obstacle types, not players.
candamage {type1} {type2} ...
  • Optional.
  • Specifies what types this entity can hit (very similar to hostile, but determines what entity may hit, not what it will intentionally target).
  • Available types are enemy, player, npc, obstacle, shot and you can use as many as you need.
  • Be aware if you use this setting, you must provide all types you wish this entity to be able to hit. That is to say, an enemy with â��candamage npc obstacleâ�� will be able to hit npc and obstacle types, not players.
projectilehit {type1} {type2} ...
  • Optional.
  • Do not let the name confuse you, this is not for projectiles. This setting specifies what types this entity will hit when thrown from a grab.
  • Available types are enemy, player, npc, obstacle, shot and you can use as many as you need.
  • Be aware if you use this setting, you must provide all types you wish this entity to be able to hit when thrown. That is to say, an enemy with â��projectilehit playerâ�� will only hit players when thrown, not other enemies.
aggression {value}
  • For enemies, this command modifies pausetime for enemy before they attack after player is within attack range.
  • Positive value reduces pausetime making the enemy reacts faster.
  • Negative value increase pausetime making the enemy reacts slower.
antigrab {value}
  • This command sets entity's resistance to grabbing attempt by opponent. To grab this entity, opponent's 'grabforce' must equal or more than {value}.
  • Used in conjuction with 'grabforce'.
grabforce {value}
  • This command sets entity's power to grab an opponent. This entity will have success grab if opponent's 'antigrab' is equal or less than {value}.
  • Used in conjuction with 'antigrab'.
offense {type} {%}
  • Increases or decreases damage output of given attack type by %.
  • For example, "offense shock 50%" will increase shock attacks by 50%, whereas "offense burn -75%" will decrease burn attacks 75%.
  •  % could go more than 100 and -100. -100% makes the attack to give HP to opponent instead.
  • Possible types are:

all (all default attacktypes are affected)

normal# (replace # with appropriate attacktype number)

shock

burn

steal

blast

freeze (only affects damage, freeze effect remains)

  • If you use attacktypes more than 10, setting 'all' won't affect attack11 and next attacks. You gonna have to set for each extra attack if you want to affect them too.
defense {type} {%}
  • Increases or decreases damage received by given attack type by %.
  • For example, "defense attack3 60%" will decrease attack3 damage by 60%, whereas "offense blast -45%" will increase blast damage by 45%.
  •  % could go more than 100 and -100. -100% makes the entity regains HP from the respective attack instead.
  • Possible types are exactly sames with 'offense' (see above).
hmap {a} {b}
  • Hides entity's remap from being selected (in select screen for players). The remaps can still be used with other features, like forcemap or script.
  • Hidden remaps are from ath remap to bth remap.
  • For example 'hmap 3 6', hides 3th, 4th, 5th and 6th remap.
bounce {bi}
  • Determines whether entity will bounce or not after touches ground after falling.

0 = No bounce effect

1 = Bounce effect is set

grabwalk {bi}
  • Determines grabwalking speed. If not declared, entity's walking speed will be used instead.
  • You need to declare GRABWALK to use this obviously.
grabturn {bi}
  • Determines whether entity can turn around or not when grabbing opponent.

0=no turning (default).

1=turns around.

  • If you haven't figure it out, entity turns around if back is pressed while grabbing. Back is opposite of facing direction.
  • If GRABTURN is available, it will be played while turning.
load {name} {path}
  • This loads other entity into memory so the entity can be used.
  • {name} is a name that the game will use to identify the entity.
  • {path} is the location relative to OpenBoR of the entity's .txt file.
  • This command is similar to the one for models.txt however the purpose of using this is to force engine to load 'known' entity even if the entity is never spawned anywhere in level. Useful to load biker's rider which normally not loaded when biker is spawned.
  • Before using this, declare the entity with 'know' in models.txt.
lifespan {value}
  • Sets entity's lifespan after the entity is spawned. {value} is in seconds and it supports decimals.
  • After {value} expires, entity will die and will play entity's death animation if the entity has it.
  • Entity who uses this can die normally if {value} hasn't expired of course.
nopassiveblock {bi}
  • If set to 1, NPC and enemy will block more active instead of reactive.
  • Active also means they will block if they are attacked even if the attack doesn't hit them.
  • Obviously entity who use this must have block ability.
knockdowncount {int}
  • This setting makes entity more resistant to knockdown attacks. To knock down this entity, either 'attack' with same or higher power than {int} or {int} consecutive knockdown attacks must hit this entity.
  • If the above requirements is not fulfilled, the entity will play PAIN animation instead if hit by an attack. Played PAIN animation correspond to attacktype that hits the entity.
  • If {int} = -1, the entity will always be knocked down even if hit by non knockdown attack.
antigravity {value}
  • This command determines how strong this entity resists gravity.
  • Value is in percent so setting 100 makes the entity never fall after jumping.
aimove {type}
  • This command sets enemy's walk AI. IOW it sets how enemy walks around in levels.
  • Possible types for {type} are:

Chase = Enemy will always chase player and this allows enemy to use RUN and RUNATTACK if enemy has it.

Chasex = Enemy will chase player but it only lines up enemy's X axis with player's.

Chasez = Enemy will chase player but it only lines up enemy's Z axis with player's.

Avoid = Enemy will always avoid player.

Avoidx = Enemy will always avoid player but enemy only avoids lining up X axis with player's.

Avoidz = Enemy will always avoid player but enemy only avoids lining up Z axis with player's.

Wander = Enemy walks without certain destination (hence the name).

Ignoreholes = Enemy walks without ignoring holes. This makes enemy walks to holes stupidly.

gfxshadow {int}
  • Changes entity's shadow effect.

0 = (default) Use generic shadow set.

1 = Use entity's current frame for the shadow. Yes, the shadow will be more realistic with this. The angle and length of shadow is defined by 'light' (see below).

holdblock {bi}
  • Determines whether holding special button will make player play his/her block animation once or continuously.

0 = (default) Once. Press once then block will end normally.

1 = Continuously. Holding special button makes player block continuously until button is released.

  • Use this command with block ability of course.
jumpmove {fx} {fz}
  • This allows Player to modify player's jump movement.
  • {fx} determines effect in x axis:

0 = (default) No effect.

1 = Left/Right changes facing direction during jump.

2 = Left/Right changes jumping speed during jump (doesn't work with static jump).

3 = Combination of 1 and 2.

  • {fz} determines effect in z axis:

0 = (default) No effect.

1 = Walking/running momentum is carried during jump.

2 = Up/Down changes jumping speed during jump (doesn't work with static jump).

3 = Combination of 1 and 2.

riseinv {int} {bl}
  • Determines whether or not the player is briefly invincible after rising.
  • (int) is how many seconds the player will be invincible for.
  • (bl) is flag which sets blinking

0 = Blinking (default)

1 = No blinking

lifebarstatus {w} {h} {noborder} {type} {orientation} {border} {shadow} {graph} {backfill}
  • This command makes entity's lifebar be displayed onscreen. Usually this is used by bosses but works for any type.
  • {w} is the maximum amount of health the bar can display. Defaults to 100.
  • {h} is the height of the lifebar in pixels. Defaults to 5.
  • {noborder} turns on or off the border and shadow around life bars. {0} means there is, {1} means no outline or shadow.
  • {type} is a flag that sets how lifebar show health. 0 (default) means if an entity's health goes over width, the life bar will wrap around and 'double up' on top of itself (1 unit of health is 1 pixel long.). 1 means the lifebar is shown in percent based.
  • {orientation} is a flag that sets lifebar's orientation. 0 (default) means horizontal while 1 means vertical.
  • {border} sets layer adjustment of outer border. Default to 0.
  • {shadow} sets layer adjustment of border shadow. Default to 0.
  • {graph} sets layer adjustment of graph fill. Default to 0.
  • {backfill} sets layer adjustment graph background. Default to 0.
  • The last 4 variables can be used to place lifebar behind player 'icon' or 'bgicon'. To do that you need to give value like -300.
lifeposition {x} {y}
  • This command determines display position of entity's lifebar onscreen.
  • It is counted from upperleft corner of screen to lifebar's upperleft corner.
  • Use this together with 'lifebarstatus' above.
nameposition {x} {y}
  • This command determines display position of entity's name onscreen.
  • It is counted from upperleft corner of screen to name's upperleft corner.
  • Use this together with 'lifebarstatus' above.
iconposition {x} {y}
  • This command determines display position of entity's icon onscreen.
  • It is counted from upperleft corner of screen to icon's upperleft corner.
  • Use this together with 'lifebarstatus' above.
no_adjust_base {bi}
  • This command determines how terrain effect entity's base altitude.
  • Example of terrains are platforms, walls and holes.

0 = Terrain can effect entity. Default for most entities.

1 = Terrain can't effect entity. Default for arrows.

subject_to_wall {bi}
  • This command determines how walls effect entity.

0 = Walls don't have any effect. Default for projectiles.

1 = Walls have effects. Default for most entities.

  • This should be used by AI controlled entities.
subject_to_hole {bi}
  • This command determines how holes effect entity.

0 = Entity can't fall to holes.

1 = Entity can fall to holes. Default for most entities.

subject_to_obstacle {bi}
  • This command determines how obstacles effect entity.

0 = Obstacles don't have any effect. Default for projectiles.

1 = Obstacles have effects. Default for most entities.

  • This should be used by AI controlled entities.
subject_to_platform {bi}
  • This command determines how platform effect entity.

0 = Platforms don't have any effect. Default for projectiles.

1 = Platforms have effects. Default for most entities.

  • This should be used by AI controlled entities.
subject_to_gravity {bi}
  • This command determines how gravity effect entity.

0 = Gravity don't have any effect.

1 = Gravity have effects. Default for most entities.

subject_to_screen {bi}
  • This command determines whether entity can move offscreen or not.

0 = Entity can move offscreen. Default for non-player entities.

1 = Entity can't move offscreen. Default for players.

Animation Types

WAITING (used for players)
  • An optional animation.
  • Plays on the character select screen when a character is highlighted (that is, pressing an attack button will select them).
SELECT (used for players)
  • An optional animation.
  • Played when you select a character on the character selection screen (that is, you've pressed an attack button to indicate you want to use this character).
SPAWN (used by all entities)
  • An optional animation.
  • Plays when an entity appears in a level, whether from the level's .txt file or being respawned after dying. It also plays on the character select screen.
  • It generally beats having new enemies just fall from the sky. That looks kind of silly with most enemies.
RESPAWN (used by all entities)
  • An optional animation.
  • This does the exact same thing as SPAWN. You can use them interchangeably.
IDLE (used by all entities)
  • The animation for when something is just standing there.
  • If an entity isn't moving, attacking, dodging, grabbing, or dying, they're probably doing this.
  • If the SELECT and SPAWN graphics are not present, the IDLE animation will be used instead.
FAINT (players, enemies)
  • Optional.
  • If this animation is present, whenever this entity's health is 1/4 (one quarter) or less than it's maximum health, it will use this animation instead of it's IDLE animation.
SLEEP {players}
  • Optional.
  • It will be played if player does not move at all for certain time. That certain time is set with 'sleepwait' command.
  • If it is not looped, player will return to IDLE animation when it is finished. If it is looped, player will continuously play it until player moves.
  • It will be overridden by FAINT, if FAINT is available too.
WALK (players, enemies, projectiles)
  • Optional for non-moving enemies. They won't use it, so why give it to them?
  • The animation for an entity walking left or right.
  • If a character does not have UP and DOWN animations, they will use this instead when walking up or down.
  • Projectiles only use this if they are homing projectiles. For this purpose, 'range' is supported.
BACKWALK {players, enemies}
  • Optional.
  • Players play this only if they have 'facing' set.
  • Enemies will play this if they move backwards while facing players.
TURN
  • Optional.
  • For players and enemies.
  • This animation will be played when players or enemies turn back after walking backwards with BACKWALK.
UP {players, enemies}
  • Optional.
  • Played when the character walk up, up-left, or up-right.
  • For this animation to work correctly, it must have the same number of frames as the WALK animation.
DOWN {players, enemies}
  • Optional.
  • Played when the character walk down, down-left, or down-right.
  • For this animation to work correctly, it must have the same number of frames as the WALK animation.
DUCK {players}
  • Optional.
  • This will only play in a stage whose max and min 'z' are the same (In other words, a 2-D stage).
  • Plays when a player presses down. They can use this to duck under high attacks.
LAND (players)
  • Optional, but players may still be able to land safely depending on the 'autoland'settings in MODELS.txt.
  • If a player is thrown by an enemy (Thrown, not knocked down), then they can press Up and Jump right when they hit the ground to recover instantly and take no damage. This animation will be played instead of the normal fall animation.
RUN (players, enemies)
  • Optional.
  • If the player has their running speed specified, this is the animation they will use to run.
  • By setting loop to 0 and adding in the jumpframe command, you can turn this into a dash animation. The player will leap forward.
  • This animation is only used by enemies with subtype chase. Their running speed is determined by 'running'.
RUNATTACK {players}
  • Optional.
  • Requires the character to be able to run. Otherwise, they can't really use it.
  • If the player presses attack while running, they will perform this attack.
  • Although player is running while attack is pressed, player won't be moving in this animation. If you want them to move, insert 'move' here.
RUNJUMPATTACK {players}
  • Optional.
  • Requires the character has a RUN animation. Otherwise, they can't really use it.
  • If the player presses attack during a running jump, they will perform this attack.
BLOCK (enemies, players)
  • Optional.
  • For players, this animation will only play if 'ajspecial 1' is in MODELS.txt. It will play when the player presses the special attack button.
  • Enemies use this with 'blockodds {int}'. If an enemy blocks your attack, they will play this animation.
  • Enemies will only block an attack if it would otherwise hit them (i.e. they won't block an attack which goes 10 feet over their heads).
DODGE (players)
  • Optional.
  • Players with this animation can perform a 'depth' dodge up or down by pressing up or down twice.
  • The player will move along the z axis (closer to or farther from the screen).
  • The dodge will last as long as the animation does, and you can't cancel out of it by attacking. So don't set it to loop.
  • This cannot be used with ATTACKUP, ATTACKDOWN, or freespecials with the input U, U or D, D.
GET {players}
  • Optional.
  • Played when the character picks up an item.
ATTACK1 {players, enemies}
  • By default, this animation is NOT optional for players. It is optional for enemies.
  • An attack. Players perform this by pressing attack (unless the chain order is changed).
  • Enemies perform this attack when a player is in range (range is specified with the 'range' command).
  • Enemies are slightly more likely to use ATTACK1 than ATTACK2.
  • Enemy bombs play this animation if they touch the ground. If they don't have an ATTACK2 animation, they'll use this instead, as well.
ATTACK2 {players, enemies}
  • By default, this animation is NOT optional for players. It is optional for enemies.
  • Another attack. Players use this if they press attack after hitting with ATTACK1 twice (unless the chain order is changed).
  • Enemies use this just like ATTACK1.
  • Enemies are slightly more likely to use ATTACK2 than ATTACK3.
  • Enemy bombs play this animation if they touch another entity's bbox or attack box.
ATTACK3 {players, enemies}
  • By default, this animation is NOT optional for players. It is optional for enemies.
  • And another attack. Players use this if they press attack after hitting with ATTACK2 (unless the chain order is changed)
  • This animation is also played instead if grab finishers and chargeattack are not available..
  • Enemies use this just like ATTACK1 and ATTACK2.
ATTACK4 {players, enemies}
  • Optional.
  • Players use this only if it is included in 'atchain' .
  • Enemies use this just like ATTACK1, ATTACK2 and ATTACK3.
ATTACK5,ATTACK6,... {player,enemies}
  • These animations are only usable if you have increased ATTACK animations limit. To increase the limit use 'maxattacks' (see details above in Models.txt section).
  • After they are available, they work just like ATTACK1, ATTACK2, ATTACK3 and ATTACK4.
CHARGEATTACK {players}
  • Optional.
  • This attack is unleashed after holding attack button for about 3 seconds then let it go.
  • If this is not available, the last attack in player's attack chain will be played instead.
ATTACKBOTH {players}
  • Optional.
  • An attack. Players use this if they hold attack and then press jump.
  • This cannot be used if the player has a BLOCK animation. If MODELS.txt has 'ajspecial 1', this is replaced by the special attack.
UPPER {enemies}
  • Optional.
  • If a player is on the same row as an enemy with an UPPER animation and jumps, the enemy will perform this attack automatically.
  • Don't try to use the range command with this attack. Enemies know when to use it (when someone jumps at them!).
JUMP {players, enemies}
  • Plays when a player presses jump or when an enemy approaches a platform.
  • You don't need to draw the entity moving upward, since BoR moves them automatically.
  • If given to an enemy, this animation should also have a range listed.
  • Every jump animations including this will keep playing until the character lands regardless how long the animations are.
JUMPDELAY {players, enemies}
  • Optional.
  • Played just before entity jumps with normal jump. Used to make delay animation before entity actually jumps. That means when this animation is played, entity is still on ground.
  • It won't be used if entity jumps with 'jumpframe'.
JUMPLAND {players, enemies}
  • Optional.
  • Played after entity lands from normal jump.
  • It won't be used if entity jumps with 'jumpframe'.
FORWARDJUMP {players, enemies}
  • Optional.
  • Played when entity jumps forward with normal jump.
  • It won't be used if entity jumps with 'jumpframe'.
RUNJUMP (players)
  • Optional.
  • Played when entity jumps forward while running with normal jump.
  • It won't be used if entity jumps with 'jumpframe'.
JUMPATTACK {players, enemies}
  • An attack.
  • For players, this is the attack performed when a player jumps and presses attack.
  • Enemies randomly perform this attack when a player is in range.
  • The jump is automatic. You don't need to use the jumpframe command or draw the entity moving forward.
  • When enemies use this attack, they'll jump forward.
JUMPFORWARD {players}
  • Optional.
  • If a player has this animation, they will only play their JUMPATTACk animation if they jump straight up and attack. This attack will be used if they jump forward and attack.
JUMPATTACK2 {players, enemies}
  • An attack. Just like the normal JUMPATTACK, except that players perform this attack by jumping, then holding the down button and pressing attack.
  • Enemies randomly perform this attack when a player is in range.
  • When enemies use this attack, they'll jump straight up.
JUMPATTACK3 {players}
  • Optional.
  • An attack. Just like the normal JUMPATTACK, except that players perform this attack by jumping, then holding the up button and pressing attack.
JUMPSPECIAL/SPECIAL3 {players}
  • Optional.
  • An attack. Just like the normal JUMPATTACK, except that players perform this attack by jumping, then pressing special.
  • Unlike other jumpattack animations, players lost their momentum in this animation. IOW they won't move forward at all even if they have run before jumping. The only exception is if 'dive' is present.
  • This animation can be disabled with 'type' in level texts. See 'Level files' below for more info
JUMPCANT {players}
  • Optional.
  • This animation is only played if player tried to perform jumpattack which costs energy without having enough energy.
ATTACKUP {players}
  • Optional.
  • An attack. Players perform this by pressing up twice.
  • This attack overrides freespecials. If you use it, you will not be able to use a freespecial which has Up, Up, {button} as it's input. You also can't use this attack if you use the DODGE animation.
ATTACKDOWN {players}
  • Optional.
  • An attack. Players perform this by pressing down twice.
  • This attack overrides freespecials. If you use it, you will not be able to use a freespecial which has Down, Down, {button} as it's input. You also can't use this attack if you use the DODGE animation.
ATTACKFORWARD {players}
  • Optional.
  • An attack. Players perform this by pressing forward twice.
  • This attack cannot be used with running. Also, if you use it, you will not be able to use a freespecial which has Forward, Forward, {button} as it's input.
ATTACKBACKWARD {players}
  • Optional.
  • An attack. Players perform this by pressing backwards once, then quickly pressing attack.
  • Unlike most attacks which use the back button, this does not flip your direction.
FOLLOW{#} {players,enemies}
  • Optional.
  • {#} is number and its possible values are 1, 2, 3 and 4. There's no space between FOLLOW and {#}.
  • It works just like any attack animation except that it is only played when followup condition is met or entity is attacked in counter pose.
FOLLOW5,FOLLOW6,... {player,enemies}
  • These animations are only usable if you have increased FOLLOW animations limit. To increase the limit use 'maxfollows' (see details above in Models.txt section).
  • After they are available, they work just like FOLLOW1, FOLLOW2, FOLLOW3 and FOLLOW4.
FREESPECIAL{#} {players}
  • Optional.
  • If {#} is not placed on the end of the name, it references FREESPECIAL1. If {#} is a number from 2 to 8, it references that FREESPECIAL. Anything else is an error.
  • There is no space between FREESPECIAL and {#}.
  • An attack. The input depends on the 'com {dir1} {dir2} {action} freespecial{#}' earlier in the .txt file.
  • FREESPECIAL defaults to F, F, A if you can't run and B, F, A if you can. FREESPECIAL2 defaults to D, D, A. FREESPECIAL3 defaults to U, U, A. The other FREESPECIALs don't default to anything, and thus need to be defined to be useable by command.
FREESPECIAL9,FREESPECIAL10,... {player,enemies}
  • These animations are only usable if you have increased FREESPECIAL animations limit. To increase the limit use 'maxfreespecials' (see details above in Models.txt section).
  • After they are available, they work just like other FREESPECIALs.
SPECIAL {players, enemies}
  • Optional for enemies.
  • A breakout attack.
  • Players perform this by pressing special. They can use it while being held by an enemy to break free, or while playing an injured animation (besides fall, shock, burn, and death) to counterattack.
  • For players to use this attack, they must have at least 6 life, which they will lose upon performing the attack. You can change this with 'energycost'.
  • Enemies perform this attack automatically if a player grabs and holds them for too long without throwing them or knocking them down.
  • For players, this animation can be disabled with 'type' in level texts. See 'Level files' below for more info
SPECIAL2 {players, enemies}
  • Optional.
  • Players perform this by pressing forward and special, or special while running.
  • Enemies perform this after they receive certain number of consecutive hits. Used together with 'escapehits'.
  • For players, this animation can be disabled with 'type' in level texts. See 'Level files' below for more info
CHARGE {players}
  • Optional.
  • This animation is executed by holding special and jump together. As long the buttons are held, the animation will play continuously.
  • While playing, player's MP will be recovered at specified rate. The recharge rate is specified with 'chargerate'.
  • However this animation CAN'T be executed if there are no enemies around.
CANT (players)
  • Used with MP.
  • If a player has this animation, and they attempt to use an attack which costs more MP than they have at the moment, they will play this animation and can't dodge or attack until it ends.
  • If the attack they were using had the Special button as input, they will block instead of playing this animation.
GRAB {players, enemies}
  • Optional for enemies and players.
  • When this entity moves close enough to another, this entity will grab hold of the other.
  • If a player grabs an enemy, they can hold the direction opposite the enemy for a few seconds to let go and walk away.
  • If you don't want this entity to be able to grab, just don't give them this animation.
GRABATTACK {players, enemies}
  • Optional for enemies, can be made optional for players with cantgrab or notgrab.
  • When you've grabbed another character, you can press attack to use this attack up to two times.
GRABATTACK2 {players, enemies}
  • Optional. If not defined, defaults to ATTACK3.
  • When you've grabbed another character and used GRABATTACK twice, you can press attack to use this attack.
  • You can also use this early by pressing jump.
GRABFORWARD {players}
  • Optional.
  • When you've grabbed another character, you can press forward and attack to use this attack up to two times. Just like GRABATTACK except for the input.
GRABFORWARD2 {players}
  • Optional. If not defined, defaults to ATTACK3.
  • When you've grabbed another character and used GRABFORWARD twice, you can press forward and attack to use this attack.
  • You can't use this early by pressing jump and forward.
GRABUP {players}
  • Optional.
  • When you've grabbed another character, you can press up and attack to use this attack up to two times. Just like GRABATTACK except for the input.
GRABUP2 {players}
  • Optional. If not defined, defaults to ATTACK3.
  • When you've grabbed another character and used GRABUP twice, you can press up and attack to use this attack.
  • You can't use this early by pressing jump and up.
GRABDOWN {players}
  • Optional.
  • When you've grabbed another character, you can press down and attack to use this attack up to two times. Just like GRABATTACK except for the input.
GRABDOWN2 {players}
  • Optional. If not defined, defaults to ATTACK3.
  • When you've grabbed another character and used GRABDOWN twice, you can press down and attack to use this attack.
  • You can't use this early by pressing jump and down.
GRABWALK (players)
  • Optional. Currently only used by players.
  • This animation is played when player walks while grabbing enemy.
  • The grabwalk speed is determined by 'grabwalk' (see above). However, declaring this animation is enough to enable grabwalking.
  • This animation is like WALK animation so setting 'loop 1' is recommended. However, this animation is NOT performed in reverse while walking backwards. Use GRABBACKWALK below for that case.
GRABBACKWALK (players)
  • Optional. Currently only used by players.
  • This animation is played when player walks backwards while grabbing enemy. Only played if player can't turn around while grabbing.
  • The grabbackwalk speed is also determined by 'grabwalk' (see above).
  • This animation is like WALK animation so setting 'loop 1' is recommended.
GRABWALKUP (players)
  • Optional.
  • This animation is played when player walks upwards (in z axis that is) while grabbing enemy.
  • The grabbackwalk speed is also determined by 'grabwalk' (see above).
  • This animation is like WALK animation so setting 'loop 1' is recommended.
GRABWALKDOWN (players)
  • Optional.
  • This animation is played when player walks downwards (in z axis that is) while grabbing enemy.
  • The grabbackwalk speed is also determined by 'grabwalk' (see above).
  • This animation is like WALK animation so setting 'loop 1' is recommended.
GRABTURN (players)
  • Optional.
  • This animation is played when player turns around while grabbing enemy. Only usable if 'grabturn' is set to 1.
  • During this animation, player is stationary even if player can perform GRABWALK. OTOH grabbed opponent will be moved to opposite place with same grabdistance.
THROW {players, enemies}
  • Optional for enemies, can be made optional for players with cantgrab or notgrab.
  • When you've grabbed another character, you can press back and attack to use this attack.
  • By default, this animation deals 21 damage to the thrown victim. You can change the height, distance, and damage received for the throwee with the 'throwdamage' and 'throw' commands.
  • The normal score rules do not apply to throws: they always reward the thrower with a number of points equal to the damage they dealt.
  • The damage from this attack is not dealt until the victim lands. If they are a player and have a LAND animation, they can recover by pressing Up and Jump right when they land and avoid damage completely!
GRABBED {players, enemies}
  • Optional. Defaults to the PAIN animation if not present.
  • Plays when this character is grabbed by another.
GRABBEDWALK (players,enemies)
  • Optional. Although only players who can perform GRABWALK, other players (aside from enemies) can be grabbed too.
  • This animation is played when entity is being held and grabbing player is grabwalking.
GRABBEDBACKWALK (players,enemies)
  • Optional. I hope the name doesn't confuse you.
  • This animation is played when entity is being held and grabbing player is grabbackwalking or walking backwards while grabwalking.
GRABBEDWALKUP (players,enemies)
  • Optional. If the name confuses you, try reading it slowly.
  • This animation is played when entity is being held and grabbing player is walking upwards (in z axis that is) while grabwalking.
GRABBEDWALKDOWN (players,enemies)
  • Optional. If the name confuses you, try reading it slowly.
  • This animation is played when entity is being held and grabbing player is walking downwards (in z axis that is) while grabwalking.
GRABBEDTURN (players,enemies)
  • Optional.
  • This animation is played when entity is being held and grabbing player is grabturning.
PAIN{#} {players, enemies}
  • Played when an entity is hit by an attack which does not knock them down. Obstacles do not use this but bikers do.
  • {#} determines the number of pain animation. The possible numbers are 2 to 10. There's no space between PAIN and {#}.
  • This animation is used in conjuction with attack{#}.
  • PAIN is mandatory while PAIN2, PAIN3 etc are optional.
  • If PAIN{#} is not available, PAIN will be used instead.
PAIN11,PAIN12,... {player,enemies}
  • These animations are only usable if you have increased attacktype limit. To increase the limit use 'maxattacktypes' (see details above in Models.txt section).
  • After they are available, they work just like other PAINs.
SPAIN {players, enemies}
  • Optional. Defaults to PAIN.
  • No, not Spain. It stand for Shocked PAIN.
  • Played when an entity is hit by a shock attack which does not knock them down.
BPAIN {players, enemies}
  • Optional. Defaults to PAIN.
  • This means Burned PAIN.
  • Played when an entity is hit by a burn attack which does not knock them down.
FALL{#} {players, enemies, obstacles}
  • Played when an entity is hit by an attack which knocks them down, or hit by an attack while in air or while frozen.
  • {#} determines the number of fall animation. The possible numbers are 2 to 10. There's no space between FALL and {#}.
  • This animation is used in conjunction with attack{#}.
  • FALL is mandatory while FALL2, FALL3 etc are optional.
  • If FALL{#} is not available, FALL will be used instead.
  • Players and enemies will be using FALL animation when thrown and hit by 'blast'.
FALL11,FALL12,... {player,enemies}
  • These animations are only usable if you have increased attacktype limit. To increase the limit use 'maxattacktypes' (see details above in Models.txt section).
  • After they are available, they work just like other FALLs.
RISE {players, enemies}
  • Played when an entity who has FALLen down gets back up.
RISEATTACK {players, enemies}
  • Optional.
  • Players play this instead of RISE if Up+Attack is pressed before they rise.
  • Enemies play this if a player is in range of the attack when they gets back up after FALLen down.
SHOCK {players, enemies}
  • Optional. Defaults to FALL.
  • Played when an entity is hit by a shock attack which knocks them down, or a shock attack while in air or frozen.
BURN {players, enemies}
  • Optional. Defaults to FALL.
  • Played when an entity is hit by a burn attack which knocks them down, or a burn attack while in air or frozen.
DEATH{#} {players, enemies, bombs}
  • Optional. Although it is optional, DEATH will be used as default if other DEATH{#} aren't available.
  • Played when an entity loses all it's life after hit by attack{#} but how it plays is controlled by 'falldie'.
  • {#} determines the number of death animation. The possible numbers are 2 to 10. There's no space between DEATH and {#}.
  • If an entity is killed by being thrown, they will not use this animation.
DEATH11,DEATH12,... {player,enemies}
  • These animations are only usable if you have increased attacktype limit. To increase the limit use 'maxattacktypes' (see details above in Models.txt section).
  • After they are available, they work just like other DEATHs.
BDIE {players, enemies}
  • Optional.
  • Played when the character is finished by 'burn'.
  • It's still controlled by 'death' though.
SDIE {players, enemies}
  • Optional.
  • Played when the character is finished by 'shock'.
  • It's still controlled by 'death' though.
HITWALL {enemies, players}
  • Removed. No longer valid.
  • If an entity had this animation, when they hit a wall after being thrown or flung, they would hang on the wall for about two seconds before sliding down.
  • This didn't work for screen edges, just for the ends of stages with the blocked command.
  • This animation has been removed. It no longer works.
SLIDE

Down + Jump while walking or idle.

  • Optional for all entity types, but as of version 2.1796 (04182008) only players can use it.
RUNSLIDE

Down + Jump while running.

  • Optional for all entity types, but as of version 2.1796 (04182008) only players can use it.

Animation Data

loop {bi}
  • Determines whether or not an animation repeats itself when finished.

0 means the animation ends when the last frame is reached.

1 means the animation repeats itself after the last frame.

  • You can change it during the animation, but there's not really much of a point...
  • Some animations should NOT be set to loop. Examples include most attacks and injured animations.
fastattack {bi}
  • Normally, in order for an attack to hit entities multiple times, the attack boxes must be separated by at least one frame with an empty attack box (one set to all 0) and must also be separated by a brief delay.
  • If this is set to 1, this animation's attack boxes are not restricted by the delay (it will still need an empty attack box between frames, though).
hitfx {path}
  • {path} should point to a .wav file.
  • If this animation has an attack box which makes contact with a victim, this sound will play instead of the normal 'beat1.wav' sound.
  • Like the normal hitsfx, the higher the attack power, the slower this sound will play.
hitflash {name}
  • {name} is the name of an entity declared in MODELS.txt.
  • If this animation has an attack box which makes contact with a victim, this hitflash will play instead of the normal hitflash for this character.
custknife {name}
  • {name} is the name of an entity declared in MODELS.txt.
  • If present, for this animation only, the entity's default 'knife' entity will be replaced with this entity.
  • You still need to fire the entity at some point in the animation for this to do anything.
  • Don't forget to load the entity in MODELS.txt!
  • Knives can't be used by enemies during a jump.
custstar {name}
  • {name} is the name of an entity declared in MODELS.txt.
  • If present, for this animation only, the enemy's default 'star' entity will be replaced with this entity.
  • You still need to fire the entity at some point in the animation for this to do anything.
  • Don't forget to load the entity in MODELS.txt!
custbomb {name} custpbomb {name}

`Use "custbomb" for enemies and "custpbomb" for players.

  • {name} is the name of an entity declared in MODELS.txt.
  • If present, for this animation only, the entity's default 'bomb' entity will be replaced with this entity.
  • You still need to fire the entity at some point in the animation for this to do anything.
  • Don't forget to load the entity in MODELS.txt!
delay {int}
  • {int} is a number that tells how slowly the animation plays. 1 is extremely fast, past 25 will go very slow.
  • {int} is measured in centiseconds, or hundredths of a second. Pretty fast.
  • Can be used multiple times in one animation to change speed mid-animation
offset {x} {y}
  • Determines where the "base" of the animation is.
  • The center of the entity's "shadow" graphic is placed here if the player is on the ground. Also used by enemies to find where you are.
  • 'offset 0 0' would be the upper left corner. Larger {x} values move the {x} down. Larger {y} values move the {y} right.
  • You can use negative numbers or numbers outside of the frame's edges.
  • Most entities will automatically die if their offset goes more than 80 pixels offscreen left or right (their x value must stay between -80 and 400). Knives are the only exception: they can go up to 180 either way (-180 to 500).
  • Common symptoms of incorrect offsets are misplaced shadows, sudden "warps" to different positions and back, and enemies/shadows who seem to think you're ten feet away.
  • Can be used multiple times in one animation to change position mid-animation
bbox {x} {y} {right} {down}
  • Determines where the entity can be hit.
  • {x} and {y} are the x and y coordinates of the top left corner of the box, starting from the top left corner of the frame and moving right/down. {right} is how far to the right of {x} the box extends. {down} is how far down from {y} the box extends.
  • You can use negative numbers or numbers outside of the frame's edges. This can save a bit of memory by shaving a few excess rows or columns of pixels off an animation.
  • Can be used multiple times in one animation to change hittable areas mid-animation.
  • To give an entity frames where they cannot be hit, use 'bbox 0 0 0 0'. Be sure to add a new bbox when the entity is vulnerable again.
  • For items, this determines where the object can be picked up from.
frame {path}
  • {path} points to a graphics file to be used in this animation.
  • The frame will be displayed at the entity's position. It's about as simple as it sounds.
  • OpenBoR uses 256-color (or lower) .bmp, .gif, or .pcx files. However, .gif files are far and away the smallest, so don't use .bmp or .pcx, just .gif.
  • Also, OpenBoR seems to have trouble with certain .bmps. They may need to be saved with Photoshop for OpenBoR to read them. .pcx are fine, but they're still larger than .gif files, so .gifs are preferred.
  • If you want to convert a lot of images which are already in the desired pallette into .gif files, you may want to try Irfanview (at http://www.irfanview.us/).
range {min} {max}
  • Used for enemy attacks and jumps. Also used by homing projectiles.
  • This command lets the enemy know when to perform their attacks or to jump on platforms..
  • For the enemy to use the attack, a player must be more than {min} away, but less than {max} away in x axis.
  • For the enemy to jump on a platform, the enemy must be within {min} pixels of the platform, and the platform must be less than {max} pixels high.
  • This is measured in pixels, starting at the enemy's offset point and moving towards the player's offset.
  • If not included, the first number will default to -10, and the second to 20 times the entity's jumpheight variable.
  • For homing projectiles, this determines their targeting range.
  • If this command is declared together with 'rangez' and/or 'rangea', opponent's location must be within ALL of them before attack animation is performed.
  • Default 'range' for ATTACK{#} is 0 75, for JUMPATTACK and JUMPATTACK2 is 0 150, for UPPER -10 120 and for BLOCK is 1 100. The last one only has effect if enemy uses 'nopassiveblock'.
rangez {min} {max}
  • This command works similar with 'range' (see above) except that it works in z axis instead.
  • Default values for {min} and {max} are '-grabdistance/3' and 'grabdistance/3' respectively.
  • If this command is declared together with 'range' and/or 'rangea', opponent's location must be within ALL of them before attack animation is performed.
rangea {min} {max}
  • This command works similar with 'range' (see above) except that it works in y axis or altitude instead.
  • Default values for {min} and {max} are -1000 and 1000 respectively.
  • If this command is declared together with 'range' and/or 'rangez', opponent's location must be within ALL of them before attack animation is performed.
attack{#} {x} {y} {right} {down} {damage} {power} {block} {noflash} {pausetime} {z}
  • An attack box which can hit bboxes
  • OpenBoR supports 10 different attack boxes by default and {#} determines which one the frame is using. There's no space between 'attack' and {#} though.
  • You can only have one type of attack box per frame (that is, you can't have two attack boxes or an attack and an attack4 box in the same frame). You can 'fake' an extra box or two by adding in extra frames with different boxes and changing the delay accordingly, but this takes up more memory (for the extra frames) and doesn't work perfectly, so try to do so sparingly.
  • {x}, {y}, {right}, and {down} work exactly like in a bbox.
  • {damage} determines how much damage the attack does. Setting it to 0 also works. Great for making launchers, slams and paralyze attacks.
  • {power} is an integer value that determines how strong the knockdown effect of this attack. 0 means no knockdown, 1 means knockdown level 1, etc. This is used in conjunction with 'knockdowncount' (see above).
  • {block} is a binary value which determines if an attack is unblockable.
  • {noflash} is a binary value which controls whether the flash is displayed. 0 means flash, 1 means no flash.
  • {pausetime} is an integer which will cause the attacker and attackee to be paused for {pausetime} if the attack hits something.
  • {z} determines attackbox' width in z axis.
  • If you change or repeat an attack box's declaration later in the animation, you can create combos in same animation. However, a certain amount of time must pass before targets can be hit again (This can be avoided with 'fastattack'). Also, you must have at least one frame with a blank attack box (One set to 'attack 0') between the two frames or sets of frames which combo.
  • You can use negative numbers or numbers outside of the frame's edges.
  • Can be used multiple times in one animation to change hit areas mid-animation
  • When the attacking part of the animation is over, use 'attack 0'. Otherwise, the attack box will remain and can continue hitting people for the rest of the animation!
  • Each 'attack{#}' has respective PAIN, FALL and DEATH animation. For instance, if attacker hits opponent with attack2, the latter will play PAIN2 (if attack2 doesn't knock him/her down) or FALL2 (if attack2 knocks him/her down) or DEATH2 (if attack2 kills him/her).
attack11,attack12,...
  • These attacks are only usable if you have increased attacktype limit. To increase the limit use 'maxattacktypes' (see details above in Models.txt section).
  • After they are available, they work just like other attacks. That also means respective PAIN,FALL and DEATH animations are also available.
blast {x} {y} {right} {down} {damage} {block} {noflash} {pausetime} {z}
  • An attack box which can hit bboxes.
  • Unless otherwise specified, this works exactly like an 'attack' command.
  • blast attacks always knock the enemy down, and sends them flying farther than normal. A 'blast'ed enemy will also be able to hit other entities and knock them down.
shock {x} {y} {right} {down} {damage} {knockdown} {block} {noflash} {pausetime} {z}
  • A shock attack box which can hit bboxes.
  • Unless otherwise specified, this works exactly like an 'attack' command.
  • If this attack hits an enemy or player, they will play their SPAIN or SHOCK animation.
burn {x} {y} {right} {down} {damage} {knockdown} {block} {noflash} {pausetime} {z}
  • A burn attack box which can hit bboxes.
  • Unless otherwise specified, this works exactly like an 'attack' command.
  • If this attack hits an enemy or player, they will play their BPAIN or BURN animation.
freeze {x} {y} {right} {down} {damage} {time} {block} {noflash} {pausetime} {z}
  • A paralyzing attack box which can hit bboxes.
  • Unless otherwise specified, this works exactly like an 'attack' command.
  • The target will be frozen solid for {time}. They will be unable to attack, move, use specials, etc. If they have an fmap, they will change to that pallete.
  • {time} is measured in seconds.
  • Any attacks to a frozen target will cause knockdown. Freeze attacks on their own do not knock enemies down (Unless they were frozen to begin with).
steal {x} {y} {right} {down} {damage} {knockdown} {block} {noflash} {pausetime} {z}
  • An attack box which can hit bboxes.
  • Unless otherwise specified, this works exactly like an 'attack' command.
  • If this box hits a player or enemy, it will drain life from the target and give it to the attacker.
quakeframe {frame} {loops} {intensity}
  • Used to make screen shakes with certain intensity.
  • {frame} determines at which frame the quake/shake starts.
  • {loops} determines how many quake this animation will make after quake starts. Bear in mind that if the animation ends, there won't be another quake. And you have to provide a frame for each quake.
  • {intensity} determines how strong the quake would be. Technically it is how far the panel would go down in pixels. Negative value works for this.
move {x}
  • Starting with the next frame, the entity will move forward (x) pixels with every new frame.
  • This value must be set to 0 again to stop the entity from moving any further during the animation.
  • You can use a negative value for (x) to move the entity backwards (Or slow their movement if they move automatically, like a jump attack).
  • Somewhere above 200, this value will allow an entity to run offscreen, out of play, and into oblivion. If you want to get rid of a sprite, this should fit the bill, but otherwise you'll have a suicidal entity. If you ARE trying to kill something, use a value like 1000, just in case.
movea {a}
  • Starting with the next frame, the entity will move upward (a) pixels with every new frame.
  • This value must be set to 0 again to stop the entity from moving any further during the animation.
  • You can use a negative value for (a) to move the entity back down towards the ground (Or maybe a pit if they aren't paying attention!).
movez {z}
  • Starting with the next frame, the entity will move (z) pixels towards the screen with every new frame.
  • This value must be set to 0 again to stop the entity from moving any further during the animation.
  • You can use a negative value for (z) to move the entity away from the screen, towards the background.
seta {a}
  • Changes the entity's altitude off the ground to {a}.
  • The entity will remain at this altitude until changed again with 'seta' or the animation ends.
  • If the animation ends and the entity is off the ground, they will fall back down while playing their IDLE animation.
  • Setting a>0, allows entity to fly above holes or simply not fall to holes.
platform {upperleft} {lowerleft} {upperright} {lowerright} {depth} {alt}
  • Turns an entity into a walkable platform.
  • The fields are all the same as in normal platforms defined in a stage's .txt file.
  • This can be changed on a per-frame basis to make platforms move up and down or shift left and right (or both, or neither).
  • If this entity moves with seta or move, any entities on top of it will also move up and down with it.
  • You can stack multiple platforms on top of each other. If you do, seta commands will be cumulative (that is, if you have a platform with seta 30 spawn on top of one with seta 50, it will be treated as being 50+30= 80 pixels off the ground, instead of 30 or 50.)
dive {hori} {vert}
  • Allows characters to dive while in air. So obviously, they need to be in the air for it to work.
  • {hori} controls how quickly the diving entity will move forward, horizontally.
  • {vert} controls how quickly the diving entity will move downward, vertically.
  • Note that a move with dive in it always starts diving at the first frame.
energycost {int}

Determines energy loss behavior for a specific animation.

  • {int} (default: 6 for Special, 0 for all others.)
    Amount of energy to be used.
  • If the entity has enough mp to perform the move, {int} is subtracted from it's mp. If not, the difference will be subtracted from the entitiy's health. This can be modified on a per move basis with mponly settings.
  • If the entity does not have sufficient energy, the move cannot be performed. A player controlled entity in the air will play Jumpcant if it is available. In all other cases player commands for the move are simply ignored.
  • AI controlled entities will not attempt to perform a move if their energy is insufficient.
mponly {int}

Determines the type of energy needed (and required) for an animation.

  • {int} (default: 0)
    0 = If the entity has enough mp to perform the move, {int} is subtracted from it's mp. If not, the difference will be subtracted from the entitiy's health.
    1 = Only mp.
    2 = Only health.
sound {path}
  • {path} points to a sound effect. The sound will be played as soon as the next frame is reached.
  • Only one sound can be played per animation. If you really want more, you can either fuse the two sounds into one file, or have the entity fire a projectile with no graphics which plays one of the sounds at the appropriate time.
pshotframe {frame} {a}
  • If this command is present, the player will fire it's 'pshot' once frame {frame} is reached.
  • The projectile will be spawned at altitude {a}. Since you can't use 0 for {a}, if you want to have the projectile on the ground (and thus able to fall into pits it crosses) use -1 instead. It will spawn at 0, not -1.
  • The shot is defined by using the 'playshot' command.
  • {a} defaults to 70.
  • This command is outdated since all entities including players can use throwframe for same purpose.
throwframe {frame} {a}
  • If this command is present, the entity will throw it's 'star' or 'knife' once frame {frame} is reached.
  • The projectile will be spawned at altitude {a}. Since you can't use 0 for {a}, if you want to have the projectile on the ground (and thus able to fall into pits it crosses) use -1 instead. It will spawn at 0, not -1.
  • The projectile is defined by using the 'star' or 'knife' commands.
  • Actually putting 'load star' or 'load knife' in the .txt file works also but it's only loads projectile named 'star' and 'knife' respectively.
  • {a} defaults to 70.
  • Knives will be used if the entity is on the ground. Three stars will be used if the entity is airborne.
  • If you want entity to throw knives while entity is airborne use 'shootframe' instead.
tossframe {frame} {a} pbombframe {frame} {a}
  • Use "pbombframe" for players and "tossframe" for enemies.
  • If this command is present, the entity will throw it's 'bomb' once frame {frame} is reached.
  • The projectile will be spawned at altitude {a}.
  • The projectile is defined by putting 'load bomb' in the .txt file, or using the 'bomb', 'pbomb', 'custbomb', or 'custpbomb' command.
  • {a} defaults to 70.
jumpframe {frame} {height} {speedx} {speedz}
  • If this command is present, the entity will perform a jump once frame {frame} is reached.
  • {height} is jumping velocity, {speedx} is x axis velocity and {speedz} is z axis velocity. Positive {height} value moves entity up, positive {speedx} moves entity front while positive {speedz} moves entity down in z axis. Negative value works the opposite.
  • Only one jumpframe command counts- you can't jump more than once in an animation by putting more in, even if the entity lands before the next jump starts.
  • Now this command gives same effect to all entities. However there are default setting left behind for backwards compatibility. If {speedx} and {speedz} are not provided this is how the jump would be:

Height is 0:

Player: The jump is very low, but the character moves forward.

Enemy: The jump is high and vertical.

Height > 0:

Player: The jump is {height} high, and vertical.

Enemy: The jump is {height} high, and moves forward. If you don't want that effect, simply give the desired value for {speedx} or just 0.

  • Setting 'jumpframe' in any FALL animation will change the respective falling arc. Useful to make launchers and custom throws.
custpshot {name}
  • If present, for this animation only, the entity's default 'knife' entity will be replaced with this entity.
  • This command is outdated and supported only for the sake of modders who already were using it. Using "knife" is probably a better idea.
mpcost {int}
  • When the attack is performed, (int) will be subtracted from the player's MP.
  • This command is outdated and supported only for the sake of modders who already were using it. Using "energycost" is probably a better idea.
custfireb {name}
  • If present, for this animation only, the enemy's default 'fireb' entity was replaced with this entity.
  • This command is outdated and no longer used. Try 'knife's and 'throwframe's instead.
shootframe {frame} {a}
  • This command is similar to 'throwframe' but it shoots 'shot' instead.
  • {a} defaults to 0.
  • This command won't throw stars if entity is airborne so it's ideal for shooting knives while airborne.
flipframe {frame}
  • Used to make character turn around when frame+1 is played.
  • Management is not responsible for any damage caused of using this command in improper animation such as WALK.
followanim {value}
  • Determines which FOLLOW animation played when followup condition is met or when counter condition is met.
  • Possible values are 1, 2, 3 and 4.
  • Used together with 'followcond' or 'counterframe'.
followcond {value}
  • This command is to make the entity performs FOLLOW{#} if an attackbox in the animation hits.
  • value determines the condition requirements before FOLLOW{#} is played.

1, this animation will followup as long as it hits an entity.

2, this animation will followup as long as it hits an enemy (Or player if an enemy uses it).

3, this animation will followup as long as it hits an enemy and the target does not get killed or block the attack.

4, this animation will followup as long as it hits an enemy, and the target is not killed, does not block the attack, and is not set to be ungrabbable.

  • Which FOLLOW animation played is determined by 'followanim'.
counterframe {frame} {cond} {damaged}
  • This command is to make entity performs FOLLOW{#} if the entity is hit in set frame.
  • frame determines at which frame if entity is hit , FOLLOW{#} would be played.
  • cond determines the condition requirements before FOLLOW{#} is played.

1: The counter will always be used.

2: The counter will be used as long as the attacker was an enemy (Or a player if an enemy uses it).

3: The counter will be used as long as the attacker was an enemy, the attack was not unblockable, hits the user from the front, and was not a FREEZE attack.

  • damaged determines whether the entity will receive damage from the hit or not.

0, the damage won't be taken

1, the damage will be taken

spawnframe {frame} {x} {z} {a} {relative}
  • Used to make entity to spawn another entity. Normally it is used to spawn enemy. Spawning with this has no limit.
  • The spawned entity is determined by 'subentity' or 'custentity'.
  • {frame} determines at which frame the other entity is spawned.
  • {x} determines spawn range in x axis.
  • {z} determines spawn range in z axis.
  • {a} determines spawn range in y axis.
  • {relative} determines where the other entity is spawned.

0, count from the spawner. Spawned entity will face same direction with the spawner.

1, count from screen offset.

summonframe {frame} {x} {z} {a} {relative}
  • Used to make entity to spawn another entity. Normally it is used to spawn enemy. Spawning with this is limited to 1 entity.
  • The spawned entity is determined by 'subentity' or 'custentity'.
  • {frame} determines at which frame the other entity is spawned.
  • {x} determines spawn range in x axis.
  • {z} determines spawn range in z axis.
  • {a} determines spawn range in y axis.
  • {relative} determines where the other entity is spawned.

0, count from the spawner. Spawned entity will face same direction with the spawner.

1, count from screen offset.

  • Summoned entity can be killed with 'unsummonframe'.
unsummonframe {frame}
  • Used to kill summoned entity which was summoned by 'summonframe'. Obviously you need to use 'summonframe' before.
  • {frame} determines at which frame the other entity is spawned.
subentity {name} custentity {name}
  • {name} is the name of spawned entity declared in MODELS.txt. That means the entity must be loaded in MODELS.txt before you can use this.
  • This is used together with 'spawnframe' or 'summonframe'.
  • {name} determines what/which entity will be spawned or summoned with spawnframe or summonframe.
weaponframe {frame} {weapon}
  • This is used to switch weapon in an animation.
  • {frame} determines at which frame the weapon is switched.
  • {weapon} is weapon's number determines which weapon will be used to replace.
  • Obviously you need to provide weapon sets for the character first before using this.
attackone {bi}
  • This command sets attackboxes's ability in the animation to hit other opponent.

0, attackboxes can hit all opponents. This is default setting for all animations but grabattacks

1, attackboxes can only hit one opponent. This is default setting for all grabattacks.

grabin {type} {distance}
  • If this command is declared, next nonknockdown attackbox makes entity grab opponent in same manor as normal grab.

0, no effect (used to turn off grabin)

1, Opponent is pulled in while this entity doesn't move

2, Both entity and opponent are pulled each other splitting the distance

  • {distance} controls how far entity and opponent would be when grabbing starts.
  • Use this command with non knockdown attackbox of course.
forcedirection {dir}
  • If this command is declared, opponents hit by attackbox will face specific direction instead of facing entity.

0, no effect (used to turn off forcedirection).

-2, Left. It means always left no matter where opponent is hit.

-1, opposite of entity.

1, same direction of entity.

2, Right. It means always right no matter where opponent is hit.

  • Use this command with an attackbox of course.
damageonlanding {value} {type}
  • If this command is declared, opponents hit by knockdown attackboxes will get {value} extra damage when they land. {type} determines whether attackbox in opponent's FALL is activated or not.

0, attackboxes are not activated.

1, attackboxes are activated.

2, attackboxes are activated and opponents can perform land to safety.

  • Use this command with knockdown attackbox of course.
dropv {height} {speedx} {speedz}
  • This command controls opponent's flight path during his/her FALL animation.
  • {height} controls falling speed in y axis. It works the same with {height} in 'jumpframe'.
  • {speedx} controls falling speed in x axis. It works the same with {speedx} in 'jumpframe'. Bear in mind, that this setting is relative to this entity's facing direction not opponent's.
  • {speedz} controls falling speed in z axis. It works the same with {speedz} in 'jumpframe'.
  • Use this command with knockdown attackbox of course. However it must be declared AFTER that attackbox.
dropframe {frame}
  • This is used to make entity switch to set {frame} when flight apex is reached while in air.
landframe {frame}
  • If this is set, entity will be at frame {frame} when entity lands after jumping with 'jumpframe' or while falling.
  • In order to get this to work properly, give long delay to frame right before landing frame. The former frame will be played while 'waiting' to land.
counterattack {bi}
  • If set to 1, attackboxes in this animation will also hit opponent's attackbox. However, this only works if opponent has active bbox when he/she is attacking.
  • Like the name said, this is great for counter attacks.
fshadow {int}
  • This is used to set entity's shadow for the current frame.
  • Possible values are 0 to 6. The possible shadows for use are same with shadows for 'shadow' command (see 'shadow' above).
  • This consumes more memory so use with care.
shadowcoords {x} {y}
  • Adjust offset of entity's shadow for the current frame. Defaults to current frame's offset.
  • Obviously the entity must use 'shadow' before using this.
  • This consumes more memory so use with care.
itembox {x} {y} {right} {down}
  • An item box which can hit bboxes. This can only be used by 'item' entities.
  • {x}, {y}, {right}, and {down} work exactly like in a bbox.
  • If another entity touches this itembox, the item will be picked up by that entity.
  • The entity who can touch or pick this item is determined by 'candamage'. See 'candamage' above.
stun {int}
  • This command makes the attack freezes opponent for {int} seconds without remap change.
  • If there's no frozen remap at all, this command is not required cause 'freeze' can make same effect.
  • Use this command with non knockdown attackbox of course. However it must be declared AFTER that attackbox.
seal {int}
  • This command makes the attack disables opponent's freespecials and specials for {int} seconds. IOW the attack silences opponent.
  • Usually used with slams and throws to prevent opponent to break free with special.
  • Use this command with attackbox of course. However it must be declared AFTER that attackbox.
forcemap {map} {time}
  • This command makes the attack changes opponent's remap to {map} for {time} seconds.
  • Usually used with poison, fire or elemental attacks. Just for graphical effect.
  • Use this command with attackbox of course. However it must be declared AFTER that attackbox.
drain {time} {resource} {amount} {rate}
  • This command makes the attack trigger drain effect on opponent's resource over time.
  • Resource determines which resource is drained.

1 = HP is drained

2 = MP is drained

3 = Both HP and MP are drained.

  • Amount determines how much resource is drained per tick.
  • Rate determines delay time between tick in seconds.
  • Time determines how long drain effect occurs in seconds.
  • Use this command with attackbox of course. However it must be declared AFTER that attackbox.
noreflect {bi}
  • This command makes the attackbox only damages target entity without changing target's animation to PAIN or FALL if {bi} set to 1.
drawmethod {scalex} {scaley} {flipx} {flipy} {shiftx} {alpha} {remap} {fillcolor} {rotate} {fliprotate}
  • This command defines how current frame will be drawn.
  • {scalex} is integer value, when set to 256, the frame will be drawn in original width, use different values to scale it. Negative value will flip the frame.
  • {scaley} is integer value, when set to 256, the frame will be drawn in original height, use different values to scale it. Negative value will flip the frame.
  • {flipx} is integer value, when set to 1, the frame will be flipped leftright.
  • {flipy} is integer value, when set to 1, the frame will be flipped updown.
  • {shiftx} is integer value, use to lean the sprite. Might not be quite useful, it is used by gfxshadow, just add it.
  • {alpha} is integer value.

0 = No alpha effect.

1-6 = Alpha 1-6

-1 = Use entity's alpha.

  • {remap} is integer value. Will be overridden by {alpha}.

0 = No remap.

1-n = Like a map command in spawn entry, give the entity a colormap.

-1 = Use entity's colormap.

  • {fillcolor} is integer value, from 0 to 255, specify a color index in your palette. It can be used with alpha, fill current frame with this color.
  • {rotate} is integer value to specify rotation angle(clockwise), from 0 to 359. If you use a value out of the range, it will be changed automatically, for example, 370 will be changed to 10, -20 will be changed to 340.
  • {fliprotate} is binary value. When it is set to 1(should be only 0 or 1, not other values), the entity will change the rotate value when the direction is changed(entity's direction, if you use flipx for the frame, it is not affected), the rotate value will be 360-original, so
  • This command affect all frames starting from current frame. If you want to stop it, use 'nodrawmethod' below.
nodrawmethod
  • This command disables 'drawmethod'.
  • Use this with 'drawmethod' of course. See 'drawmethod' above.
bouncefactor {y}
  • This command determines how high entity would bounce after touching ground while playing any FALL animation. 'Jumpheight' (see above) also affect this but this command overrides it just for this animation.
  • {y} has exactly same effect with {y} in 'jumpframe'. For instance, max bounce height from 'bouncefactor 2' is same with max height from 'jumpframe 0 2'.
  • Use this in FALL animation of course.

Using Weapons

This section provides information about setting weapons for use in OpenBoR.

Warning:

Weapons require more memory! A new weapon is a new character, and it has to be loaded into memory at all times! That also means you should load the player with weapon models with load, not know, in MODELS.txt.

Limitations:
  • Weapons are dropped if you are hit while carrying them by default. You have to use 'weaploss' to change this.
  • Weapons are lost if you drop them more times than their 'counter' value or go to a new level (even if you don't go to a whole new stage).
  • Although you can change a player's max health when they pick up a weapon, doing so will not recover their current life.

Entities with a subtype "project" are similar to weapons. Consider both and decide which will work best for you!

Weapons require a few changes:
Original player file:
  • Add this line: weapons {name1} {name2} {name3} {name4} {name5} {original name}
  • {name#} is the name of the model loaded in MODELS.txt which this character becomes when they pick up weapon #.
  • {original name} is the name of the character when it doesn't have any weapons equipped.
Player with weapon model:
  • Create a normal player file with the weapon model's data, but do not include any fields or animations which are the same as the original's. Don't worry if it's normally required, only include altered fields. The original .txt is basically "upgraded" with the new weapon .txt- fields which are different are replaced, new fields get added, and fields which are not mentioned are not changed.
  • You do need a name, though. And it has to match the name used in the original player's {name#} field.
  • You also need to redefine freespecials which can still be used. If the animation hasn't changed, you only need to specify the input commands. This way, you can make players lose some freespecials while holding a bulky gun, whip, particle beam, etc.
  • This entity should have 'type none'. Do NOT give it 'type player', unless you want it to be selectable from the player select menu.
Item which gives you the weapon:
  • Set it up like a normal item, but give it

subtype weapon

and

weapnum {#}

where {#} is the number of the weapon which this item gives players (1-10).

Some other weapon-specific commands you may want in the weapon's file:

shootnum {int}

counter {int}

typeshot {bi}

System Files

This section describes some extra files which are used by OpenBoR.

flash.txt
  • A standard .txt file for an entity, but the only animation it needs is IDLE.
  • It should have type none. It doesn't behave any different with any other type, though.
  • This graphic plays when an attack box of any kind hits a bbox.
  • The offset is the point at which the flash will be centered.
  • I would strongly advise NOT setting this to loop, for reasons that will become obvious fairly fast if you do.
  • BoR doesn't have a default location for this, so it must be loaded in MODELS.txt.
  • This can be overridden on a per-entity basis with various commands.
data/SPRITES/font.gif
  • The most-often used font.
  • Characters are 9*9 boxes. There are repeated characters, some of which are used in specific situations, but I'm having trouble figuring out which is used where (If you know, tell me!).
  • OpenBoR fonts are not monospaced. That is, the space between two letters is determined by how wide the letter is. If your letters 'overlap', try placing a black outline around them, or moving them rightward a few pixels.
data/SPRITES/font2.gif
  • The font used when a selection is highlighted, and for newly-added scores on the high score screen.
  • Characters are 9*9 boxes. There are repeated characters, some of which are used in specific situations, but I'm having trouble figuring out which is used where (If you know, tell me!).
  • OpenBoR fonts are not monospaced. That is, the space between two letters is determined by how wide the letter is. If your letters 'overlap', try placing a black outline around them, or moving them rightward a few pixels.
data/SPRITES/font3.gif
  • This font is used as a 'header' for most options list. It appears at the top of the difficulty selection menu and the options menu, mostly.
  • Characters are 9*9 boxes. There are repeated characters, some of which are used in specific situations, but I'm having trouble figuring out which is used where (If you know, tell me!).
  • OpenBoR fonts are not monospaced. That is, the space between two letters is determined by how wide the letter is. If your letters 'overlap', try placing a black outline around them, or moving them rightward a few pixels.
data/SPRITES/font4.gif
  • The large font used for 'game over' and 'next' screens, the timer, and a few other places.
  • There is a copy of this font in the OpenBoR GUI folder. It's used there as the normal font.
  • Characters are 13*17 boxes. There are repeated characters, some of which are used in specific situations, but I'm having trouble figuring out which is used where (If you know, tell me!).
  • OpenBoR fonts are not monospaced. That is, the space between two letters is determined by how wide the letter is. If your letters 'overlap', try placing a black outline around them, or moving them rightward a few pixels.
data/SPRITES/shadow{#}.gif
  • {#} is a number from 1 to 6.
  • This graphic is used as a shadow with negative alpha transparency.
  • You can make the shadows larger or smaller, but the shadow will not be recentered if you do, so you must change the entity's offsets accordingly.
data/SPRITES/arrow.gif
  • Normally, an arrow pointing rightward.
  • When a player has the ability to continue moving in the level, but does not do so, this graphic will flash on the right side of the screen to tell them to move.
data/SPRITES/arrowl.gif
  • This works like the arrow.gif file, but it flashes on the left half in stages which scroll left.
data/bgs/hiscore.gif
  • This is a .gif file which will be displayed as the background of the high score screen.
  • Defaults to an inky black nothing.
data/scenes/gameover.txt
  • This is a cutscene file. If it exists, it will be played when all players lose all their lives and credits, or if a player chooses to quit during a game.
  • If this file isn't found, OpenBoR displays the default game over screen: the letters "GAME OVER" displayed in font 4.
data/bgs/complete.gif
  • This is a .gif file which will be displayed as the background of the stage complete screen.
  • If this file isn't found, OpenBoR displays the default stage complete screen: "STAGE # COMPLETE" displayed in font4; "Clear Bonus", "Lives Bonus" and "Total Score" with their respective score in font2.
  • In order for this to display, 'completebg' must be set to 1 in LEVELS.txt.
data/bgs/select.gif
  • Displays in the background of the player select screen.
  • select.gif must use the BOR palette. The interesting thing is that, just like the stages backgrounds, that image can use its own palette, by using more than 128 colours. It means that your image can contain up to 256 colours, where the 128 first colours must be the BOR palette, and the 1 to 128 next colours can be custom colours specific to that image.
data/bgs/select.txt
  • Cutscene file. Displays after selecting a difficulty but before reaching the player select screen.
  • THIS FEATURE DOESN'T WORK CURRENTLY' so don't bother implementing it.
data/bgs/unlockbg.gif
  • Displays in the background of the player select screen, once you've completed the game at least once.
data/bgs/hiscore.gif
  • A background for the high score screen.
  • In order for this to display, 'hiscorebg' must be set to 1 in LEVELS.txt.

Cutscene Files

This text is for setting animated .gif and music to play in a cutscene. Aside from between level cutscenes, it is also used for setting intro, gameover and howtoplay scene. It's optional but your mod looks better if you use it.

music {path} {loop}
  • {path} points to a .bor music file which will play.
  • {loop} determines if the music loops. 0 means no, 1 means yes.
animation {path} {x} {y} {skip} {noskip}
  • {path} points to an animated .gif file which will be played.
  • {x} and {y} are the x and y positions of the top left corner of the .gif.
  • {skip} is a flag that allows players to skip current animation. Set to 1 to enable it.
  • {noskip} is a flag that prohibit skipping. Set to 1 prevent skipping.
  • Max size is 320x240.
silence {int}
  • If {int} is 1, the current song will stop playing.

Select Screen Files:

This text is for setting custom select screen and allowed players. It's optional.

music {path} {loop}
  • {path} points to a .bor music file which will be played during this select screen.
  • {loop} determines if the music loops.

0 = no looping.

1 = looping.

background {path}
  • Set backgrounds for select screen. If it's not provided, default select.gif will be used instead.
  • {path} points to background graphic.
  • Background graphic must be paletted like select.gif. The 1st 128 colors must be same with pal.act your mod is using.
allowselect {playername1} {playername2} ....
  • Defines allowed players in this select screen just for current level set.
  • {playername#} is the name of player. You can define more than one but no need to repeat same one.
  • Make sure the allowed players are loaded otherwise they won't be available. OTOH if a player is loaded on a level, he/she is affected by this settings too.
  • The allowance or disallowance only works when playing the mod. If you load saved game, it defaults to old one.

Level Files - Level Design

This text is for setting levels and spawned objects in them. It's not mandatory but if there's no level where would players go to?. Due to many features, this part is divided into two parts. This part is for level design and the second part is for setting spawned objects.

type {type} {special} {inv}
  • Optional.
  • {type} is a binary value which determines if the stage is a normal stage (0) or a bonus stage (1).
  • Bonus stages end when all obstacles are destroyed, when there are no more items or when time runs out. Players won't lose a life if time runs out.
  • {special} is also a binary value. 0 means nothing, but if set to 1 then players will be unable to use their SPECIAL, SPECIAL2 and SPECIAL3/JUMPSPECIAL in this stage.
  • {inv} controls invincibility. 0 means players can be hurt by enemies. 1 means players can't be hurt by enemies (effects like knockdown or freeze still work though). It only prevents enemies from depleting players health though. Players can still lose health from 'energycost' even if this is set to 1.
music {path}
  • Optional.
  • {path} points to a .bor music file which will be played during the stage.
bossmusic {path}
  • Optional.
  • {path} points to a .bor music file which will be played when a boss appears.
spawn1 {x} {z} {a}
  • Optional.
  • {x} is relative to the starting edge of the screen. {z} is relative to the stage's minimum z value. {a} is relative to the ground.
  • {x} is measured from left for levels with direction right and both and it's measured from right for levels with direction left.
  • Although {x} could be any value, its maximum value is 320. Value more than 320 will be deducted by 320. For instance, setting x = 540 will put player in x = 220 instead (220 = 540 - 320).
  • {z} could be any value but it can't put player 1 beyond maximum z value.
  • Setting {a} > 0 makes player falls down on respawn. Default value for a is 300. NOTE: {a} only effect respawn not when level starts.
  • If there's a hole on player's spawn spot, the spawn spot will be shifted up or down to safe place temporary.
spawn2 {x} {z} {a}
  • Optional.
  • Works exactly like spawn1, except that it sets the respawn position for Player 2.
spawn3 {x} {z} {a}
  • Optional.
  • Works exactly like spawn1, except that it sets the respawn position for Player 3.
spawn4 {x} {z} {a}
  • Optional.
  • Works exactly like spawn1, except that it sets the respawn position for Player 4.
direction {dir}
  • Determines which direction the screen scrolls in.
  • {dir} can be right, left, both/rightleft, up, down, in, out, inout, outin, or leftright. Defaults to right if not declared.

up and down scroll background up and down respectively and automatically. You cannot scroll left or right in these stages. You must use groups to control enemy spawning. Wait doesn't work well here so that means you have to watch the time here. Put time item or simply set time to 0. Panels, neons and screens are not scrolled. left and right must be scrolled manually, like normal.

both or rightleft is pretty neat. It's like direction right but it allows you to freely scroll left or right. When you reach a wait, you won't be able to move back past the previous wait until all spawned enemies prior to wait are killed.

leftright is similar direction both but it's like direction left instead. in and out is new scrolling system in which player scrolls in or out respectively. In means up in z axis while out means down. Just like left and right, it must be scrolled manually. inout and outin is similar to direction both but they are like direction in and out respectively.

  • Screen, neon, water, etc don't work well in direction in, out, inout and outin.
bgspeed {speed} {dir}
  • Causes the background of the stage to scroll by automatically.
  • {value} should be a number from 0 to 30 or so. 0 means no movement, 1 means slow movement, and anything above that means faster movement.
  • {dir} controls the direction that the background moves in. 0 means right-to-left, 1 means left-to-right
settime {int}
  • This stage's time limit will be {int}.
  • If {int} is 0, the player will have unlimited time.
  • The timer resets every time a 'wait' group of enemies is cleared. Note that it doesn't reset in between groups, only waits!
  • Using 'settime 1' isn't funny. Okay, it's a little funny the first time.
  • Don't forget to use 'Time' items when needed!
notime {bi}
  • Determines whether or not the player can see the game timer.
noreset {int}
  • Determines when clock resets aside from clearing wait, clearing level and time out.

0 = (default) Clock resets when another player joins mid-stage and when player respawns.

1 = Clock only resets on time out.

2 = Clock resets when player respawns.

noslow {bi}
  • Determines whether or not the game slows down after beating a boss.
background {path}
  • {path} points to a graphic file which will be visible behind all the sprites and panels.
  • The image used must have a width which is a multiple of 4 (ex. 4, 200, 128, not 3, 202, 130).
  • The default height is anything from 1 to 240.
  • The graphic automatically repeats if the stage is longer than the background.
  • Using the transparent color in backgrounds can lead to an interesting visual effect. Afterimages will be left by any and all graphics which pass over transparent sections. This isn't what you normally want, though.
water {path} {warp}
  • Optional.
  • {path} points to a graphic file which will be used as a watery background.
  • the graphic appears at the {BGHeight}, which is defined with 'z' in LEVELS.txt. If no {BGHeight} is set, it will appear right under background.
  • If you use 'rock 0' or do not include the rock command, the water will be warped by a sine wave (It will slither back and forth). {warp} will determine how quickly the waving will occour.
  • If you use 'rock 1' in the same stage, the water will float past in parallax (The graphic gets larger as it approaches the playing area). {warp} will determine the speed.
rock {int}
  • Optional.

0 means nothing.

1 means the level floats up and down slightly.

2 will cause the stage to remain steady for a second or so, then quickly shake twice. Should resemble the steady rocking on a train ride.

3 will cause the stage to shake with a constant, steady rumbling, with occasional 'hiccups'. This one looks like what you might feel if you were riding in a moving van or on top of a moving eighteen wheeler.

mirror {bi}
  • Optional.
  • Determines whether or not there is a mirror in the background.

0 means no mirror effect.

1 means that sprites will have a "mirror" image drawn between the background and panels.

panel {norm} {neon} {scrn}
  • {norm}, {neon}, and {scrn} are paths which point to the normal, neon, and screen graphics for a panel. {neon} and {scrn} are optional fields. If you aren't using them, put the word 'none' in their place.
  • Panels are mostly used as the floor and walls of a screen.
  • Panels are normally 244 pixels high, but should be 256 if the stage is set to rock up and down. It may also need to be changed depending on the 'z' values set in LEVELS.txt
  • You can use whatever width you want, but it's a good idea to use simple values like 100, 150, or 360. It makes it much easier to add up the total length of the stage.
  • All panels in a stage should have the same length and height.
  • If you overlap part of the image used in one panel with another, the computer will still try to draw both. Be nice to computers. Don't overlap panel layers.
  • Normal mode panel layers are just plain images. They have no visual effects.
  • Neon mode panel layers use 'pallete cycling': certain colors slowly change to different colors. To be more specific, colors 128 through 135 in the pallete will be cycled by two steps three times each second.
  • Screen mode panel layers have alpha transparency. That means, they blend with the colors behind them, darker colors are more transparent, and brighter colors will blend less.
  • You can have up to 26 panels in a stage. They are labeled by OpenBoR from a to z. This is how OpenBoR thinks of them, don't actually put those letters in the panel declaration.
frontpanel {path}
  • {path} points to a panel layer which will be displayed on top of all other sprites and graphics except for the HUD. This can be used to make foregrounds.
  • frontpanels display in the order they are declared and repeat when they run out. You don't need to declare an order like with normal panels.
order {panel#}{panel#}{panel#}...
  • Determines the order of panels in a stage.
  • {panel#} is a letter a through z which corresponds to a panel. There should not be spaces between the panel declarations (ex. order abcabcada, not order a b c a b c a d a).
  • The same panel can be used more than once.
  • You can have up to 1000 panels ordered, but there's a catch: the engine can't read a line with 1000 characters in it (The max is somewhere around 100). To get around this, you can place the additional panels on another line with a separate order declaration, like this:

order abcdefghij order klabcd order eeabcdef

  • That '...' at the end doesn't mean you should put a ... at the end. It means the pattern repeats like it has been repeating so far.
  • If you use 'direction left', panels will be displayed from left to right, starting with the last order and working up. In other words, the previous declaration would become 'eeabcdefijklabcdabcdefgh' instead of 'abcdefghijklabcdeeabcdef'.
hole {xpos} {zpos} {upperleft} {lowerleft} {upperright} {lowerright} {depth}
  • A 4-sided hole will be created at the specified point.
  • This is a bit complicated, so listen up! {xpos} and {zpos} are the x and z positions at which the hole is spawned (how far from the start of the stage, and how far from the top of the screen, respectively).
  • {lowerleft}, {upperleft}, {lowerright}, and {upperright} determine the x position of the four corners of the hole. These numbers are how far from the {xpos} the corners are, not how far from the start of the stage.
  • {depth} is the z depth of the hole: how far it stretches from the {zpos} to the top of the screen.
  • As an example, if you wanted to create a 10x40 parrallelagram ( /_/ ) hole at the bottom of the screen (256) at scroll position 500, you might put

hole 500 256 0 10 10 20 40

  • If you create a hole which is not at the bottom of the screen, entities will be visible as they fall off the stage. Probably bad. So place an entity with type none right below the bottom of the hole which resembles the floor. This will cover up almost any entities which fall in the hole.
  • If used in a stage which scrolls left, the holes will start at the left edge of the starting screen and move right from there. So only holes which would appear in the first 320 or so pixels of the screen will actually be visible, and they'll be at the start of the stage.
  • The default values are 240, 12, 1, 200, 287, and 45, respectively.
wall {xpos} {zpos} {upperleft} {lowerleft} {upperright} {lowerright} {depth}{alt}
  • Creates a 4-sided wall or platform at the specified point.
  • All of the field except {alt} are the same as they are in holes.
  • {alt} is used to control the height of the platform. It's measured in pixels. So for a wall with 10 for it's {alt} value would be 10 pixels high, any entity on the platform would be displayed 10 pixels off the ground, and entities would need to jump at least 10 pixels off the ground to get on top of the wall.
  • If you want to make a wall which can't be jumped on, simply give it a {alt} value somewhere in the lower thousands. Very, very, VERY few entities should be able to jump on it.
  • In order for enemies to get on platforms higher than their current position, they need a JUMP animation with a range set for it, and/or an animation which lifts them off the ground.

Image:Wallpit_mrq.png

endhole {bi}
  • Optional.
  • Determines if the rightmost edge of the stage is a pit.
  • 1 means yes. 0 means no.
  • Don't use this if your stage scrolls left. Trust me on this one.
blocked {bi}
  • Optional.
  • Determines if the edge of the stage is a solid wall. 1 means yes. 0 means no.
  • Entities who hit the wall will stop moving.
  • This always appears on the right side of the screen, and if you choose 'scroll left' players will start inside the wall. They warp out when the player moves, but it still looks funny.
  • If you combine 'endhole' and 'blocked', you'll end up with a blocked exit with a pit behind it. You can only reach the pit by starting behind it with 'direction left' (Which is a very bad idea).
loadingbg {path} {set} {bx} {by} {bsize} {tx} {ty} {tf}
  • This command allows custom loading background to be displayed while the current level are being loaded.
  • {path} determines the location of used background.
  • {set} determines how loading screen would be.

-1 = default black screen with loading and status bar.

0 = no loading screen.

1 = loading screen background and status bar.

  • {bx} and {by} determines x and y coordinates of loading bar top left's location respectively.
  • {bsize} determines loading bar's length.
  • {tx} and {ty} determines x and y coordinates of "LOADING" text location respectively.
palette {path} {a1} {a2} {a3} {a4} {a5} {a6}
  • This command loads new palette to be used by script or by 'setpalette' command (see below).
  • {path} is the path to loaded palette in .act format. For instance: data/bgs/staage1/pal001.act}.
  • {a1}, {a2}, {a3}, {a4}, {a5} and {a6} are flags that determines usage of respective transparency. a1 means alpha 1 transparency, a2 means alpha 2 and so on.
  • This transparency feature costs 384kb memory when palette is loaded so use with care.
  • This command can be declared more than once if more palettes are required.
gravity {value}
  • This sets gravity or falling speed in the level.
  • It should use negative value. Defaults to -10
  • Setting -5 makes characters fall like in water.
maxfallspeed {value}
  • This sets maximum falling speed in the level.
  • It should use negative value. Defaults to -60
  • Setting -20 makes characters fall like in water.
maxtossspeed {value}
  • This sets maximum jumpheight in the level.
  • It should use positive value. Defaults to 1000

Level Files - Level Objects

spawn {name}
  • {name} is the name of an entity defined in a .txt file which was loaded in MODELS.txt.
  • {name} will be spawned (created). Where and with what attributes are determined by the next set of fields.
2pspawn {bi}
  • If {bi} is set to 1, the entity is only spawned if there are 2 players playing.
3pspawn {bi}
  • If {bi} is set to 1, the entity is only spawned if there are 3 players playing.
4pspawn {bi}
  • If {bi} is set to 1, the entity is only spawned if there are 4 players playing.
alias {name}
  • The spawned entity will appear to have the name {name} in-game. For instance, if you used

spawn Rugal

alias Hotdog_Man

then when you reached Rugal in the stage, his name would be displayed as 'Hotdog Man'.

  • The rules from an entity's .txt file concerning names apply here, too. So use '_' instead of spaces if you want to use spaces.
map {pal}
  • {pal} is a number from 0 to 14 which corresponds to an entity's 'remap' pallete. The entity will use that pallete.
health {int}
  • {int} is a health value which will be used instead of the entity's normal health.
2phealth {int}
  • {int} is a health value which will be used instead of the entity's normal health, but only if there are 2 players playing.
3phealth {int}
  • {int} is a health value which will be used instead of the entity's normal health, but only if there are 3 players playing.
4phealth {int}
  • {int} is a health value which will be used instead of the entity's normal health, but only if there are 4 players playing.
mp {int}
  • For items spawned in a stage.
  • When a player picks this item up, they'll regain {int} MP instead of it's normal value.
dying {remap} {health1} {health2}
  • If this entity's health drops to or below {health1}, they will flash between their normal pallete and the {remap} pallete.
  • If their health drops to or below {health2}, they flash even faster.
item {name}
  • Optional.
  • When this entity dies, a {name} will instantly be spawned in it's place.
  • You can't make an entity drop multiple items.
itemhealth {int}
  • Optional.
  • Changes the health of a dropped entity to {int}
itemmap {int}
  • Optional.
  • Changes the pallete of a dropped entity to {int}
itemalias {name}
  • Optional.
  • Changes the name of a dropped entity to {name}
itemhealth {int}
  • Optional.
  • Changes the health of a dropped item to {int}
2pitem {name}
  • Optional.
  • Works just like 'item', except that this will only be spawned if there are 2 people playing.
3pitem {name}
  • Optional.
  • Works just like 'item', except that this will only be spawned if there are 3 people playing.
4pitem {name}
  • Optional.
  • Works just like 'item', except that this will only be spawned if there are 4 people playing.
boss {bi}
  • Optional.
  • If set to 0, nothing. If set to 1, the character is a boss. When a boss appears, the music will change to the boss music (if it was defined). Killing all the boss characters in a level will kill all other entities and will also end a stage automatically.
flip {bi}
  • Optional.
  • If set to 0, nada. If set to 1, the entity will face the opposite direction. Used for obstacles and traps most of the time, but it can also be used to make enemies who spawn on the left side of the screen face towards players from the start.
  • Can also be used for entities with subtype arrow to make them fly from left to right.
coords {x} {z} {a}
  • Determines the x, z, and a positions on the screen where the entity will spawn.
  • {x} and {z} are relative to the screen's current position, NOT the actual position in terms of the level itself.
  • {a} is how high off the ground the entity will spawn.
  • If {x} is between 0 and 320, and the entity is an enemy, it will magically fall out of the sky. Unless it has a SPAWN animation, in which case it'll play that.
  • If {x} is between 0 and 320, and the entity is an obstacle or item, it will magically appear out of thin air. Unless it has a SPAWN animation, in which case it'll play that.
  • In case you're wondering, the BoR playing field is, in bbox format, 0 320 160 230. Unless, of course, you've changed the {min} and {max} values in LEVELS.txt with 'z'. You can also place enemies outside those ranges, but they'll try to return to the playing field if you do.
  • Most projectiles will automatically die if their offset is more than 80 pixels offscreen left or right (their x value must stay between -80 and 400). Knives are the only exception: they can go up to 180 either way (-180 to 500). Other entities will also die if they move too far, but they have more leeway (Around 1000 in either direction). Keep that in mind while spawning characters.
  • Bikers should normally be spawned further out than other enemies. You'll probably want around 400 or -80 (But not more than -200 or 520, or they'll die).
at {pos}
  • For an entity to be spawned, the player must have scrolled to {pos} in the level.
  • {pos} is scroll position in pixels measured from start of level. For direction both and right, it's measured from left edge. For direction left, it's from right edge.
  • This must be declared together with other level objects. Normally typed after the latter.
wait
  • This isn't part of an entity's spawn. It doesn't take any arguments either. It should be followed by an 'at', though.
  • Screen scrolling will be stopped at {pos} in the 'at' command following the wait until all current enemies are killed.
  • In direction up and down, background scrolling can be stopped also with 'wait' but there's no way to make it auto scroll again.
group {min} {max}
  • Also not an entity spawn, also should be followed by 'at'.
  • Causes entities to be spawned in groups. When the number of enemies goes below {min} (not equal to, below), entities will be spawned until there are {max} enemies onscreen or there aren't any more enemies to spawn in the group.
  • Group size declarations remain in effect until changed. So use a large group size like 'group 100 100' to "cancel" the grouping.
  • 'wait' is also counted to 'group' so it's best to put 'wait' first to prevent it being limited by 'group'.
aggression {value}
  • For enemy spawns.
  • Spawned enemy's aggression will use this {value} instead of the enemy's normal aggression.
blockade {pos}
  • Optional. Used in direction both levels.
  • {pos} is scroll position and it's similar to the one for 'at'. {pos} for 'blockade' and 'at' can be different though.
  • This is to stop players scrolling backwards in levels with direction both at {pos}. If the level is long, you may want to use this since it could be weird being able to scroll back to beginning of level.
  • It must be followed by 'at'.
setpalette {palette}
  • Change palette in use to other palette which is loaded by 'palette' (see above).
  • {palette} correspond to the loaded palette number so if you want to use 2nd palette, set this to 2.
  • Like other level objects, this command must be followed by 'at' (see above) and also counted by 'group'.
shadowcolor {index}
  • This command changes gfxshadow's fill color to {index} at defined scrollpos. This is used together with 'gfxshadow' (see above).
  • {index} refers to current level palette's index.
  • Setting {index} to -1 turns gfxshadow off.
  • Setting {index} to -2 turns off fill color gfxshadow .
  • Must be followed by 'at'.
shadowalpha {index}
  • This command changes gfxshadow's from black shadow to mirrored image at defined scrollpos. This is used together with 'gfxshadow' (see above).
  • In case you don't understand, this is used to mirror image of entities appear on 'ground'. Useful if the 'ground' is actually water or mirror. Disable normal 'black shadow' 1st with 'shadowcolor' above before using this.
  • {index} refers to any alpha blending type i.e 1-6.
  • Setting {index} to -1 turns gfxshadow alpha off.
  • Must be followed by 'at'.
light {x} {z}
  • This command changes light direction to {x} {z} for gfxshadow's at defined scrollpos. This is used together with 'gfxshadow' (see above).
  • If {x} is not 0, the shadow will lean left or right (256 means 45 degree, try use some values and see what is the best value)
  • {z} can't be 0, because it is for the length of the shadow in z direction, 256 will make the shadow as long as its owner's sprite, and 128 will be half length. If it is negative value, the shadow will be flipped head-to-foot.
  • Must be followed by 'at'.
load {name}
  • Used to load a model in current level.
  • This command is for loading weapons models or other entities which shouldn't be loaded until this command is executed. It useful for memory usage control.
  • Like other level objects, this command must be followed by 'at' (see above) and also counted by 'group'.

Music Files

Recomendations:
  • Music files tend to be the largest portion of BoR mods, frequently larger than the rest of the mod combined. Some good ways to cut file size are to delete unneeded segments of the song, like silence at the start or end of the file or identical loops in video game tunes.
  • Chose some decent songs. If you've got different tastes in music, that's one thing, but just choosing random noise is something else. Make sure the music fits.
How to Convert:
  • You'll need a program called WAV2BOR.exe or CONVERT.exe, and some PCM 16-bit mono .wav files, preferably at 22 Khz. If you're having trouble understanding that last line, don't worry. Just open the .wav in Microsoft Sound Recorder and go to 'Save as...'. From there, find each of those options (PCM format, 16-bit mono at 22050 (22 Khz)) and select them.
  • Once you've got the files, place them all in a folder called W2B in your C: drive. This step wasn't necessary, but if you're having trouble it might fix some problems.
  • Create a new .txt file, and give it a name with the .bat extension. Add the following line for each .wav you want to convert, then double click on your .bat file to start the batch conversion of your .wav files to .bor music files:
wav2bor.exe {wav} {bor} {artist} {title}
  • {wav} is the name of the .wav file to be converted (make sure it has .wav on the end). {bor} is the file that will end up holding the .bor music. {artist} and {title} are optional fields which can be used for an artist name and song title. Or a dog's name and your favorite food. It doesn't really matter. If you do use them, remember that you must use underscores (_) instead of spaces ( ).

Sound Files

data/sounds/beat1.wav
  • Played when an attack hits an entity's bbox.
  • Normally, this sound will be played slower depending on how much damage the attack deals. If this is a problem, you can disable this with the 'noslowfx' command.
data/sounds/fall.wav
  • Played when an entity hits the floor after being knocked down.
data/sounds/get.wav
  • Played when a player picks up an item.
data/sounds/money.wav
  • Played when a player grabs a score item.
data/sounds/jump.wav
  • Played when someone jumps.
data/sounds/indirect.wav
  • Played when one character is flung into another with THROW.
data/sounds/punch.wav
  • Played when a player uses an attack in their attack chain (Pressing attack from a standing position). Normally only heard if the attack misses.
data/sounds/1up.wav
  • Played when the player gets a 1-up.
data/sounds/go.wav
  • Plays three times in a row when the player has beaten all enemies at a wait and can now move forward again.
data/sounds/timeover.wav
  • Played if the timer hits zero. Also played if all credits are lost.
data/sounds/beep.wav
  • Played in menus (not in game) when you move up or down.
data/sounds/beep2.wav
  • Played in menus (not in game) when you select an option.
data/sounds/bike.wav
  • Required if you have bikers. Plays for bikers, of course.
data/sounds/block.wav
  • Optional. Plays when an entity blocks an attack.
Warning: keep an eye on the file size of your .WAVs.

Troubleshooting

NONFATAL:

If your mod isn't crashing, but it's still acting funny, check this list:

After downloading a new version of OpenBoR, my HUD (life bar, time, etc.) appear at the bottom of the screen and my options and controls are messed up!

  • Sometimes, the format of the file SETTINGS.SAV will be changed. When this happens, you'll need to delete the SETTINGS.SAV file you currently have in the same folder as OpenBoR and re-open OpenBoR.

My entities are a discolored box/have the wrong colors!

  • OpenBoR uses a pallete system. Make sure the entities have the correct pallete.

My entities have tried to attack but nothing happens!

  • Are you sure you have given attackboxes in their attack animation?
FATAL:

If your mod is crashing, OpenBoR will store a little error message in "OpenBoRlog.txt" inside the Logs folder. That's for the Windows version, in DOS the log file is "OpenBoRl.txt". The last line is the error message.

Unable to open file '{path}'

  • Check the path, is the path typed correctly? If it is look for the file, is it placed in right folder or not?
  • Something is wrong with the file at {path}. Some possible known causes:
  • One of the file or folder names in the path is too long. BoR can only read from files and folders whose names are from one to eight letters long, not including the extension. For example, "BOB.txt", "12345678.gif", and "data/flip/flop.txt" are okay names. ".txt", "123456789.gif", and "data/nameistoolong/flop.txt" will all make the program spit out an error.
  • Another possible reason is the file is corrupted. Try remaking the file.

Failed to create colourmap from images '{path1}' and '{path2}'.

  • The game tried to make an alternate pallete (remap) of {path1} using the data in {path2}, but couldn't. Some possible known causes:
  • {path1} and/or {path2} do not exist. They may actually exist and just have the wrong name, so check your spelling if the files are there.
  • {path1} and {path2} are not based on the same image. They should be the exact same pictures EXCEPT that certain colors in one file have been replaced with another.

Command '{com}' not understood in file '{path}'

  • The line {com} is somewhere in {path}. However, OpenBoR does not have any code for handling {com}, and doesn't know what to do.
  • Check {com}'s spelling. For instance, it's colourselect, not colorselect.
  • Make sure you have the latest version of OpenBoR. New features won't work in older versions.

Unable to load file (may be out of memory)

  • This is a real sneaky error. It means that one of your .txt files which was just loaded doesn't end with a blank line.
  • To fix this, just go to the last line in the offending .txt file(s) and press enter once.
  • This will only crash OpenBoR when the problem file is actually loaded, not when it is 'known' while loading files at the start.

DOS/32A warning (9003): real mode interrupt vector had been modified: INT 43h

  • Roel (creator of the original BoR) finally found out some more about this. It's a Windows/DOS video mode emulation thing. Don't worry about it. It won't damage anything. We think.

Other Stuff

Outside the Box:
  • OpenBoR adds a lot to an already powerful, simple engine. But you can take things even further with a little thought.
  • Just because they're called SHOCK, FREEZE and BURN doesn't mean they need to be bolts, icicles and flares. They could be other elements, or not even elements at all- ever noticed that most fighting games have separate graphics for low, mid, and high-level attacks? Or ever wanted a character to just sit still for a second or two? Among other things...
  • Related to above, various attackboxes, SHOCK and BURN can be used to make custom slams and custom throws. There are many commands that also helps making them.
  • Text objects pause the game and can play an animation. You can use it for cutscenes which don't end the level. - Use them wisely as they have to be stored in RAM, while cutscenes are streamed in real-time.
  • Enemies can drop other enemies. That means you can create enemies with second forms.
  • An entity's offset, bbox, attack box, platform box, etc. don't need to overlap. Or even be close to one another.
Cutscenes:
  • There is a difference in the format for animated .gif files and not-animated .gif files. In other words, if you have a single-frame animated .gif, it would be read by OpenBoR differently than an identical non-animated .gif.
  • These scenes must have animated .gifs:

--> data/scenes/logo.txt

--> data/scenes/gameover.txt

  • These scenes must have non-animated .gifs:

--> data/scenes/title.txt

--> data/scenes/titleb.txt

Score:
  • When you hit an enemy, you get 5x the attack's damage in points.
  • THROWing an enemy will earn you the attack's damage in points (you don't get any multipliers).
  • You get 5x the attack's power in the player's .txt file, not the damage dealt. So an attack with 1000 power would always give 5000 points.
  • You get a one-up every 50,000 points.
Time:
  • Try to keep in mind how long it might take a player to beat a group of enemies or a boss. It feels kind of disappointing to last 99 seconds against a high-health boss or endless stream of enemies, only to die from time over.
  • To create an item which recovers a player's time, name it Time in it's .txt file and in MODELS.txt and give it a 'health' and 'score' value of 0.
Projectiles:
  • Knives fly straight forward. They can fly over pits unless they are on the ground.
  • Stars can only be thrown during jumps. Three fly out at downward angles.
  • Bombs fly in an arc. They can be thrown over pits.
Player Swapping:
  • 'load'ing a player character in a level's .txt file will cause the player's character to become the loaded character. You can't bring the character select screen back up, though.
  • You can allow players to "unlock" characters in-game by only "know"ing the player in MODELS.txt, but putting an item which "load"s the entity in it's header. If a player grabs the item, they will be able to select the new character whenever they run out of lives or go to the select screen. This isn't saved when you close the game, though.
Other notes:
  • Both OpenBoR.exe and WAV2BOR.exe only work with short file names. If you put them in directories with a file or folder name longer than 8 characters, they won't work.
Fun:
  • Try to keep your mod interesting. The original BoR engine had a lot of neat tricks and fun potential which was never realized, and OpenBoR increases those possibilities exponentially. Think carefully about what you do with them.
  • The little things make a difference. The secret enemy in the original BoR's elevator, the wacky names, the entire hidden stage...
  • There are more fighting styles than just the standard Hadoken fireball/uppercut/spin kick. Try different attacks out. There are some interesting styles and attacks out there. Variety is the spice of life, right?
Limits (as of 2.0691):
  • Maximum number of:

sprite frames: NA**

animations: 1000

models: 200

entities: 150

panels per level: 52*

frames per animation: NA**

weapons per player: 10

remaps: 14

name length: 40

level spawns: 600

panel order length: 2000

hole spawns per level: 40

levels: 100

difficulty levels: 10

sound effects: 128

freespecials: 8

  • Although the source code has been changed to allow up to 52 panels per stage, a way of using panels past 26 has not yet been decided upon. There are only 26 letters in the alphabet, after all. So you can only use 26.
    • NA means this particular caveat is no longer limited by source code. In other words, if you want to create an animation with 500,000 frames, that's your business. Keep in mind however that with great power comes great responsibility; it is up to you to properly manage hardware resources (in particular memory), especially if you intend for your module to play on consoles.

FAQ

What do you mean by "entity?"
  • It's anything you load in Models.txt. It's basically a .txt file which tells the game how to display and use a player, an enemy, a barrel, an apple, etc...
What's a "hud?"
  • HUD: Heads-Up Display. It's what shows you life, your score, your player, etc. It's a display which gives you a heads-up as to what's going on.
Can I enter my initials on the high score screen?
  • Nope, sorry.
Help! My settings are all wrong/My controls have randomly changed/My high scores were replaced by gibberish!
  • The settings file format may have changed. Try deleting or moving your settings.sav file in the same directory as OpenBoR and reopening OpenBoR.
My settings won't save on the Dreamcast version!
  • This is a known issue. It seems the Dreamcast VMU (which is the only way to save on the DC) doesn't get along very well with OpenBoR, and getting them to work together would require too many major changes to be possible.
Where is the DC/PS2/PSP/Windows/X-Box/Linux/GP32/GP2X/NDS version of OpenBoR?
  • Windows, DOS, Dreamcast, PSP, GP2X and X-Box binaries/executables are available in in the recent releases by SumolX. The PS2 and GP32 ports of the original BoR were all done by separate coders, none of whom have expressed interest in porting OpenBoR. Without skilled coders for those platforms, those ports will not be possible. As of this time, I don't think the NDS version by GPF is done yet.
What is this BoR/OpenBoR/DarkBoR/BoRHed/HoR/AotB thing I keep hearing about?
  • BoR is the original Beats of Rage. It is a free game made by Senile Team. It doesn't have most of the features found in OpenBoR, but it is the original.
  • OpenBoR was an upgraded version of BoR which has been worked on by many coders. DarkBoR was an alternate version of BoR which has several unique features such as an MP bar and enhanced weapons support. It was developed by Tails, but it is now merged with OpenBoR to make a single engine.
  • BoRHed is an edit of BoR with new features similar to OpenBoR. It is developed by Lord_Ball and hopefully will be merged soon with OpenBoR.
  • HoR is an edit of BoR designed to create shooting games. It is developed by Lord_Ball.
  • Age of the Beast (AotB) is a "sequel" of sorts to the original BoR. The storyline, characters and music are original work made from scratch, but some basic gameplay elements will be similar to the original BoR. It's being developed by Senile Team, creators of the original BoR.
Which version of BoR should I use?
  • OpenBoR is by far the best choice as of this moment. Each version has its advantage though:
  • The original BoR is the only version with certain ports (such as PS2 or GP32) so it has the greatest compatibility.
  • OpenBoR has many new features and backwards compatibility to the original BoR or DarkBoR. It also is the most optimized version.
  • BoRHed also adds new features, but an entirely different set.
  • HoR was designed for overhead/sideview shooters, so that's something of a different situation.
  • AotB isn't out yet. So, um, it's not really a choice at the moment.

You may be able to create multiple versions compatible with the different versions of BoR, like how game companies release cross-platform games. That's extra work, though.

I'm amazed to see 10 different attackboxes. Why would someone need that many?
  • You should be amazed on the effects you could make with them. With many attackboxes, modders can make an attack that push an opponent backwards, pull him/her, launchers and other cool effects.
When is AotB going to be released?
  • When it's done. Coding games is actually a difficult and annoying not-tons-of-fun task. Especially when you don't get paid. And even more so if people ask for demo versions or release dates. It's being worked on. It'll come when it's ready. Asking will at best do nothing and more often just slow things down.
I found an error in this guide.
  • Then please report it at LavaLit.com.
I found an error in OpenBoR.
  • Report bugs at the OpenBoR Sourceforge site to allow to track them easier.

http://sourceforge.net/projects/openbor/ (Select Tracker->Bugs)

  • Use the system in the following manner:

9 - Highest = System Crash / Fatal bug

5 - Medium = Something is just not working correctly and effects the engine in a strange way.

1 - Lowest = cosmetics, small things.

  • Lastly, Always upload a log file and enter each bug with your username and website (borgeneration/senileteam) and a where/how to be contacted if I don't know you personally.
I want something added to OpenBoR.
  • If you do want to ask for new features, think first. How many people besides you would use the feature? Would it be possible to program? Would it make problems with older versions? Has someone else asked for something similar? If you still want to ask, be sure to do so nicely. The people in the BoR scene are nice, and they are not getting paid for this, so they deserve some little thanks, right?
I want to HELP add something to OpenBoR.
  • Awesome! Head to LavaLit forums and let SamuraiX know. As a warning, even if your addition is really good, it may not be added. Backwards compatibility, speed, memory, and Dreamcast/PSP compatibility are all important factors in what gets added or not.
Can I make my own version of BoR/OpenBoR/DarkBoR?
  • Of course. If you're only making small, mod-specific changes (like changing the design of system menus), go ahead. If you're making larger changes (like new features or options), it would be nice if you mentioned it on the OpenBoR forums, but that's still not enforced or anything.
How do I make my own version of BoR/OpenBoR/DarkBoR?
  • Information on how to compile the code for PC, PSP, Dreamcast, GP2X and other platforms can be found at LavaLit.com.

Links

Credits

Beats of Rage:

Senile Team:

Original Beats of Rage game.

Roel (Opla):

Original BoR source code and engine, major improvements in OpenBoR code, some original BoR graphics.

Neill Corlett:

Dreamcast and PS2 Port.

OpenBoR:

L@Cible:

His BoR-DC-Toolchain made OpenBoR possible.

Kirby2000:

OpenBoR Maintainer 2004-2005, 4 player support.

CGRemakes:

OpenBoR Maintainer 2005-2006.

SumolX/SX:

OpenBoR Maintainer 2006-2007, PSP port.

uTunnels:

OpenBoR Coder

Tails:

DarkBoR, 4 player support.

Lord_Ball:

BoRHed, HoR.

Drikobruschi:

Contributed hi-score table code.

Kbandressen:

OpenBoR Coder

Fugue:

Contributed many features, original author of this manual.

Bloodbane:

Manual updater.

OpenBoR Manual contributions:

bWWd, Zamuel, Christuserloeser, Damon Caskey

Sega:

Original Streets of Rage design, concept, etc.

SNK:

Original BoR graphics.

Sega, Capcom, SNK, Konami, Tecmo, Treasure, Sammy, etc.:

For all the brawler games!

The entire BoR and OpenBoR community:

Keep making those games!

Retrieved from "http://editthis.info/beats_of_rage/OpenBOR_Manual"
Personal tools