Difference between revisions of "Game Design Document"

From Open Surge Engine Wiki
Jump to: navigation, search
(DNA Door)
(40 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
{{Stub}}
 
{{Stub}}
 +
 +
<font color=red>'''This article needs a revision, as some items have been deprecated or changed over time.'''</font>
  
 
== Introduction ==
 
== Introduction ==
  
 
=== Philosophy ===
 
=== Philosophy ===
Create a free, highly modifiable open-source sidescroller in a style similar to the classic "Sonic" series, with the addition of RPG elements. Open Surge introduces a different style of gameplay called cooperative play, in which it's possible to control a group characters simultaneously. Each character has unique advantages and disadvantages, so some team work is needed in order to get through the levels.
+
Create a free, moddable, quality retro-style 2D sidescroller inspired by old-school games.
  
Our goal is that this game becomes fun, popular and widespread. It works on both old/slow and recent/fast computer hardware, and it also runs on diverse operating systems (mainly Windows, GNU/Linux and MacOS X). The download is small, so people with slow connections are able to get the game as well. Furthermore, this game has translations to multiple languages.
+
Our goal is that this game becomes fun, popular and widespread. It should work on both old/slow and recent/fast computer hardware, and it should also work on diverse operating systems (like Windows and GNU/Linux). The download should be small, so that people with slow connections can play the game as well. It includes [[Art_Specification_Document|retro graphics]].
  
This game is focused on kids, teens and adults. As the basic requirements make it easily accessible by almost everyone, we expect that this game becomes available (worldwide) everywhere: personal computers, schools, software repositories of Linux distributions, fan communities, etc.
+
Open Surge is focused on kids, teens and young adults. As the basic requirements make it easily accessible by almost everyone, we expect that this game becomes available (worldwide) everywhere: personal computers, schools, software repositories of Linux distributions, fan communities, homebrew systems, etc.
  
It's also of our best interest that users keep playing this game after they have cleared the regular levels. In order to achieve that goal, we provide a level creation mechanism: players are able to create their own levels using the level editor. Players can also modify the engine in order to make different styles of games.
+
It's also of our best interest that users keep playing Open Surge after they have cleared the regular levels. In order to achieve that goal, we provide a level creation mechanism: players are able to create their own levels using the level editor. As Open Surge features a flexible engine, players can also modify it in order to make their own games.
  
 
=== Overview ===
 
=== Overview ===
This simplified design document covers the 1P Game mode and it reflects our vision of what the game will look like on version 1.0. Some details may change whenever necessary, but the basic idea of the game is already defined. Please note that this document does '''not''' cover multiplayer modes, engine details, etc.
+
This simplified design document covers the 1P Game mode and it reflects our vision of what the game will look like on version 1.0.
 
+
The 1P Game Mode will feature cooperative play (team play).
+
 
+
There are many good ideas around (like the multiplayer game), but if we lose focus, we may not be able to complete the development stage of this game. Many games get canceled due to the lack of proper planning and focus.
+
 
+
For the time being, let's focus to complete what is planned here and set aside other stuff (like the multiplayer game). While this may not please everyone, we want to deliver a complete and polished game. We have this vision and we're working hard in order to achieve these goals. Only this plan by itself describes a medium sized game which may take a few years to be completed, so we think this task is already hard enough.
+
  
 
=== Plot ===
 
=== Plot ===
Line 50: Line 46:
 
! Key !! Effect
 
! Key !! Effect
 
|-
 
|-
| Arrow keys    || Move the active character
+
| Arrow keys    || Move
 
|-
 
|-
 
| Space bar    || Jump
 
| Space bar    || Jump
 
|-
 
|-
| ENTER        || Pause the game
+
| ENTER        || Pause
 
|-
 
|-
| Left CTRL key || Change the active team member
+
| Left CTRL key || Switch character
 
|-
 
|-
| ESC          || Quit the game
+
| ESC          || Quit
 
|-
 
|-
 
| Print Screen or =  || Take snapshot
 
| Print Screen or =  || Take snapshot
 
|-
 
|-
| F6            || Enable/disable joypad
+
| F12          || Open editor
|-
+
| F12          || Level editor
+
 
|}
 
|}
  
