Difference between revisions of "User:Hipshot"

From Serious Sam's Bogus Detour
Jump to: navigation, search
 
Line 1: Line 1:
This article describes the most basic parts of the editor, from first setup to launching a smaller  
+
This article describes the most basic parts of the editor, from first setup to launching a smaller test level ingame.
 
 
test level ingame.
 
  
 
=Preparation=
 
=Preparation=
Before you start using the editor, you need to setup a working directory for your level, campaign or  
+
Before you start using the editor, you need to setup a working directory for your level, campaign, or mod. You will also need an <code>[[info.xml]]</code> file.
  
mod and a scenario [[info.xml]] file.<br><br>
+
Navigate to your SSBD directory, then go into the folder <code>scenarios</code>. Inside here, create a new folder called <code>mycampaign</code> or whatever you feel like calling it. Inside <code>mycampaign</code> create yet another folder called <code>levels</code>.
Navigate to your SSBD directory, then go into the folder '''scenarios''', inside here, create a new  
 
  
folder called '''mycampaign''' or whatever you feel like calling it. Inside '''mycampaign''' create
+
Now you need to set up an <code>[[info.xml]]</code> file. This file contains important information about the scenario. Open your favorite text editor (like Notepad), and paste the following text inside:
 
 
yet another folder called '''levels'''.
 
 
 
Now you need to set up an [[info.xml]] file, this file contains important information about the  
 
 
 
scenario.<br>
 
Create a text document inside the '''mycampaign''' folder, name this '''info.txt''', then open it and  
 
 
 
paste the following text inside
 
  
 
<pre class="prettyprint">
 
<pre class="prettyprint">
Line 24: Line 12:
 
<name>My cool campaign</name>
 
<name>My cool campaign</name>
 
<tag>This is the best campaign</tag>
 
<tag>This is the best campaign</tag>
<description>The end is near, or perhaps not! In any case, this is a really fun level!
+
<description>The end is near, or perhaps not! In any case, this is a really fun level!</description>
  
</description>
 
 
 
<players min="1" max="4" />
 
<players min="1" max="4" />
+
 
 
<start>
 
<start>
 
<level name="The Pride of Memphis" lvl="levels/level1.lvl" />
 
<level name="The Pride of Memphis" lvl="levels/level1.lvl" />
Line 36: Line 22:
 
</pre>
 
</pre>
  
