The unofficial Scala game
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
android
art
core/src/main/scala
desktop/src/main
html5
marketing
project
.gitignore
IDEAS.md
README.md
build.sbt

README.md

Scalavator

Scalavator is the unofficial Scala game. It is a cross-platform, open-source, arcade game where you must jump from platform to platform to reach higher and higher (scores).

Scalavator is inspired by the classic Doodle Jump, but its mecanisms have been adapted to be enjoyable to play in non-mobile platforms such as the web or the desktop. It kept the simplicity of the controls in order to be fully playable on mobile as well.

Scalavator was started as a way to demonstrate how to use the Scala Game Library (SGL), a cross-platform game engine for the Scala programming language. It is fully open source and its code is under the MIT license. The goal was to show a small, but complete game implemented with SGL and taking advantage of the cross-platform features of the library.

The current implementation supports three platforms: Android, HTML5, and Desktop JVM. The core game logic is under the core directory tree. The platform-specific implementations consist of very simple sub-projects (under android, html5, and desktop, respectively), with only a single file to define the correct dependencies. For example, here is the only required Android code, just a couple lines of code.

Scalavator is available to try online from your browser, or to download for your Android device on Google Play. I invite you to try both and spot the differences.

You can also build and run Scalavator yourself, just run the following command:

sbt desktop/run

It should start the Desktop JVM version of Scalavator. You can also build an Android APK (after installing the Android dependencies) with sbt android/android:packageDebug and a javascript build (after installing scala.js dependencies) with sbt html5/fastOptJS.

Not that anyone would ever need them, but just in case, all the art assets that I provided for the game are released in the public domain. Some assets on this repository might come from a third-party source and are thus only reusable from their oiginal source (usually, under a creative common license).

The game is not quite finished yet. The goal is to evolve along with the development of SGL. The game will be ported to as many platforms as possible, most notably to iOS, and as an executable for Windows, OSx, and Linux. I also plan to add support for Leaderboards, achievements, and analytics, and show how these can be integrated over all these platforms in a shared Scala code base. Graphics are what they are --- programmer art.. I don't plan to spend much more time on them, but if you are of the artistic kind, I will appreciate any contribution.

If you are interested in trying out SGL, this repository is a good starting point with a working project. You can then modify the core game logic to go into any direction you wish. If you do build a game with SGL, please reach out to the SGL project, or get in touch directly with me.

Credits