== Characters ==
+
== Main Characters ==
  
 
=== "Surge" the Rabbit ===
 
=== "Surge" the Rabbit ===
This character can get through DNA doors, as well as use additional moves when covered by a special shield.
+
This character has control over lightning that can affect certain objects in different ways.
  
 
See also: [["Surge" the Rabbit]]
 
See also: [["Surge" the Rabbit]]
  
 
=== "Neon" the Squirrel ===
 
=== "Neon" the Squirrel ===
This character can fly and pick up the other characters to carry around.
+
This character can fly using a jetpack.
  
 
See also: [["Neon" the Squirrel]]
 
See also: [["Neon" the Squirrel]]
  
 
=== "Charge" the Badger ===
 
=== "Charge" the Badger ===
This character can glide and climb walls.
+
This character can climb up walls and hang on to ceilings.
  
 
See also: [["Charge" the Badger]]
 
See also: [["Charge" the Badger]]
  
 
=== Gimacian the Dark ===
 
=== Gimacian the Dark ===
An evil wizard who needs darkness to increase his powers. He wants to transform the world into pure darkness in order to become the absolute ruler. His origins are unknown, but it's believed he somehow came from another dimension.
+
An evil wizard who wants to transform the world into pure darkness in order to become the absolute ruler.
  
 
See also: [[Gimacian the Dark]]
 
See also: [[Gimacian the Dark]]
Line 94: Line 88:
 
See also: [[Sharp]]
 
See also: [[Sharp]]
  
=== Dark Surge ===
+
== Main items ==
Surge's negative form. He appears in Sky Brawl. Has the same ability as Surge.
+
 
+
See also: [[Dark Surge]]
+
 
+
=== Anti-Neon ===
+
Neon's negative form. He appears in Sky Brawl. Has the same ability as Neon.
+
 
+
See also: [[Anti-Neon]]
+
 
+
=== Nega-Charge ===
+
Charge's negative form. He appears in Sky Brawl. Has the same ability as Charge.
+
 
+
See also: [[Nega-Charge]]
+
 
+
== Items ==
+
  
 
Throughout the game, you'll find special items which will be helpful in your quest against evil. Most of the items are contained
 
Throughout the game, you'll find special items which will be helpful in your quest against evil. Most of the items are contained
 
in item boxes. To pick an item from an item box break open the box a spin attack or by jumping on it. Other items you just collect by touching them.
 
in item boxes. To pick an item from an item box break open the box a spin attack or by jumping on it. Other items you just collect by touching them.
  
