https://github.com/jrob774/runner

My third ever finished game.
https://github.com/jrob774/runner

1bit 2d cpp cpp17 emscripten endless-runner game runner sdl sdl2 sidescroller simple

Last synced: 10 days ago
JSON representation

My third ever finished game.

• Host: GitHub
• URL: https://github.com/jrob774/runner
• Owner: JROB774
• License: mit
• Created: 2021-11-07T14:02:28.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2023-06-25T10:47:53.000Z (over 1 year ago)
• Last Synced: 2024-11-06T04:33:24.703Z (about 2 months ago)
• Topics: 1bit, 2d, cpp, cpp17, emscripten, endless-runner, game, runner, sdl, sdl2, sidescroller, simple
• Language: C++
• Homepage: https://jrob774.itch.io/runner
• Size: 4.96 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Runner

This project was my third completed game, made back in 2015. It's a simple

endless runner game where you must jump over and slide under obstacles whilst

collecting as many coins as possible to get a highscore. A download for the

game can be found over on  **[itch.io](https://jrob774.itch.io/runner)**, the

game is also playable in browser on the same page.

## Development

The game was developed in C++ using the **[SDL2](https://libsdl.org/)** library.

A port for web browsers was also recently developed using

**[emscripten](https://github.com/emscripten-core/emscripten)**.

## Building

### Windows

Launch the `build/win32/win32` shortcut to setup a command prompt in the right

environment. The game can then be built by typing `build` in the console.

Different types of builds can be made by specifying an extra argument after the

initial build command, these arguments are:

```

debug   - builds a debug version of the game (default)

release - builds a release version of the game

final   - builds and packages a release version

```

In order to be able to execute builds Visual Studio must be installed. All

other dependencies (SDL2, etc.) are provided within the repository.

### Web

Launch the `build/web/web` shortcut to setup a command prompt in the right

environment. The game can then be built by typing `build` in the console.

Different types of builds can be made by specifying an extra argument after

the initial build command, these arguments are:

```

release - builds a release version of the game (default)

final   - builds and packages a release version

```

In order to be able to execute builds emscripten must be installed. By default

the build script looks for emscripten at the relative location

`../../../.emsdk`, in order to change this path open the 'build/web/setup.bat'

file and change the `emsdk_location` variable.

## License

The project's code is available under the

**[MIT License](https://github.com/JROB774/runner/blob/master/LICENSE)**.