https://github.com/vilhelmprytz/bornholm
:stars: A 2D shooter game created in LÖVE2D (Lua)
https://github.com/vilhelmprytz/bornholm
love2d lua
Last synced: 5 months ago
JSON representation
:stars: A 2D shooter game created in LÖVE2D (Lua)
- Host: GitHub
- URL: https://github.com/vilhelmprytz/bornholm
- Owner: vilhelmprytz
- License: gpl-3.0
- Created: 2020-02-10T19:46:27.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-22T18:51:04.000Z (about 6 years ago)
- Last Synced: 2025-04-06T07:34:11.398Z (about 1 year ago)
- Topics: love2d, lua
- Language: Lua
- Homepage:
- Size: 1.03 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# operation-bornholm
[](https://travis-ci.com/operation-bornholm/bornholm)
The Operation Bornholm game.
## Getting started
If you are on Windows, you can download the pre-built Windows executable from the latest release [here](https://github.com/VilhelmPrytz/bornholm/releases). Just click the downloaded `.zip` and run `bornholm.exe`.
If you are on Linux, you need to have [LOVE2D](https://love2d.org) installed since we don't provide Linux binaries. You can then download `bornholm.love` from the GitHub release page [here](https://github.com/VilhelmPrytz/bornholm/releases).
To run it from Linux:
```bash
love bornholm.love
```
## Controls and game objective
Use `A` and `D` to move left or right. Use spacebar to jump and aim with your mouse. The objective is to survive as long as possible to get a high score. Each time you shoot a "ghost" your score increases by one. If a ghost manages to touch the player, the game is over.
Use escape to exit the game completely. Press Enter (Return) to restart game when dead.
## Requirements for development
* [LOVE2D](https://love2d.org) (version 11.3)
* `love` command in your path (instructions on how to add this available on the official LÖVE website)
## Running locally
Start the repo from within the code.
```bash
love .
```
## Compiling Windows binary and `.love` executable
Requires Linux, `zip`, `unzip` and `wget`. You can create a `.love` for Linux and `.zip` with Windows binary using make. To build, simply run it.
```bash
make
```
The Windows binary will be available at `dist/bornholm_windows.zip` and the `.love` file will be available at `bornholm.love`.
## Structure
General structure of code.
* `src/main.lua` - main LOVE2D file
* `src/tiles` - textures for tiles
* `src/maps` - map data structures
* `src/ui` - contains methods related to the UI and HUD
* `src/objects` - methods (objects) for each element of the game
* `src/objects/bullets.lua` - handles bullets (collision, draw, create, delete)
* `src/objects/enemies.lua` - handles enemies (collision, draw, create, delete)
* `src/objects/player.lua` - handles player (collision, draw)
## Contributors
The Operation Bornholm project is created and maintained by [Vilhelm Prytz](https://github.com/VilhelmPrytz) and [Pontus Liedgren](https://github.com/PontusLiedgren).