=== Rings ===
+
These are the main items, that can be found through the game. There are, however, other [[Game_Design_Document#Levels|level-specific]] items which are not listed in here.
[[Image:Rings.png‎|thumb|none|Rings]]
+
 
+
==== Ring ====
+
Rings keep you from getting hurt if you are attacked. When the player gets hit, he/she loses all his/her rings. If you have no rings when attacked you will lose a life. On the other hand, if you manage to collect and amount of 100 rings you'll win an extra life!
+
 
+
==== Big ring ====
+
Touch it to go to the bonus level. If the player has cleared all the bonus levels, the big ring gives you 50 extra rings.
+
 
+
==== Blue ring ====
+
Blue rings are worth 5 rings. They are invisible to the player, unless he/she wears the magic glasses.
+
  
=== Magic glasses ===
+
==== Battery ====
Enables the player to see the blue rings. If the player clears the level wearing the glasses, extra points will be given. If the player gets hit, he/she loses the glasses.
+
Batteries represent power. They are collectible items that keep you from getting hurt if you are attacked. When you get hit, you lose your power. If you have no power when attacked, you will lose a life. On the other hand, if you manage to collect 100 batteries, you'll win an extra life!
  
'''TODO: insert original user-made art of this item'''
+
[[File:Battery-sprites5x.png|304px|thumb|none|Batteries]]
  
 
=== Item boxes ===
 
=== Item boxes ===
Line 137: Line 106:
 
Increases Life Count by 1 point. The box differs depending on your current character.
 
Increases Life Count by 1 point. The box differs depending on your current character.
  
==== Ring box ====
+
==== Battery box ====
Smash the box to get 10 extra rings.
+
Smash the box to get 10 extra batteries.
  
 
==== Invincibility stars box ====
 
==== Invincibility stars box ====
 
Smash the box to become invincible to attacks and traps for a few seconds. However, if you fall to a bottomless pit, remain underwater for too long, or be crushed between two moving bricks, you'll lose a life!
 
Smash the box to become invincible to attacks and traps for a few seconds. However, if you fall to a bottomless pit, remain underwater for too long, or be crushed between two moving bricks, you'll lose a life!
  
==== Speed shoes box ====
+
==== Turbo box ====
 
Increases your speed for a few seconds.
 
Increases your speed for a few seconds.
 
==== Glasses box ====
 
Usually these boxes are well hidden in the levels or in difficult paths. They give you the Magic Glasses.
 
  
 
==== Shield box ====
 
==== Shield box ====
Smash the box to get a protection shield. The shield will protect you for only one hit.
+
Smash the box to get a protection shield. The shield will defend you against one extra hit.
  
 
==== Fire shield box ====
 
==== Fire shield box ====
Line 156: Line 122:
  
 
==== Trap box ====
 
==== Trap box ====
If you smash this box you'll be hurt and lose your rings. If the player has no rings, he/she dies.
+
If you smash this box you'll be hurt and lose your batteries. If the player has no batteries, he/she dies.
  
 
=== Little animals ===
 
=== Little animals ===
 
Little animals appear when an enemy gets killed. A group of them also appear when you break the Animal Machine at the end of a level.
 
Little animals appear when an enemy gets killed. A group of them also appear when you break the Animal Machine at the end of a level.
  
''Suggestion: use open source mascots such as [http://en.wikipedia.org/wiki/Tux#Video_games Tux] and [http://en.wikipedia.org/wiki/Wilber_(mascot_of_GIMP)#Wilber Wilber] as the little animals.''
+
''Note:'' use open source mascots such as [http://en.wikipedia.org/wiki/Tux#Video_games Tux] and [http://en.wikipedia.org/wiki/Wilber_(mascot_of_GIMP)#Wilber Wilber] as the little animals.
 
+
'''TODO: insert original user-made art (little animals)'''
+
  
 
=== Spring pads ===
 
=== Spring pads ===
Spring pads come in three colors and if the player steps on them they will catapult the player at different high speeds in a certain direction: yellow (weak), red (medium) and blue (very strong). They come in eight directions: N, NW, W, SW, S, SE, E, NE.
+
Spring pads come in three colors and, when the player touches them, they will catapult the player at different levels of power (which affect resulting player speed): yellow (weak), red (medium) and blue (very strong). They come in eight directions: Up, Down, Left, Right, Up/Left, Up/Right, Down/Left, and Down/Right
  
 
[[Image:spring_pads.png|thumb|none|Spring Pads]]
 
[[Image:spring_pads.png|thumb|none|Spring Pads]]
Line 181: Line 145:
 
=== Teleporter ===
 
=== Teleporter ===
 
Once activated, teleports the entire team to the same spot.
 
Once activated, teleports the entire team to the same spot.
 
'''TODO: insert original user-made art of this item'''
 
  
 
=== Checkpoint orb ===
 
=== Checkpoint orb ===
Line 189: Line 151:
 
[[Image:Checkpoint_orb.png|thumb|none|Checkpoint orb]]
 
[[Image:Checkpoint_orb.png|thumb|none|Checkpoint orb]]
  
=== Goal ===
+
=== Goal Sign ===
A simple goal sign.
+
Touch it to clear the act. It's placed after Acts 1 and 2.
 
+
'''TODO: insert original user-made art of this item'''
+
 
+
=== End sign (end of the act) ===
+
Touch it to clear the act. It's placed after act 1 and act 2.
+
 
+
'''TODO: insert original user-made art of this item'''
+
 
+
=== Animal machine (end of the zone) ===
+
Break it in order to clear the zone. It appears after the player beats the boss on act 3.
+
  
'''TODO: insert original user-made art of this item'''
+
=== Goal Capsule ===
 +
Break it (attack it three times) in order to clear the zone. It appears after the player beats the boss in Act 3.
  
 
=== Bumper ===
 
=== Bumper ===
If the player touches it, he/she bounces back.
+
The player bounces back as a result of interaction with these objects.
  
 
[[Image:Bumper.png|thumb|none|Bumper]]
 
[[Image:Bumper.png|thumb|none|Bumper]]
  
 
=== Spikes ===
 
=== Spikes ===
If you touch the top of the spikes you'll get hit. If the player has no rings, he/she dies.
+
Can be found laying on the floor or stuck on ceilings and walls. If you touch the spiky surface of the spikes you'll get hit. If the player has no power, he/she dies. Spikes may occasionally hide itself from the player's view and come out at certain intervals.
Spikes can now be placed on the wall or on the ceiling. Moving spikes are now available, too.
+
  
 
[[Image:spikes.png|thumb|none|Spikes]]
 
[[Image:spikes.png|thumb|none|Spikes]]
  
 
=== DNA Door ===
 
=== DNA Door ===
Each player has his own DNA Door. These can be recognized by the color. Orange DNA Doors are for Surge, brown DNA Doors are Neon's, while Charge can only go through the grey DNA Doors.
+
Each player has his own DNA Door, easily recognizable by the door's colors. Orange DNA Doors for Surge, brown for Neon, and grey for Charge. No players can go through these doors except for the designated player the doors are assigned to. These doors are available in both horizontal and vertical positions.
These doors are now available in horizontal and vertical positions.
+
[[Image:Dnadoors.png|thumb|none|DNA Doors]]
[[Image:dnadoors.png|thumb|none|DNA Doors]]
+
  
 
== Levels ==
 
== Levels ==
Line 231: Line 182:
  
 
==== Sunshine Paradise ====
 
==== Sunshine Paradise ====
The first level is very easy to get through. It has a sunny background, water and some magic mountains on the background. It has areas that are wooded, and clearings, so the player can see the background.
+
The first level is very easy to get through. It's bright, cheerful and filled with scenery. It has areas that are wooded, and clearings, so the player can see the background.
  
 
Main article: [[Sunshine Paradise]]
 
Main article: [[Sunshine Paradise]]
  
==== Waterwork Zone ====
+
==== Waterworks Zone ====
  
 
This level takes place on a massive dam. Water is gushing around the player, and there are tanks of water. This introduces underwater gameplay.
 
This level takes place on a massive dam. Water is gushing around the player, and there are tanks of water. This introduces underwater gameplay.
  
Main article: [[Waterwork Zone]]
+
Main article: [[Waterworks Zone]]
 +
 
 +
See also: [[Soda Pop Zone]] (canned level)
  
 
==== Rainbow Realm Zone ====
 
==== Rainbow Realm Zone ====
Line 306: Line 259:
  
 
See also: [[Bonus Stages]]
 
See also: [[Bonus Stages]]
 
=== Tutorial ===
 
The Tutorial Level teaches the user, interactively, how to play the game. It shows the basics of the cooperative play and the individual abilities of the characters.
 
 
See also: [[Tutorial Level]]
 
  
 
== Level Editor ==
 
== Level Editor ==
'''TODO.'''
+
 
 +
Go to: [[How to make a level]]
  
 
== Game MODs ("moddable" capabilities) ==
 
== Game MODs ("moddable" capabilities) ==
'''TODO.'''
+
 
 +
Go to: [[Introduction to Modding]]
  
 
[[Category:Development]]
 
[[Category:Development]]
 +
 +
 +
= Gameplay Elements =
 +
 +
Go to: [[Gameplay Elements]]

Revision as of 14:33, 24 August 2019

Stub
This article is a stub. This typically means the article is a placeholder for more content to come. Knowledgeable users are encouraged to help expand the article.

This article needs a revision, as some items have been deprecated or changed over time.

Introduction

Philosophy

Create a free, moddable, quality retro-style 2D sidescroller inspired by old-school games.

Our goal is that this game becomes fun, popular and widespread. It should work on both old/slow and recent/fast computer hardware, and it should also work on diverse operating systems (like Windows and GNU/Linux). The download should be small, so that people with slow connections can play the game as well. It includes retro graphics.

Open Surge is focused on kids, teens and young adults. As the basic requirements make it easily accessible by almost everyone, we expect that this game becomes available (worldwide) everywhere: personal computers, schools, software repositories of Linux distributions, fan communities, homebrew systems, etc.

It's also of our best interest that users keep playing Open Surge after they have cleared the regular levels. In order to achieve that goal, we provide a level creation mechanism: players are able to create their own levels using the level editor. As Open Surge features a flexible engine, players can also modify it in order to make their own games.

Overview

This simplified design document covers the 1P Game mode and it reflects our vision of what the game will look like on version 1.0.

Plot

Long time ago the ancient gods have created a sacred and powerful item, the Dimensional Scepter. This scepter grants ultimate power to anyone who possesses it, and since it can be very dangerous in the wrong hands, the gods have hidden it in the Dimensional Gate.

Gimacian the Dark is an evil wizard who needs darkness to increase his powers. He knows where the Dimensional Gate is located and he will try to open it using the Dimensional Rings. If he gets that power, he will rule the universe, and nothing will be able to stop him. Surge and his friends must prevent Gimacian the Dark from opening the gate, or existence as we know it will be over!

See also: Game Story

List of game modes

1P Game Mode

This is the regular 1-player mode, where the user has to get through a sequence of levels in order to clear the game. The game will save the progress of the player automatically.

See also: List of planned levels

Tutorial game mode

The tutorial teaches the player how to play (interactively). It shows the basics of the cooperative play and the individual abilities of the characters. There's no save-progress feature.

See also: Tutorial Level

Custom quests

A quest is a series of levels. Regular users are able to create levels as well. The game will save the progress of the player automatically.

See also: Custom quests

Controls

The game may be played using the keyboard or a joystick. Default keyboard mapping:

Key Effect
Arrow keys Move
Space bar Jump
ENTER Pause
Left CTRL key Switch character
ESC Quit
Print Screen or = Take snapshot
F12 Open editor

Main Characters

"Surge" the Rabbit

This character has control over lightning that can affect certain objects in different ways.

See also: "Surge" the Rabbit

"Neon" the Squirrel

This character can fly using a jetpack.

See also: "Neon" the Squirrel

"Charge" the Badger

This character can climb up walls and hang on to ceilings.

See also: "Charge" the Badger

Gimacian the Dark

An evil wizard who wants to transform the world into pure darkness in order to become the absolute ruler.

See also: Gimacian the Dark

Sharp

This guardian of the Dimensional Gate resembles a porcupine, and is willing to do whatever it takes to guard the Dimensional Scepter!

See also: Sharp

Main items

Throughout the game, you'll find special items which will be helpful in your quest against evil. Most of the items are contained in item boxes. To pick an item from an item box break open the box a spin attack or by jumping on it. Other items you just collect by touching them.

These are the main items, that can be found through the game. There are, however, other level-specific items which are not listed in here.

Battery

Batteries represent power. They are collectible items that keep you from getting hurt if you are attacked. When you get hit, you lose your power. If you have no power when attacked, you will lose a life. On the other hand, if you manage to collect 100 batteries, you'll win an extra life!

Batteries

Item boxes

Item Boxes

Life box

Increases Life Count by 1 point. The box differs depending on your current character.

Battery box

Smash the box to get 10 extra batteries.

Invincibility stars box

Smash the box to become invincible to attacks and traps for a few seconds. However, if you fall to a bottomless pit, remain underwater for too long, or be crushed between two moving bricks, you'll lose a life!

Turbo box

Increases your speed for a few seconds.

Shield box

Smash the box to get a protection shield. The shield will defend you against one extra hit.

Fire shield box

Smash the box to get a fire shield. This shield protects you against fire objects and regular hits.

Trap box

If you smash this box you'll be hurt and lose your batteries. If the player has no batteries, he/she dies.

Little animals

Little animals appear when an enemy gets killed. A group of them also appear when you break the Animal Machine at the end of a level.

Note: use open source mascots such as Tux and Wilber as the little animals.

Spring pads

Spring pads come in three colors and, when the player touches them, they will catapult the player at different levels of power (which affect resulting player speed): yellow (weak), red (medium) and blue (very strong). They come in eight directions: Up, Down, Left, Right, Up/Left, Up/Right, Down/Left, and Down/Right

Spring Pads

Switch

Activates a teleporter or opens a door. Its behavior depend on which object is closest.

Door

Players can't get through doors, unless somebody is stepping on the closest switch. Some doors only open if the appropiate color related switch is pressed.

Switches and Doors

Teleporter

Once activated, teleports the entire team to the same spot.

Checkpoint orb

Once touched, the spawn point of the characters will be changed to the position of the checkpoint orb. If you die, the team will restart the level at the checkpoint orb rather than at the beginning of the stage.

Checkpoint orb

Goal Sign

Touch it to clear the act. It's placed after Acts 1 and 2.

Goal Capsule

Break it (attack it three times) in order to clear the zone. It appears after the player beats the boss in Act 3.

Bumper

The player bounces back as a result of interaction with these objects.

Bumper

Spikes

Can be found laying on the floor or stuck on ceilings and walls. If you touch the spiky surface of the spikes you'll get hit. If the player has no power, he/she dies. Spikes may occasionally hide itself from the player's view and come out at certain intervals.

Spikes

DNA Door

Each player has his own DNA Door, easily recognizable by the door's colors. Orange DNA Doors for Surge, brown for Neon, and grey for Charge. No players can go through these doors except for the designated player the doors are assigned to. These doors are available in both horizontal and vertical positions.

DNA Doors

Levels

1P Game Mode Levels

The levels are designed in order to explore both cooperative play and the individual abilities of the characters. Unlike most similar platformers, this game provides a greater level of interaction between the player and the levels. It's more than just a jump'n'run, as the user must come up with some strategy in order to get through the levels.

This is the list of planned levels. Please note that not all of them have been designed yet.

The levels below are as they appear in the game's current storyline. These are subject to change.

Main article: Game Story

Sunshine Paradise

The first level is very easy to get through. It's bright, cheerful and filled with scenery. It has areas that are wooded, and clearings, so the player can see the background.

Main article: Sunshine Paradise

Waterworks Zone

This level takes place on a massive dam. Water is gushing around the player, and there are tanks of water. This introduces underwater gameplay.

Main article: Waterworks Zone

See also: Soda Pop Zone (canned level)

Rainbow Realm Zone

Combines elements from Speed Slider (from Knuckles Chaotix) and Rainbow Road (from Mario Kart 64), adding some original ideas as well. This level is more about racing/running than it is about strategy.

Main article: Rainbow Realm Zone

Black Forest Zone

A forest where many of Gimacian's creatures reside. "Charge" the Badger is being held captive here.

Main article: Black Forest Zone

City Chill Zone

A city covered in ice, due to Gimacian.

Main article: City Chill Zone

Music Stadium

A level located in the middle of City Chill zone, that seems to stand out from everything else. Music notes are everywhere.

Main article: Music Stadium

Dragon Egg Zone

Sand area. This is the habitat of dangerous dragons under the control of Gimacian, which are holding Neon captive.

Main article: Dragon Egg Zone

Crystal Temple

A sacred and hidden temple, in a cave setting. Water appears here, and this serves as the 'hard' water level.

Main article: Crystal Temple

Spring Forge Zone

This is the place where springs are made. In reality, it is secretly building Gimacian's ultimate weapon underground.

Main article: Spring Forge Zone

Magma Mine Zone

A rename for Melted Metal zone. A level filled with dangerous creatures digging out the supplies for Gimacian's Sky Fortress. The Sky Fortress can be seen in the background.

Main article: Magma Mine Zone

Sky Fortress

Gimacian's ultimate weapon to take over the world. Unlike other zones, this one only has two Acts.

Main article: Sky Fortress

Sky Brawl

The third Act of Sky Fortress broken into three parts, as Surge, Neon, and Charge fight to the finish on the deck of Sky Fortress.

Main article: Sky Brawl

Dimensional Gate

This level will be available only if the player gets the 8 Dimensional Rings.

Main article: Dimensional Gate

Demonic Duel

This level will be available only if the player gets the 8 Dimensional Rings. This is the game's true final boss. It will involve all three characters getting their own part in the battle.

Main article: Demonic Duel

Bonus Stages

Pseudo 3D levels. If the player beats a bonus level, he’ll receive one Dimensional Ring. There are 8 Dimensional Rings of varying colors.

See also: Bonus Stages

Level Editor

Go to: How to make a level

Game MODs ("moddable" capabilities)

Go to: Introduction to Modding


Gameplay Elements

Go to: Gameplay Elements