-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2d262ec
commit d3d5a61
Showing
1 changed file
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/3/37/Kotlin_Icon_2021.svg/1024px-Kotlin_Icon_2021.svg.png" alt="drawing" width="30"/> Kotlin Tetrux | ||
|
||
A very simple clone of the famous [Tetris Game](https://tetris.com/) written in Kotlin for this week's assignment | ||
|
||
The game utilises the JavaFX framework to display the game and user interface. Additionally, a custom written logger + sound manager is being used to make development easier. | ||
<br> | ||
|
||
<hr> | ||
|
||
## 🐘 Features | ||
|
||
* Full fledged Tetris clone | ||
* Custom logger + sound manager | ||
* Awesome Music | ||
* Modifyable keybinds | ||
|
||
## 🎉 Upcoming Features | ||
|
||
* Auto-Saving Keybinds | ||
* Leaderboard | ||
|
||
## :books: Libraries | ||
|
||
* [Kotlin language](https://kotlinlang.org/) | ||
* [JavaFX framework](https://openjfx.io/) | ||
|
||
## :package: Download | ||
|
||
The Game is packaged as an macOS app-image found in the releases tab.<br> | ||
Compile it yourself by running `mvn clean install`. The executable is found in `target/installer`. | ||
|
||
## :hammer: Installation | ||
|
||
1. Clone the repository (preferably into IntelliJ IDEA) | ||
2. Open the project and let maven do its thing | ||
3. Run + enjoy! | ||
|
||
## ⚠️ Disclaimer | ||
|
||
* This game is definitely not a clone of the original Tetris game. | ||
* Please don't judge me for my code (I try my best) and don't use it as a reference. |