README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

# Frogartha Open Source

A chat room game, written in Java and LibGDX. This project uses Gradle to manage dependencies.

## Building from sources

To compile this project you will need [JDK 11](https://adoptium.net). Copy the repository and open it via the terminal
and do what you need:

### Desktop (Windows/macOS/Linux)

- `./gradlew lwjgl3:run`: starts the application.
- `./gradlew lwjgl3:dist`: builds application's runnable jar, which can be found at `lwjgl3/build/libs`.

### HTML

- `./gradlew html:dist`: compiles GWT sources. The compiled application can be found at `html/build/dist`: you can use
  any HTTP server to deploy it.
- `./gradlew html:superDev`: compiles GWT sources and runs the application in SuperDev mode. It will be available
  at [localhost:8080/html](http://localhost:8080/html). Use only during development.

### Server

- `./gradlew server:run`: runs the server application.

## Downloads

| [![itch.io](https://static.itch.io/images/badge.svg)](https://ilotterytea.itch.io/frogartha) |
|----------------------------------------------------------------------------------------------|

## License

This project is under the Mozilla Public License
2.0! [Read on LICENSE](https://github.com/ilotterytea/frogartha/blob/master/LICENSE).<br>
Project Assets under
the [Creative Commons Attribution v4.0 International](https://creativecommons.org/licenses/by/4.0/)!