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
FastJ is an open-source, Java-based 2D game engine and framework. Originally named the FastJ Engine, it aims to provide an easy-to-use, 2D game-making library.
22
23
24
+
23
25
## Disclaimer
24
26
**This project is still under heavy development.** There is a very good chance bugs are still prevalent and untracked, as the engine is not fully covered by unit tests. Documentation is readily available, but may change over time. [If you would like to help out, all help is appreciated!](#contributing-to-fastj)
25
27
@@ -49,55 +51,67 @@ FastJ is an open-source, Java-based 2D game engine and framework. Originally nam
49
51
❌ is not yet implemented.
50
52
51
53
52
-
## Adding FastJ to your project
54
+
## Adding FastJ to a Project
53
55
This library can be found in the following places:
56
+
-[jitpack.io][Jitpack.IO], as a dependency.
54
57
-[Maven Central][Maven-Central], as a dependency or as a jarfile.
55
58
- The [Releases][Releases] section of this repository.
56
59
60
+
57
61
### Adding the Dependency
58
-
When adding the dependency, **make sure to replace `[latest version here]` with the actual latest version** (you'll find this in the Maven Central link up above). **The current latest version is 1.4.0**.
62
+
When adding the dependency, **make sure to replace `[latest version here]` with the actual version** (you'll find this in the jitpack.io or Maven Central link up above). **The current latest version is 1.5.0**.
59
63
60
64
A few common dependencies are provided below:
61
65
62
66
-**Gradle**
63
67
- Groovy:
64
68
```groovy
65
-
implementation 'io.github.lucasstarsz.fastj:fastj-library:[latest version here]'
69
+
repositories.maven {
70
+
url('https://jitpack.io')
71
+
}
72
+
73
+
dependencies.implementation('com.github.fastjengine:FastJ:[latest version here]')
66
74
```
67
75
- Kotlin:
68
76
```kotlin
69
-
implementation("io.github.lucasstarsz.fastj:fastj-library:[latest version here]")
77
+
repositories.maven {
78
+
setUrl("https://jitpack.io")
79
+
}
80
+
81
+
dependencies.implementation("com.github.fastjengine:FastJ:[latest version here]")
70
82
```
71
83
- **Maven**
72
84
```xml
85
+
<repository>
86
+
<id>jitpack.io</id>
87
+
<url>https://jitpack.io</url>
88
+
</repository>
89
+
73
90
<dependency>
74
-
<groupId>io.github.lucasstarsz.fastj</groupId>
75
-
<artifactId>fastj-library</artifactId>
91
+
<groupId>com.github.fastjengine</groupId>
92
+
<artifactId>FastJ</artifactId>
76
93
<version>[latest version here]</version>
77
94
</dependency>
78
95
```
79
-
-**Apache Ivy**
80
-
```xml
81
-
<dependencyorg="io.github.lucasstarsz.fastj"name="fastj-library"rev="[latest version here]" />
82
-
```
83
96
84
97
85
98
## Learning FastJ
86
-
87
99
There will likely be a small wiki added for this game engine at a later time. For now, you'll want to check out [the example projects][FastJ-Example] for getting started with FastJ.
88
100
89
101
From there, explore the example code, play around with it, and read the [API documentation][Javadoc] to get a better understanding of FastJ.
90
102
103
+
91
104
## Contributing to FastJ
92
105
Plan on contributing to the repository? Great! Be sure to read over the [contribution guidelines][Contributing-Guidelines].
93
106
107
+
94
108
### Building FastJ
95
109
You'll need a few things in order to work on the repository:
96
110
-[Git][Git-Link]
97
111
-[Java 11][AdoptOpenJDK-Java11-Link]
98
112
- (optional, but highly recommended!) A decent understanding of how to use [Gradle][Gradle-Link].
99
113
**Installation of Gradle is not required -- the project supplies the Gradle tools already.**
100
-
- For reference, this project currently makes use of Gradle 6.7.1.
114
+
- For reference, this project currently makes use of Gradle 7.1.1.
101
115
102
116
Once you have what you need, follow these simple steps:
103
117
- Clone the FastJ repository.
@@ -129,6 +143,9 @@ This repository is licensed under the [MIT License][MIT-License].
129
143
[MacOS-Build-Action]: https://github.com/fastjengine/FastJ/actions?query=workflow%3ABuild-MacOS"Mac OS Build Status"
0 commit comments