Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tanis2000/binocle-player

Standalone player for games made in Lua using the Binocle engine
https://github.com/tanis2000/binocle-player

gamedev lua player

Last synced: 4 days ago
JSON representation

Standalone player for games made in Lua using the Binocle engine

Host: GitHub
URL: https://github.com/tanis2000/binocle-player
Owner: tanis2000
Created: 2022-03-01T19:33:44.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2024-10-16T12:23:11.000Z (about 1 month ago)
Last Synced: 2024-10-18T09:17:14.808Z (28 days ago)
Topics: gamedev, lua, player
Language: C++
Homepage:
Size: 12.7 MB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Binocle Player

[![Windows](https://github.com/tanis2000/binocle-player/actions/workflows/windows.yml/badge.svg)](https://github.com/tanis2000/binocle-player/actions/workflows/windows.yml)
[![macOS](https://github.com/tanis2000/binocle-player/actions/workflows/macos.yml/badge.svg)](https://github.com/tanis2000/binocle-player/actions/workflows/macos.yml)
[![Wasm](https://github.com/tanis2000/binocle-player/actions/workflows/wasm.yml/badge.svg)](https://github.com/tanis2000/binocle-player/actions/workflows/wasm.yml)

Binocle Player aims at providing a pre-compiled version of Binocle that can be used to quickly write 2D games in Lua.

The core philosophy is somewhat similar to Love2D. Binocle Player comes as a pre-compiled binary for macOS and Windows and can run games from the command line.

On the other hand, if you compile it from sources you can embed your game with the executable and make it run on all the platforms supported by Binocle.

## Running your own game

```shell
./binocle-player
```

## Packaging your game

### Windows/macOS

```shell
cmake -Bbuild -DCMAKE_BUILD_TYPE=Release -DBINOCLE_DATA_DIR=
```

### Browser

```shell
emcmake cmake -Bbuild -DCMAKE_BUILD_TYPE=Release -DASSETS_DIR=
```

As an example

```shell
emcmake cmake -Bbuild -DCMAKE_BUILD_TYPE=Release -DASSETS_DIR=/Users/tanis/Documents/binocle-player-games/simple/
```

## HTTP support

HTTP support is disabled by default. If you want to enable the HTTP module, you have to add `-DBINOCLE_HTTP=1` to cmake's command line.

## Samples

Some example games are available in the [Bincole Player Games](https://github.com/tanis2000/binocle-player-games) repository.