CosPlay - 2D ASCII Game Engine for Scala

Built-In Games

CosPlay comes with a number of built-in ready to play games:

Examples

CosPlay also comes with many examples for each functional area. The source code for these examples is shipped with the project (see org.cosplay.examples package) and can be also found on GitHub.

If you have CosPlay project in IDE you can review the source code and run each example right from IDE. Each example is a simple Scala application with the main(...) method. The easiest way to run examples from the command line is to use SBT or Maven. First, clone and build the CosPlay Git repository (this needs to be done only once):

                    # One-time Git clone & build:
                    $ git clone https://github.com/nivanov/cosplay.git
                    $ cd cosplay
                    $ sbt package

                    # One-time Git clone & build:
                    $ git clone https://github.com/nivanov/cosplay.git
                    $ cd cosplay
                    $ mvn package

Assuming you are in cosplay folder use the following table to run examples:

Example	Run & Code
Animation	`CPAnimationExample.scala` Maven $ sbt "project cosplay; runMain org.cosplay.examples.animation.CPAnimationExample" $ mvn -f modules/cosplay -P ex:animation exec:java
Camera	`CPCameraExample.scala` Maven $ sbt "project cosplay; runMain org.cosplay.examples.camera.CPCameraExample" $ mvn -f modules/cosplay -P ex:camera exec:java
Image Formats	`CPImageFormatsExample.scala` Maven $ sbt "project cosplay; runMain org.cosplay.examples.image.CPImageFormatsExample" $ mvn -f modules/cosplay -P ex:image_formats exec:java
Image Carousel	`CPImageCarouselExample.scala` Maven $ sbt "project cosplay; runMain org.cosplay.examples.image.CPImageCarouselExample" $ mvn -f modules/cosplay -P ex:image_carousel exec:java
Fonts	`CPFontsExample.scala` Maven $ sbt "project cosplay; runMain org.cosplay.examples.fonts.CPFontsExample" $ mvn -f modules/cosplay -P ex:fonts exec:java
Particle Effects	`CPParticleExample.scala` Maven $ sbt "project cosplay; runMain org.cosplay.examples.particle.CPParticleExample" $ mvn -f modules/cosplay -P ex:particle exec:java
Shaders	`CPShaderExample.scala` Maven $ sbt "project cosplay; runMain org.cosplay.examples.shader.CPShaderExample" $ mvn -f modules/cosplay -P ex:shader exec:java
Slide Shaders	`CPSlideShaderExample.scala` Maven $ sbt "project cosplay; runMain org.cosplay.examples.shader.CPSlideShaderExample" $ mvn -f modules/cosplay -P ex:slide_shader exec:java
Text Input	`CPTextInputExample.scala` Maven $ sbt "project cosplay; runMain org.cosplay.examples.textinput.CPTextInputExample" $ mvn -f modules/cosplay -P ex:textinput exec:java
Tile Mapping	`CPTileMapperExample.scala` Maven $ sbt "project cosplay; runMain org.cosplay.examples.tilemapper.CPTileMapperExample" $ mvn -f modules/cosplay -P ex:tilemapper exec:java
Sound	`CPSoundExample.scala` Maven $ sbt "project cosplay; runMain org.cosplay.examples.sound.CPSoundExample" $ mvn -f modules/cosplay -P ex:sound exec:java
Video	`CPVideoExample.scala` Maven $ sbt "project cosplay; runMain org.cosplay.examples.video.CPVideoExample" $ mvn -f modules/cosplay -P ex:video exec:java

Built-In Terminal Emulator

By default, all examples start in the system terminal. If you want to run these examples in the built-in terminal emulator you need to add emuterm as a program argument. Depending on how you start the example - SBT, Maven, IDE or straight command line - this is done differently. For example, to run video example using built-in terminal emulation:

                        $ sbt "project cosplay; runMain org.cosplay.examples.video.CPVideoExample emuterm"

                        mvn -f modules/cosplay -P ex:video exec:java -Dexec.arguments="emuterm"