Difference between revisions of "FAQ"

From Open Surge Engine Wiki
Jump to: navigation, search
m (What is Open Surge?)
m (Can I create a commercial game with Open Surge?)
(19 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Other languages|title=FAQ}}
 
 
 
== About the game ==
 
== About the game ==
 
[[File:Open_Surge_Logo.svg]]
 
  
 
=== What is Open Surge? ===
 
=== What is Open Surge? ===
  
Open Surge is an open source retro-style 2D sidescroller inspired by old-school games. Join Surge, Neon and Charge and save the world from the evil Gimacian the Dark! The latest release features:
+
Open Surge is a fun 2D retro platformer inspired by old-school Sonic games. It is also a game creation system that makes you a powerful creator! Play, hack, create games and unleash your creativity!
  
* One level: Sunshine Paradise.
+
Open Surge is two projects in one: a game and a game creation system (game engine). It is released as [https://en.wikipedia.org/wiki/Free_and_open-source_software free and open source software]. Also, it is written from the ground up in [http://en.wikipedia.org/wiki/C_language C language], using the [http://liballeg.org/ Allegro game programming library].
* A nice story with charismatic characters!
+
* Physics: slopes, loops, etc.
+
* Translations to multiple languages.
+
* A [[How_to_make_a_level|level editor]] and a [[Introduction_to_Modding|moddable engine]].
+
* Great performance even on old computers!
+
* The complete source code!
+
  
Open Surge is written from the ground up in [http://en.wikipedia.org/wiki/C_language C language], using the [http://alleg.sourceforge.net/ Allegro game programming library]. It's being developed since August 2008, and it is [http://en.wikipedia.org/wiki/Free_software free software].
+
=== Where can I download it? ===
  
Open Surge is available for Windows, Linux and other platforms.
+
Get it at [http://opensurge2d.org/ opensurge2d.org].
  
Check out our [[Game Design Document]].
+
=== Who develops the game? ===
  
=== Where can I download it? ===
+
The game started to be developed by [http://github.com/alemart Alexandre Martins], a computer scientist from Brazil. Over time, people from all over the world began to contribute to the project, including artistics, musicians, translators and more! Check out the [[Contact_the_developers|developers page]] for more information.
  
Check out the [http://opensnc.sourceforge.net/home/download.php download page].
+
=== How can I help? ===
  
Also, please take a look at the [http://opensnc.sourceforge.net/forum/viewtopic.php?id=438 bleeding edge releases].
+
Do you feel inspired by this project? If you have artistic skills, marketing skills, speak multiple languages or have other talents, you can contribute! [[Contact the developers|Contact Alexandre]] via Discord (alemart#7553) or e-mail.
  
=== Who develops the game? ===
+
=== I love Surge! ===
  
The game started to be developed in August 2008 by [http://alemart.users.sourceforge.net Alexandre Martins], a computer science student from Brazil. The development team has been growing up over the time, and now we also have artists, musicians, translators and other people over the Internet working on the project. Check out the [[Contact_the_developers|developers page]] for more information.
+
[[:File:Surge_artwork.png|Marry him]].
  
=== Why doesn't Open Surge support feature [xyz]? ===
+
=== Can I create a game with Open Surge? ===
  
Because no one has taken on that task yet. Open Surge development is driven by the tasks that are important to the individual developers. If there is a feature that is important to you, the best way to get it implemented is to undertake the task yourself or sponsor a developer.
+
Absolutely! Read [[Introduction to Modding]].
  
''Note: taken from the [http://ffmpeg.org/faq.html ffmpeg FAQ] ;-)''
+
=== Can I create a commercial game with Open Surge? ===
  
=== Can I help? ===
+
Yes. First realize that a game created with the Open Surge Engine is composed of 2 parts:
  
You most certainly can.
+
* '''The game engine:''' that's the Open Surge Engine, the software that runs the games
 +
* '''The game assets:''' those include visual arts, audio files and levels
  
See: [[How can I help?]]
+
'''1)''' The game engine is licensed under the GPL, a libre software license. You may use the game engine as-is or modify it keeping in mind the following:
  
=== I love Surge! ===
+
* If you use the game engine as-is, include its source code when distributing your game (it's in the src/ folder - the source code is already shipped by default in Open Surge).
 +
* If you modify the game engine in any possible way and publicly release your game, you must: 1. acknowledge that you have modified it and 2. provide access to your modified version of the source code of the game engine. Your modified version of the source code is automatically licensed under the GPL (you cannot change it to a different license).
 +
* You must provide a copy of the GPL license with the program.
 +
* Regardless of how you use it, the game engine remains free and open source, licensed under the GPL.
  
[[:File:Surge_artwork.png|Marry him]].
+
'''2)''' Your game assets may be licensed the way you want, as long as you own them. The GPL need not apply to your game assets. They may be under a proprietary license, and thus you may sell them.
 +
 
 +
* New game assets created by you can have any license you want.
 +
* Reused or remixed game assets must keep the terms of their original license. Generally, art included in Open Surge is released under the Creative Commons Attribution (CC-BY) and scripts are released under the MIT license, with a few exceptions. You must check the assets themselves and the credits screen to know which licenses apply to which assets.
 +
* A note on scripts: the engine reads scripts in source form, so their source code is already exposed. Since scripts are considered to be software, release them under a GPL-compatible license, such as the [https://opensource.org/licenses/MIT MIT license].
 +
 
 +
'''SUMMARY:''' while the engine must remain free (as in freedom) and open source, game assets (graphics, audio, levels) made by you may be under a proprietary license. This form of distribution is legitimate and ensures customers must buy the content to play the game.
  
=== Other questions ===
+
'''IMPORTANT:''' you '''must not''' exploit Surge commercially (nor the other characters), as this character is not your Intellectual Property (IP). When creating a commercial project, use your own original IP.
  
If you have any other questions, feel free to post it on the [http://opensnc.sourceforge.net/forum/ forums] or send [[Contact_the_developers|the developers]] an e-mail.
+
Answer adapted from the [https://www.solarus-games.org/en/about/faq Solarus' FAQ].
  
 
== Playing the game ==
 
== Playing the game ==
Line 57: Line 57:
 
=== How can I control the characters? ===
 
=== How can I control the characters? ===
  
Using the keyboard, the important keys are: directional arrows (movement), space bar (jump), left ctrl (change character), enter (pause) and esc (quit). You can also use a joystick.
+
Using the keyboard, the important keys are: Arrows (move), Space Bar (jump), Left Ctrl (change character), Enter (pause) and ESC (quit). You can also use a joystick.
  
 
=== How do I play using a joystick? ===
 
=== How do I play using a joystick? ===
  
Plug your joystick before starting the game. Launch the game, go to the options screen and set the "Use gamepad" option to "YES".
+
Simply plug your joystick and have fun! Make sure that "Use gamepad" is set to to "YES" in the options screen.
 
+
Alternatively, you may press F6 to enable/disable joystick input.
+
  
 
=== How can I reconfigure the controls? ===
 
=== How can I reconfigure the controls? ===
  
If you want different buttons for tasks like jumping, pausing the game, etc., you need to reconfigure the controls.
+
If you want different buttons for tasks like jumping, pausing the game, etc., you need to reconfigure the controls. Open ''config/input.def'' using a simple text editor like Notepad or gedit. Follow the instructions there.
 
+
Open ''config/input.def'' using a simple text editor like Notepad or gedit. Follow the instructions.
+
  
 
=== How can I make my own levels? ===
 
=== How can I make my own levels? ===
Line 77: Line 73:
 
=== Are there additional levels? ===
 
=== Are there additional levels? ===
  
Yes, [http://opensnc.sourceforge.net/forum/viewforum.php?id=5 check them out]!
+
Yes, you can find new levels on the forums!
  
=== How do I install new levels? ===
+
=== What is a MOD? ===
  
New levels come in a package (usually a .rar or .zip file). Decompress it to the folder of the game. A new file should appear in the levels/ directory (e.g., levels/super_cool_level.lev). The same procedure goes for installing new quests. If you use Linux, an alternative approach would consist on decompressing the package to the $HOME/.opensurge folder.
+
It's a game made by users with the Open Surge game engine. MODs can be surprisingly different from the original Open Surge game: early modifications ranged from simple sidescrollers to platformers with ninjas and RPG elements. See [[Introduction to Modding]].
  
After you installed your new level, go to the "Stage select" screen (at the options screen).
+
=== How can I play MODs? ===
  
=== What is a quest? ===
+
MODs come in a package (usually a .zip file). Simply decompress it and run the executable (.exe file). If you use Linux, you can use the command line to install a new MOD. For detailed instructions, run:
  
A quest is a list of levels. Go to the "custom quests" screen (at the main menu) to see the installed quests (and play). If you want to make a quest, check out the [[quests|quests page]].
+
opensurge --help
 
+
=== What is a MOD? ===
+
 
+
It's a modification of the game made by users. MODs can be surprisingly different from the original Open Surge game: early modifications ranged from simple sidescrollers to platformers with ninjas and RPG elements.
+
 
+
See also: [[Introduction to Modding]]
+
  
 
=== How do I take a screenshot? ===
 
=== How do I take a screenshot? ===
  
Press the "Print Screen" or "=" key. A screenshot will be saved in the screenshots/ folder.
+
Press the "=" (equals) key. A screenshot will be saved to the screenshots/ folder. In Linux, it should be saved to ~/.cache/opensurge2d/opensurge/screenshots.
  
 
== Troubleshooting ==
 
== Troubleshooting ==
Line 103: Line 93:
 
=== The screen size is too small! ===
 
=== The screen size is too small! ===
  
Go to the options screen (at the main menu) and increase the graphic resolution.
+
Go to the options screen (at the main menu) and increase the size.
  
 
=== The controls are strange! My character keeps going left or right! ===
 
=== The controls are strange! My character keeps going left or right! ===
  
This is happening because the joypad input is enabled. In order to disable it, please press F6 during the game.
+
Disable joystick input.
  
=== The game is too slow! ===
+
=== The game is slow! ===
  
Before taking any further action, we highly recommend that you close any other programs running on your computer. Restart the game after that. If it doesn't solve, try:
+
Close all running programs - '''specially the web browser'''. Next, close the game and open it again.
  
* At the options screen, decrease the graphic resolution to the minimum.
+
Additionally, you may decrease the screen size in the options screen. Also, play around with the command line options to tune things up. In a console window, type:
* Not fast enough? Enable fullscreen.
+
* Still slow? Run the game via command line and pass the following parameters:
+
opensurge --tiny --fullscreen --no-font-smoothing
+
* Not good yet? Try:
+
opensurge --tiny --fullscreen --no-font-smoothing --full-cpu-usage --color-depth 16 --show-fps
+
* (advanced) You can play around with other command line options. Type
+
 
  opensurge --help
 
  opensurge --help
 
=== The game has no sound! (Linux) ===
 
 
If you're compiling Open Surge from the source code, make sure you compile it with OpenAL enabled (on the directory of the game, run ''ccmake .''). If this is the case, this problem shouldn't occur.
 
 
Games made using the [http://alleg.sourceforge.net/ Allegro game programming library] can't play sounds on some GNU/Linux distributions (like recent Ubuntu releases) due to a problem with pulseaudio (check out the [http://www.allegro.cc/forums/thread/600325 full explanation]). We'll show you a workaround.
 
 
* First of all, please open a terminal and go to the folder where the game is located.
 
 
* (optional) Download liballeg.so.4.4 [http://opensnc.sourceforge.net/home/misc/liballeg.so.4.4 from this link]
 
 
wget <nowiki>http://opensnc.sourceforge.net/home/misc/liballeg.so.4.4</nowiki>
 
 
* Install the alsa-oss package. In Debian-based distributions (like Ubuntu), type:
 
 
sudo apt-get install alsa-oss
 
 
* Create a file named ''opensurge_with_sound'' '''in the game folder'''. Using a simple text editor (like nano, gedit, kate, etc.), write the following contents to it:
 
 
#!/bin/bash
 
export LD_LIBRARY_PATH=.:$LD_LIBRARY_PATH
 
aoss ./opensurge $@
 
 
* Finally, turn ''opensurge_with_sound'' into an executable by running chmod:
 
 
chmod +x opensurge_with_sound
 
 
* Now you're ready to go. Whenever you want to play, run ''opensurge_with_sound'':
 
 
./opensurge_with_sound
 
 
* If you still can't hear any sounds, please [http://opensnc.sourceforge.net/forum/viewtopic.php?id=100 read this tutorial].
 
 
=== The gameplay is choppy! ===
 
 
This most likely happens due to an experimental feature that optimizes CPU usage. In order to fix it, please open up a terminal and type:
 
 
'''Windows'''
 
opensurge.exe --full-cpu-usage
 
 
'''*nix'''
 
$ ./opensurge --full-cpu-usage
 
 
See also: [[FAQ#The_game_is_too_slow!|The game is too slow!]]
 
  
 
== Technical questions ==
 
== Technical questions ==
  
=== What are the dependencies of the game? ===
+
=== I've found a bug! ===
  
The dependencies of the latest SVN revision are:
+
If you've found a bug you think had escaped our attention, make sure you have as much information about when it occurred as possible. Tell us the steps to reproduce the bug, situations where the error won't show, etc. You can report the bug on the forums or [[Contact_the_developers|contact the developers]] directly.
  
* [http://alleg.sourceforge.net/ Allegro 4.4.2], with (at least) the following addons:
+
=== How do I run a level than isn't on the stage select? ===
** [http://www.ecplusplus.com/index.php?page=projects&pid=1 JPGalleg]
+
** [http://tjaden.strangesoft.net/loadpng/ loadpng] - requires: zlib and libpng
+
** [http://trent.gamblin.ca/logg/ LOGG] - requires: libogg and libvorbis
+
* [http://opensnc.sourceforge.net/alfont Modified Alfont 2.0.9]
+
  
Under *nix, you'll also need [http://kcat.strangesoft.net/openal.html OpenAL] and [http://kcat.strangesoft.net/alure.html ALURE] (with VorbisFile enabled)
+
You can simply go to the DEBUG (SECRET) stage select screen, where all .lev's (level files) will show up - cutscenes and everything. Here's how you access it:
  
In a regular installation of Allegro 4.4, JPGalleg and loadpng and LOGG are already included by default.
+
# Go to the options screen
 +
# Highlight stage select
 +
# Press RIGHT three times; you'll hear a sound
 +
# Enter
  
=== I've found a bug! ===
+
Since Open Surge version 0.5.0, you can also access the debug screen if you press RIGHT 3x in the splash screen (initial screen).
 
+
If you've found a bug you think had escaped our attention, make sure you have as much information about when it occurred as possible. Tell us the steps to reproduce the bug, situations where the error won't show, etc. You can report the bug on the [http://opensnc.sourceforge.net/forum forums] or [[Contact_the_developers|contact the developers]] directly.
+
  
 
=== Advanced command line options ===
 
=== Advanced command line options ===
  
There are a few interesting options that are not directly available to the user, such as using different color depths (16, 24, 32 bpp). Open a console/terminal and type:
+
There are a few advanced options that are not directly available to users. It's worthwhile exploring them if you're a creator. Open a console/terminal and type:
  
 
  opensurge --help
 
  opensurge --help
  
=== I can't compile the game! ===
+
=== How can I compile the source code? ===
 
+
Once you download the source tarball, read carefully the readme.html file. It contains detailed compiling instructions for many platforms. If it doesn't solve your problem, feel free to ask on our [http://opensnc.sourceforge.net/forum forums] or [[Contact_the_developers|contact the developers]].
+
 
+
=== I'm compiling it, but how do I change the installation folder? (Linux) ===
+
 
+
cmake -DPREFIX=/path/of/your/preference .
+
 
+
Don't forget the little '.' at the end.
+
 
+
=== How i run a level than ins't on the level select? ===
+
 
+
You can simply go to the DEBUG (SECRET) stage selection screen, where all .lev's will show up - cutscenes and everything.Here's how you acess it :
+
  
1. goto options screen
+
See: [[Compiling the Source Code]].
2. highlight stage select
+
3. press RIGHT three times; you'll hear a sound
+
4. enter
+
  
 
[[Category:Users]]
 
[[Category:Users]]

Revision as of 04:20, 2 August 2020

About the game

What is Open Surge?

Open Surge is a fun 2D retro platformer inspired by old-school Sonic games. It is also a game creation system that makes you a powerful creator! Play, hack, create games and unleash your creativity!

Open Surge is two projects in one: a game and a game creation system (game engine). It is released as free and open source software. Also, it is written from the ground up in C language, using the Allegro game programming library.

Where can I download it?

Get it at opensurge2d.org.

Who develops the game?

The game started to be developed by Alexandre Martins, a computer scientist from Brazil. Over time, people from all over the world began to contribute to the project, including artistics, musicians, translators and more! Check out the developers page for more information.

How can I help?

Do you feel inspired by this project? If you have artistic skills, marketing skills, speak multiple languages or have other talents, you can contribute! Contact Alexandre via Discord (alemart#7553) or e-mail.

I love Surge!

Marry him.

Can I create a game with Open Surge?

Absolutely! Read Introduction to Modding.

Can I create a commercial game with Open Surge?

Yes. First realize that a game created with the Open Surge Engine is composed of 2 parts:

  • The game engine: that's the Open Surge Engine, the software that runs the games
  • The game assets: those include visual arts, audio files and levels

1) The game engine is licensed under the GPL, a libre software license. You may use the game engine as-is or modify it keeping in mind the following:

  • If you use the game engine as-is, include its source code when distributing your game (it's in the src/ folder - the source code is already shipped by default in Open Surge).
  • If you modify the game engine in any possible way and publicly release your game, you must: 1. acknowledge that you have modified it and 2. provide access to your modified version of the source code of the game engine. Your modified version of the source code is automatically licensed under the GPL (you cannot change it to a different license).
  • You must provide a copy of the GPL license with the program.
  • Regardless of how you use it, the game engine remains free and open source, licensed under the GPL.

2) Your game assets may be licensed the way you want, as long as you own them. The GPL need not apply to your game assets. They may be under a proprietary license, and thus you may sell them.

  • New game assets created by you can have any license you want.
  • Reused or remixed game assets must keep the terms of their original license. Generally, art included in Open Surge is released under the Creative Commons Attribution (CC-BY) and scripts are released under the MIT license, with a few exceptions. You must check the assets themselves and the credits screen to know which licenses apply to which assets.
  • A note on scripts: the engine reads scripts in source form, so their source code is already exposed. Since scripts are considered to be software, release them under a GPL-compatible license, such as the MIT license.

SUMMARY: while the engine must remain free (as in freedom) and open source, game assets (graphics, audio, levels) made by you may be under a proprietary license. This form of distribution is legitimate and ensures customers must buy the content to play the game.

IMPORTANT: you must not exploit Surge commercially (nor the other characters), as this character is not your Intellectual Property (IP). When creating a commercial project, use your own original IP.

Answer adapted from the Solarus' FAQ.

Playing the game

How can I control the characters?

Using the keyboard, the important keys are: Arrows (move), Space Bar (jump), Left Ctrl (change character), Enter (pause) and ESC (quit). You can also use a joystick.

How do I play using a joystick?

Simply plug your joystick and have fun! Make sure that "Use gamepad" is set to to "YES" in the options screen.

How can I reconfigure the controls?

If you want different buttons for tasks like jumping, pausing the game, etc., you need to reconfigure the controls. Open config/input.def using a simple text editor like Notepad or gedit. Follow the instructions there.

How can I make my own levels?

See: How to make a level.

Are there additional levels?

Yes, you can find new levels on the forums!

What is a MOD?

It's a game made by users with the Open Surge game engine. MODs can be surprisingly different from the original Open Surge game: early modifications ranged from simple sidescrollers to platformers with ninjas and RPG elements. See Introduction to Modding.

How can I play MODs?

MODs come in a package (usually a .zip file). Simply decompress it and run the executable (.exe file). If you use Linux, you can use the command line to install a new MOD. For detailed instructions, run:

opensurge --help

How do I take a screenshot?

Press the "=" (equals) key. A screenshot will be saved to the screenshots/ folder. In Linux, it should be saved to ~/.cache/opensurge2d/opensurge/screenshots.

Troubleshooting

The screen size is too small!

Go to the options screen (at the main menu) and increase the size.

The controls are strange! My character keeps going left or right!

Disable joystick input.

The game is slow!

Close all running programs - specially the web browser. Next, close the game and open it again.

Additionally, you may decrease the screen size in the options screen. Also, play around with the command line options to tune things up. In a console window, type:

opensurge --help

Technical questions

I've found a bug!

If you've found a bug you think had escaped our attention, make sure you have as much information about when it occurred as possible. Tell us the steps to reproduce the bug, situations where the error won't show, etc. You can report the bug on the forums or contact the developers directly.

How do I run a level than isn't on the stage select?

You can simply go to the DEBUG (SECRET) stage select screen, where all .lev's (level files) will show up - cutscenes and everything. Here's how you access it:

  1. Go to the options screen
  2. Highlight stage select
  3. Press RIGHT three times; you'll hear a sound
  4. Enter

Since Open Surge version 0.5.0, you can also access the debug screen if you press RIGHT 3x in the splash screen (initial screen).

Advanced command line options

There are a few advanced options that are not directly available to users. It's worthwhile exploring them if you're a creator. Open a console/terminal and type:

opensurge --help

How can I compile the source code?

See: Compiling the Source Code.