SE-TINF22B6 / Underwatch

Top-Down Dungeon Crawler

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Underwatch

Logo Banner

License Java CI with Gradle React CI Spring Boot CI

Alt

Introduction

Underwatch is a game which was created as a student project at DHBW. We created a 2D-Pixelart-Hack'n'Slash-Shooting game which hopefully suits your tastes. Currently the game is in a very bare bone but still playable state.

If you are looking for the documentation which was created during that course head over to the ๐Ÿ“– Wiki.

๐Ÿ—บ๏ธ Web Page

We are building a web page for the game which can be used to see the high scores of various players as well as browsing the game wiki for the lore of the game.

Additionally this page serves as advertisement for our game so potential players can discover us via a search engine.

๐ŸŽฎ Features

Our mission is to provide as many players with an enjoyable experience as possible. In order to achive that we are taking care that all of our features are implemented carefully and have gone through serious testing.

๐ŸŒˆ Pretty Maps TODO
๐Ÿค– Advanced AI TODO
๐Ÿ“Š Statistics Tracking TODO
๐Ÿ—บ๏ธ Cozy Webpage TODO

๐Ÿ”ฉ Getting Started

You want to start contributing to this project? That's great! Here are some pointers on where to get you started in the department you want to contribute to.

Regardless of where you want to contribute, start by checking out this repository.

$ git pull git@github.com:SE-TINF22B6/Underwatch.git

๐ŸŒˆ Web development

The web page sources are located in the folder Underwatch/website. We use npm as a package manager. First pull the dependencies via:

$ cd website
$ npm install

then run the development server with:

$ npm start

Changing any of the source files automatically reloads the development server effectively showing you the most recent changes you've made.

๐Ÿ•น๏ธ Game development

The game is scaffolded with Gradle and is located in the Underwatch/game directory. We use Java 17 as a development JDK. Verify your installation with:

$ java --version

Run the game via the run configuration:

$ cd game
$ ./gradlew run

Important

If you're on Apples M1 architecture append the JVM argument -XstartOnFirstThread as this will allow the LWJGL application to start properly.

๐Ÿง‘โ€๐Ÿ”ฌ Technologies

Logo Banner Logo Banner Logo Banner

About

Top-Down Dungeon Crawler

License:MIT License


Languages

Language:Java 73.1%Language:TypeScript 22.9%Language:GLSL 1.7%Language:CSS 0.8%Language:HTML 0.7%Language:JavaScript 0.6%Language:Dockerfile 0.1%