Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/theovier/athena

Playground. Prototyping ideas for a simple 2D game.
https://github.com/theovier/athena

2d ashely desktop ecs game kotlin ktx libgdx maven prototype

Last synced: about 2 months ago
JSON representation

Playground. Prototyping ideas for a simple 2D game.

Host: GitHub
URL: https://github.com/theovier/athena
Owner: theovier
License: gpl-3.0
Created: 2021-07-13T18:25:47.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-06-30T13:39:39.000Z (6 months ago)
Last Synced: 2024-07-02T22:02:31.599Z (6 months ago)
Topics: 2d, ashely, desktop, ecs, game, kotlin, ktx, libgdx, maven, prototype
Language: Kotlin
Homepage:
Size: 66.8 MB
Stars: 3
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: COPYING

Awesome Lists containing this project

README

        [![Main Build](https://img.shields.io/github/workflow/status/theovier/athena/Kotlin%20CI%20with%20Maven?label=Main)](https://github.com/theovier/athena/actions)

[![GitHub license](https://img.shields.io/github/license/theovier/athena)](https://github.com/theovier/athena/blob/main/COPYING)

[![LibGDX](https://img.shields.io/badge/LibGDX-1.10.0-red.svg)](https://github.com/libgdx/libgdx)

[![LibKTX](https://img.shields.io/badge/LibKTX-1.10.0--b1-red.svg)](https://github.com/libktx/ktx)

# Athena

This is a 2D shoot'em up game done in [KTX](https://github.com/libktx/ktx).

The main purpose of this project is simply to play around with some ideas and homemade graphics.

Don't expect anything too fancy or polished here.

## Status

Work in progress.

## Features

- Uses [Ashley](https://github.com/libktx/ktx/tree/master/ashley) as its [ECS](https://en.wikipedia.org/wiki/Entity_component_system)

- Basic movement system with acceleration and friction

- Smooth camera movement by simple [asymptotic average](https://www.youtube.com/watch?v=tu-Qe66AvtY&t)

- Smooth translational + rotational [camera shake based on trauma](https://www.youtube.com/watch?v=tu-Qe66AvtY&t)

- Custom prefab system (using JSON)

  - Including entity hierarchy

  - Components can reference other entities/components in same prefab file

- Controller support with [relatively smooth aiming](https://www.gamasutra.com/blogs/MarkVenturelli/20150817/251387/Everything_I_Learned_About_DualStick_Shooter_Controls.php)

- Basic support for [tiled maps](https://github.com/libktx/ktx/tree/master/tiled)

- Particle system relying on [LibGdx's particle system](https://github.com/libgdx/libgdx/wiki/2D-ParticleEffects)

- Supports [Spine](http://de.esotericsoftware.com/) animations and skeletons

- Uses [LibGdx's Box2D](https://github.com/libgdx/libgdx/wiki/Box2d) as physic engine

- Simple damage system with critical hits and floating damage text 

- Simple loot system

- Bullet impact effects using dynamic spawning of particles

- Finite State Machines

- Aim Assist

## Screenshots

![screenshot_001](screenshots/screenshot_002.gif)

![screenshot_002](screenshots/screenshot_003.gif)

## Building from Source

This project uses **Gradle** as its build management tool.

Simply run

```

./gradlew build

```

and check your /build folder for the newly generated jar files at `/build/libs/client-VERSION.jar`.

### macOS

Please note that (even when run from within your IDE) you need to add the VM option flag `-XstartOnFirstThread`

to make the application window appear on macOS.

## Contribution

Feel free to open up pull-requests or discuss issues with us on GitHub.

## Acknowledgement

I used the [Quilly-Crawler](https://github.com/Quillraven/Quilly-Crawler) game as reference on how to get started with KTX.

Also, I found [Sioncore](https://github.com/dsaltares/sioncore) to be a good read on how to develop modular LibGdx/KTX games.

For the creation of the bullet shell effects, I found [Rowdy Lemon's Youtube tutorial on shell casings](https://www.youtube.com/watch?v=vTAR14bVJPA&list=LL&index=16) extremely valuable.

For creating particle effects, I use the brilliant open-source [Talos Particle Engine](https://github.com/rockbite/talos).

For the ideas of FSM in ECS, I found [Richard Lord's view](https://www.richardlord.net/blog/ecs/finite-state-machines-with-ash.html) worth the read.

## License

[GNU General Public License v3.0](https://choosealicense.com/licenses/gpl-3.0/#) except for the Spine Runtime.

### Spine Runtime

Please note that since the Spine Runtime dependency is used, this part of the project is licenced under the [Spine Runtime Licence](https://github.com/EsotericSoftware/spine-runtimes/blob/4.0/LICENSE) instead.

### Audio Files (Teeworlds)

Some audio files (namely `gun_fire-01.ogg`, `gun_fire-02.ogg` and `gun_fire-03.ogg`) are converted versions of the [Teeworlds' Sound Effects](https://github.com/teeworlds/teeworlds/tree/master/datasrc/audio) which are licenced under the [CC-BY-SA 3.0](https://github.com/teeworlds/teeworlds/blob/master/license.txt) 

### Audio Files (Other)

* The "gun shell hitting the floor" and the "ka-ching" sounds are licenced under the [Creative Commons Attributive Licence](https://creativecommons.org/licenses/by/3.0):

  * https://freesound.org/s/159002

  * https://freesound.org/s/159003

  * https://freesound.org/s/159004

  * https://freesound.org/s/159005

  * https://freesound.org/s/159006

  * https://freesound.org/s/159008

  * https://freesound.org/s/554841

### [Banger Font](https://www.1001fonts.com/bangers-font.html)

The used [banger font](https://www.1001fonts.com/bangers-font.html) is licenced under the [SIL Open Font Licence (OFL)](http://scripts.sil.org/OFL).