Save the file and rename it to '''info.xml'''.
+
Save the file inside of the <code>mycampaign</code> folder as <code>info.xml</code>. (Make sure it's .xml, and not .txt!)
 +
 
 
==Starting the editor==
 
==Starting the editor==
The editor can be found inside the SSBD install directory, called '''EDITOR.exe''', or as a lunch
+
The editor can be found inside the SSBD install directory, called <code>EDITOR.exe</code>, or as a launch option in Steam when you click the ''Play'' button.
 
 
option in Steam when you click the ''Play'' button.
 
  
 
==Workspace==
 
==Workspace==
The editor workspace consists of several parts: ''History'', ''Layers'', ''Properties'', ''Toolbar'',  
+
The editor workspace consists of several parts: ''History'', ''Layers'', ''Properties'', ''Toolbar'', ''Menus'', and the ''Status Bar'', the picture below outlines these parts.
  
''Menus'' and the ''Status Bar'', the picture below outlines these parts.
 
 
[[File:Editor_guide_launch.png|thumb|left|175px|Workspace]]
 
[[File:Editor_guide_launch.png|thumb|left|175px|Workspace]]
# '''Menu:''' In the menus you can find most basic functions, like testing the level from the editor
 
 
and showing and changing the grid.
 
# '''Tool Bar:''' Quick shotcuts to such functions like turn on the grid and simulate physics
 
 
(recommend to turn simulate physics off).
 
# '''History:''' Saves your current work progrss so you can undo in steps, sometimes this function
 
  
undo twice, so be careful, better not use at all.
+
# '''Menu:''' In the menus you can find most basic functions, like testing the level from the editor and showing and changing the grid.
# '''Layers:''' Where you choose your work layer, if you don't have ''Global Selection'' on, you can  
+
# '''Tool Bar:''' Quick shortcuts to functions like turn on the grid and simulate physics (it's recommended to turn simulate physics off).
 
+
# '''History:''' Saves your current work progrss so you can undo in steps, sometimes this function undoes twice, so be careful, it's better to not use it at all.
only work in one layer at once.
+
# '''Layers:''' Where you choose your work layer. If you have ''Global Selection'' on, you can work in multiple layers at the same time.
# '''Properties:''' Used to change properties of a selected unit or script, like what unit to spawn  
+
# '''Properties:''' Used to change properties of a selected unit or script, like what unit to spawn with a [[SpawnUnit WorldScript]].
 
+
# '''Status Bar:''' Shows the number of units selected, zoom grade, on what co-ordinates the mouse cursor is at, and the current level testing options.
with a [[SpawnUnit_WorldScript]].
 
# '''Status Bar:''' Shows the number of units selected, zoom grade and on what co-ordinates the mouse  
 
 
 
cursor is at.
 
  
 
==Game mode==
 
==Game mode==
 
[[File:Basics_gamemode.png|thumb|100px|GameMode settings]]
 
[[File:Basics_gamemode.png|thumb|100px|GameMode settings]]
Before you start constructing a level, you need to decide what game mode it should have. You should  
+
Before you start constructing a level, you need to decide what game mode it should have. You should always do this, since it contains important settings and information about the level.
  
always do this, since it contains important settings and information about the level.
+
For this tutorial, we will choose '''Campaign''' under the tab '''GameMode''' in the '''Layers''' panel. The only thing we will change here is the '''MapName''' and the '''CreatorName'''.
For this tutorial, we would choose '''Campaign''' under the tab '''GameMode''' in the '''Layers'''  
 
 
 
panel. The only thing we will change here is the '''MapName''' and the '''CreatorName'''.
 
  
 
=Constructing=
 
=Constructing=
Now we will start and produce a small playable level. We will place some tilesets, then on to  
+
Now we will start and produce a small playable level. We will place some tilesets, and then move on to building parts and finally some basic scripts to end and start the gameplay with.
 
 
building parts and finally some basic scripts to end and start the gameplay with.
 
  
 
==Environment and tilesets==
 
==Environment and tilesets==
 
[[File:Editor basics tiles.png|thumb|100px|Painting a tileset]]
 
[[File:Editor basics tiles.png|thumb|100px|Painting a tileset]]
The absolute first thing you want to do is set a default environmental light of the level, so you can  
+
The absolute first thing you want to do is set a default environmental light of the level, so you can actually see what you are doing (else everything will be black).
 
 
actually see what you are doing (else everything will be black). Switch to the '''Lighting''' tab and
 
 
 
look down a bit until you see '''Env:''', open that list and look close to the bottom, find the
 
 
 
environment called '''egypt_outside.env'''.
 
 
 
Now enter the '''Tilemap''' tab and scroll down the list until you find a tileset called
 
  
'''egypt_tile_inside_16.tileset''', start painting these ''(Add: Left Mouse Button. Remove: Right
+
Switch to the '''Lighting''' tab and look down a bit until you see '''Env:''', open that list and look close to the bottom, find the environment called '''egypt_outside.env'''.
  
Mouse Button)'' tiles until you have a good and sturdy ground. There are a few settings in the  
+
Now enter the '''Tilemap''' tab and scroll down the list until you find a tileset called <code>egypt_tile_inside_16.tileset</code>. Start painting these ''(Add: Left Mouse Button. Remove: Right Mouse Button)'' tiles until you have a good and sturdy ground. There are a few settings in the '''Properties''' panel that you can change, like increase or decrease the size of the paintbrush, this can also be done with the shortcut '''CTRL+MWHEEL'''.
 
 
'''Properties''' panel that you can change, like increase or decrease the size of the paintbrush,  
 
 
 
this can also be made with the shortcut '''CTRL+MWHEEL'''.
 
  
 
==Walls==
 
==Walls==
 
[[File:Editor basics walls1.png|thumb|100px|Almost a room]]
 
[[File:Editor basics walls1.png|thumb|100px|Almost a room]]
 
[[File:Editor basics walls2.png|thumb|100px|Two rooms!]]
 
[[File:Editor basics walls2.png|thumb|100px|Two rooms!]]
Before you start placing walls make sure you set the '''grid''' to '''16''' (either from the menu or  
+
Before you start placing walls make sure you set the '''grid''' to '''16''' (either from the menu or by pressing '''"5"''' on the numpad), standard walls are 16 units thick and this will make sure they always follow that grid.
 
 
by pressing '''"5"''' on the keyboard), standard walls are 16 units thick and this will make sure  
 
 
 
they always follow that grid.
 
Now, open the '''Doodads tab''' and in the '''search field,''' type '''egypt_fancy.''' This will list
 
 
 
all units associated with this theme. We are going to use a few different building blocks here, the
 
 
 
following is a list of the units we will be using right now:
 
 
 
*fancy_h.unit
 
*fancy_v.unit
 
*fancy_crn_ne.unit
 
*fancy_crn_nw.unit
 
*fancy_crn_se.unit
 
*fancy_crn_sw.unit
 
 
 
Start by selecting '''fancy_h.unit''' and place it down using the '''right mouse button''', place a
 
  
couple of these to form a long wall. Then move on to the other units and shape a room with a gap.
+
Now, open the '''Doodads tab''' and in the '''search field,''' type '''egypt_fancy.''' This will list all units associated with this theme. We are going to use a few different building blocks here, the following is a list of the units we will be using right now:
  
Just like the image to the right.
+
* <code>fancy_h.unit</code>
 +
* <code>fancy_v.unit</code>
 +
* <code>fancy_crn_ne.unit</code>
 +
* <code>fancy_crn_nw.unit</code>
 +
* <code>fancy_crn_se.unit</code>
 +
* <code>fancy_crn_sw.unit</code>
  
When that is done, continue and expand the level so you get two rooms, place a door in between them.  
+
Start by selecting <code>fancy_h.unit</code> and place it down using the '''right mouse button'''. Place a couple of these to form a long wall. Then move on to the other units and shape a room with a gap, just like the image to the right.
  
Also, trim the tileset so it won't show outside the walls. Now, let's add some decoration and lamps!
+
When that is done, continue and expand the level so you get two rooms and place a door in between them. Also, trim the tileset so it won't show outside the walls. Now, let's add some decoration and lamps!
  
 
==Artpass and lighting==
 
==Artpass and lighting==
The blue area around the walls are called the void, this is outside the level. You can walk there,  
+
The blue area around the walls are called the void, this is outside the level. You can walk there, but enemies and other things might start to act strange and it doesn't look too good either. Think of this as an area you should never see.
 
 
but enemies and other things might start to act strange and it doesn't look too good either. Think of  
 
 
 
this as an area you should never see.
 
 
 
The two basic ways to handle this is either to paint over tilesets there, like grass or something
 
 
 
else, or as you can see when you play [[e1m1|the first level]] of the game you notice that there's
 
 
 
roofing on top of the walls making it feel like you are actually inside a temple, this also covers
 
 
 
the void. This is the method we will be using here and to achieve this, search the '''Doodads''' tab
 
 
 
for '''color''' and you will find units called '''color_egypt_fancy_*.unit''', where '''*''' are
 
 
 
different sizes. Pick the one called '''_512.unit''' and place them around, so they cover all the
 
 
 
void around the walls.
 
  
When that's done, let's place some decorative props around the two rooms, this is a list of units
+
The two basic ways to handle this is either to paint over tilesets there, like grass or something else, or as you can see when you play [[e1m1|the first level]] of the game you notice that there's roofing on top of the walls making it feel like you are actually inside a temple, which also covers the void. This is the method we will be using here. To achieve this, search the '''Doodads''' tab for '''color''' and you will find units called '''color_egypt_fancy_*.unit''', where '''*''' are different sizes. Pick the one called '''_512.unit''' and place them around, so they cover all the void around the walls.
  
that I will be placing around (they are all found inside the Doodads tab):
+
When that's done, let's place some decorative props around the two rooms, this is a list of units that I will be placing around (they are all found inside the Doodads tab):
  
* lamp_torch
+
* <code>lamp_torch</code>
* china_* (different vases and things)
+
* <code>china_*</code> (different vases and things)
* fancy_deco_pillar
+
* <code>fancy_deco_pillar</code>
* fancy_deco_pillar_blank
+
* <code>fancy_deco_pillar_blank</code>
* fancy_deco_pillar_large
+
* <code>fancy_deco_pillar_large</code>

Latest revision as of 15:22, 21 August 2017

This article describes the most basic parts of the editor, from first setup to launching a smaller test level ingame.

Preparation

Before you start using the editor, you need to setup a working directory for your level, campaign, or mod. You will also need an info.xml file.

Navigate to your SSBD directory, then go into the folder scenarios. Inside here, create a new folder called mycampaign or whatever you feel like calling it. Inside mycampaign create yet another folder called levels.

Now you need to set up an info.xml file. This file contains important information about the scenario. Open your favorite text editor (like Notepad), and paste the following text inside:

<info>
	<name>My cool campaign</name>
	<tag>This is the best campaign</tag>
	<description>The end is near, or perhaps not! In any case, this is a really fun level!</description>

	<players min="1" max="4" />

	<start>
		<level name="The Pride of Memphis" lvl="levels/level1.lvl" />
	</start>
</info>

Save the file inside of the mycampaign folder as info.xml. (Make sure it's .xml, and not .txt!)

Starting the editor

The editor can be found inside the SSBD install directory, called EDITOR.exe, or as a launch option in Steam when you click the Play button.

Workspace

The editor workspace consists of several parts: History, Layers, Properties, Toolbar, Menus, and the Status Bar, the picture below outlines these parts.

Workspace
  1. Menu: In the menus you can find most basic functions, like testing the level from the editor and showing and changing the grid.
  2. Tool Bar: Quick shortcuts to functions like turn on the grid and simulate physics (it's recommended to turn simulate physics off).
  3. History: Saves your current work progrss so you can undo in steps, sometimes this function undoes twice, so be careful, it's better to not use it at all.
  4. Layers: Where you choose your work layer. If you have Global Selection on, you can work in multiple layers at the same time.
  5. Properties: Used to change properties of a selected unit or script, like what unit to spawn with a SpawnUnit WorldScript.
  6. Status Bar: Shows the number of units selected, zoom grade, on what co-ordinates the mouse cursor is at, and the current level testing options.

Game mode

GameMode settings

Before you start constructing a level, you need to decide what game mode it should have. You should always do this, since it contains important settings and information about the level.

For this tutorial, we will choose Campaign under the tab GameMode in the Layers panel. The only thing we will change here is the MapName and the CreatorName.

Constructing

Now we will start and produce a small playable level. We will place some tilesets, and then move on to building parts and finally some basic scripts to end and start the gameplay with.

Environment and tilesets

Painting a tileset

The absolute first thing you want to do is set a default environmental light of the level, so you can actually see what you are doing (else everything will be black).

Switch to the Lighting tab and look down a bit until you see Env:, open that list and look close to the bottom, find the environment called egypt_outside.env.

Now enter the Tilemap tab and scroll down the list until you find a tileset called egypt_tile_inside_16.tileset. Start painting these (Add: Left Mouse Button. Remove: Right Mouse Button) tiles until you have a good and sturdy ground. There are a few settings in the Properties panel that you can change, like increase or decrease the size of the paintbrush, this can also be done with the shortcut CTRL+MWHEEL.

Walls

Almost a room
Two rooms!

Before you start placing walls make sure you set the grid to 16 (either from the menu or by pressing "5" on the numpad), standard walls are 16 units thick and this will make sure they always follow that grid.

Now, open the Doodads tab and in the search field, type egypt_fancy. This will list all units associated with this theme. We are going to use a few different building blocks here, the following is a list of the units we will be using right now:

  • fancy_h.unit
  • fancy_v.unit
  • fancy_crn_ne.unit
  • fancy_crn_nw.unit
  • fancy_crn_se.unit
  • fancy_crn_sw.unit

Start by selecting fancy_h.unit and place it down using the right mouse button. Place a couple of these to form a long wall. Then move on to the other units and shape a room with a gap, just like the image to the right.

When that is done, continue and expand the level so you get two rooms and place a door in between them. Also, trim the tileset so it won't show outside the walls. Now, let's add some decoration and lamps!

Artpass and lighting

The blue area around the walls are called the void, this is outside the level. You can walk there, but enemies and other things might start to act strange and it doesn't look too good either. Think of this as an area you should never see.

The two basic ways to handle this is either to paint over tilesets there, like grass or something else, or as you can see when you play the first level of the game you notice that there's roofing on top of the walls making it feel like you are actually inside a temple, which also covers the void. This is the method we will be using here. To achieve this, search the Doodads tab for color and you will find units called color_egypt_fancy_*.unit, where * are different sizes. Pick the one called _512.unit and place them around, so they cover all the void around the walls.

When that's done, let's place some decorative props around the two rooms, this is a list of units that I will be placing around (they are all found inside the Doodads tab):

  • lamp_torch
  • china_* (different vases and things)
  • fancy_deco_pillar
  • fancy_deco_pillar_blank
  • fancy_deco_pillar_large