Surge the Rabbit is a fun and open source jump 'n run retro game made in the spirit of classic 16-bit Sonic platformers of the 90s. The levels are filled with challenges, gimmicks and hazards! Exciting adventures are waiting for you! You can also use it as a base to create your own amazing games!
Make your dreams come true! Surge Engine is the very flexible open source 2D game engine that powers Surge the Rabbit. Its capabilities include: level editing, artwork modding, full blown scripting, and much more! It's an open-source, cross-platform retro game engine that runs on Desktop computers and on mobile devices.
The fun is multiplied! Several MODs created by the fans in the Open Surge Community can be played on the engine. For those who get involved, this project is also a valuable tool for learning game development, programming, artistic skills, and the nature of free and open-source software in a playful way.
Please support the development of the project:
The project is written from the ground up in C language, using the Allegro game programming library. It has been started by Alexandre Martins, a computer scientist from Brazil. Nowadays, it has contributors all over the world!
See CONTRIBUTING.
Run opensurge --help
Extract the MOD to your filesystem and run the game.
- Windows: launch the executable.
- Linux, macOS: run
opensurge --game /path/to/game/on the command-line or load the game from the options screen.
Linux users should extract MODs preferably to their home folder. Flatpak users may use ~/Downloads.
Visit the wiki for more information on user-made MODs.
Content is distributed in the following locations: (since version 0.6.1)
bin: executable fileshare: game assets (images, audio, levels, scripts, etc.)user: user-modifiable data (preferences, logs, screenshots, additional assets such as user-made levels)
The default paths of these locations vary according to the platform:
-
Windows (.zip package):
bin:./opensurge.exeshare:.user:.or%OPENSURGE_USER_PATH%
-
Linux:
bin:/usr/games/opensurgeshare:/usr/share/games/opensurge/user:~/.local/share/opensurge/or$XDG_DATA_HOME/opensurge/or$OPENSURGE_USER_PATH
-
Linux (Flatpak):
bin:flatpak run org.opensurge2d.OpenSurgeshare:/var/lib/flatpak/app/org.opensurge2d.OpenSurge/current/active/files/share/opensurge/user:~/.var/app/org.opensurge2d.OpenSurge/data/opensurge/or$OPENSURGE_USER_PATH
If you use
$OPENSURGE_USER_PATH, make sure it points to a subdirectory of~/Downloads($XDG_DOWNLOAD_DIR). -
Linux (Snap):
bin:snap run opensurgeshare:/snap/opensurge/current/share/games/opensurge/user:~/snap/opensurge/current/.local/share/opensurge/or$OPENSURGE_USER_PATH
If you use
$OPENSURGE_USER_PATH, make sure it points to a subdirectory of your home folder. -
macOS:
bin:Contents/MacOSshare:Contents/Resourcesuser:~/Library/Application Support/opensurge/or$OPENSURGE_USER_PATH
If you intend to hack the game, it's easier to have all files in the same place (read-write), because some of the above folders are read-only. Download the sources (use the same engine version), extract them to your filesystem and use the --game-folder command-line option.
Tip: since version 0.6.1, check the Engine information at the options screen to see where the files are. Alternatively, you can use the command-line option --verbose: the directories will appear at the beginning of the output.
Dependencies:
- Allegro version 5.2.7 or later (modified 5.2.9 on Android)
- SurgeScript version 0.6.0
- PhysicsFS version 3.2.0 (recommended) or 3.0.2
Compile as usual:
cd /path/to/opensurge/
mkdir build && cd build
cmake ..
make -j4
sudo make install
Use cmake-gui or ccmake for tweaking, like installing the engine to or finding the dependencies on non-standard paths.
Open Surge Engine Copyright 2008-present Alexandre Martins. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. For more information, see LICENSE.