You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+63-40
Original file line number
Diff line number
Diff line change
@@ -14,57 +14,80 @@
14
14
<img >
15
15
</div>
16
16
17
-
# 📃 Table of content
17
+
##📃 Table of content
18
18
19
19
-[🚀 Goal of the project](#-goal-of-the-project)
20
20
-[🧑💻 Installation](#-installation)
21
21
-[🛠 Installation on Windows / Linux](#-installation-on-windows--linux)
22
-
-[🛠 Installation Locally](#-installation-locally)
22
+
-[💻 Installation Locally](#-installation-locally)
23
23
-[🎮 How to Play](#-how-to-play)
24
+
-[🎥 Gameplay](#-gameplay)
24
25
-[🙏Contributing](#contributing)
25
26
-[🌍 Support](#-support)
26
-
-[✍️ Licence](#️-licence)
27
-
-[👨 Creators](#-creators)
27
+
-[✍️ Licence](#-licence)
28
+
-[👨 Creators](#-author)
28
29
29
-
# 🚀 Goal of the project
30
+
##🚀 Goal of the project
30
31
31
32
> [!NOTE]
32
33
> I initially developed a very basic game in 2022 and created multiple issues to encourage contributions from the community. The main goal of this repository is not just to build a game, but to provide an open-source project where everyone can contribute step by step.
33
34
34
-
# 🧑💻 Installation
35
+
##🧑💻 Installation
35
36
36
37
> [!IMPORTANT]
37
38
> Be aware to download the version of [Open JDK 21](https://jdk.java.net/archive/) before installing. I bet you can download any JDK you want, it just needs to be version 21.
38
39
> Run the command `java --version` to make sure Java 21 is installed.
39
40
40
-
## 🛠 Installation on Windows / Linux
41
-
42
-
- Click [here](https://github.com/jvondermarck/dinosaur-exploder/tags) and look at the last release you will found, to download the `dinosaur-exploder.jar` executable.
43
-
- Then in a console, type the following command:
44
-
45
-
```console
46
-
$> java -jar dinosaur-exploder.jar
47
-
```
48
-
49
-
## 🛠 Installation Locally
50
-
51
-
> You should not need to download [Java FX](https://openjfx.io/openjfx-docs/#introduction) and FXGL on your local computer because it should be downloaded when syncing the Maven project.
52
-
53
-
- To install the project locally, [`fork` our repository](https://github.com/jvondermarck/dinosaur-exploder/fork), and in an empty directory,
- Make sure to sync the Maven project in your IDE (you could use IntelliJ IDEA)
61
-
62
-
- Run the game :
63
-
- On your IDE : hit play on your IDE and select the `com.dinosaur.dinosaurexploder.DinosaurApp` target where it contains the main.
64
-
- With an executable : generate a `jar` file with the command `mvn package` and then `java -jar target/dinosaur-exploder-1.0.jar`
65
-
- On the web : run the command `mvn jpro:run` and the game should be available at `http://localhost:8080/`
66
-
67
-
# 🎮 How to Play
41
+
### 🛠 Installation on Windows / Linux / Mac
42
+
43
+
🚀 **Quick Start**:
44
+
1.**Download the latest release** ➡️ [Click here](https://github.com/jvondermarck/dinosaur-exploder/tags) and grab the latest `dinosaur-exploder.jar`.
45
+
2.**Run the game** by executing the following command in your terminal:
46
+
```console
47
+
$ java -jar dinosaur-exploder.jar
48
+
```
49
+
50
+
### 💻 Installation Locally
51
+
52
+
💡 **No need to install**[JavaFX](https://openjfx.io/openjfx-docs/#introduction) or FXGL manually—Maven will handle dependencies automatically!
53
+
54
+
#### 📥 Clone the repository
55
+
1.**Fork** the repository ➡️ [`Click here`](https://github.com/jvondermarck/dinosaur-exploder/fork).
> Check out our **[installation guide](https://github.com/jvondermarck/dinosaur-exploder/wiki/Documentation#dinosaur-exploder-documentation)** for in-depth instructions!
89
+
90
+
## 🎮 How to Play
68
91
69
92
Play the game with these controls:
70
93
@@ -76,16 +99,16 @@ Play the game with these controls:
76
99
- 🔫 <kbd>Space</kbd>: shoot.
77
100
- 💥 <kbd>B</kbd>: eliminate all the dinosaurs on the screen using a bomb.
> I am very much open to contributions - please read our [code of conduct](https://github.com/jvondermarck/dinosaur-exploder/blob/main/CODE_OF_CONDUCT.md) and [contribution guidelines](https://github.com/jvondermarck/dinosaur-exploder/blob/main/CONTRIBUTING.md) first.
87
110
88
-
# 🌍 Support
111
+
##🌍 Support
89
112
90
113
**Any question ? 🦖 Feel free to write us something :**
- You can post an article on our [Website blog](https://dinosaur-exploder.freecluster.eu/forum).
95
118
- For quick communication, feel free to join our [Discord server](https://discord.com/invite/nkmCRnXbWm).
96
119
97
-
# ✍️ Licence
120
+
##✍️ Licence
98
121
99
122
> This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/jvondermarck/dinosaur-exploder/blob/main/LICENSE) file for details.
100
123
101
-
# 👨 Author
124
+
##👨 Author
102
125
103
-
<palign="center"> At first we are a group of three creators (Dylan, Maxime and I), but since 2023, I am taking care of everything.
126
+
- Initially, the project was a collaboration between three creators : Dylan, Maxime, and myself—as part of a school project at the University of Cork in 2022. However, after the semester ended, I took over full responsibility for the project, while my teammates moved on to other endeavors."
0 commit comments