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.
16
17
18
+
17
19
## Disclaimer
18
20
**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)
[The example projects][FastJ-Example] are a great way to start learning how to use FastJ.
57
-
58
-
### Wiki
59
-
We are currently working on a [wiki][FastJ-Wiki] for the engine. It'll guide through the basics on how to start a project.
60
-
61
-
### Documentation
62
-
From there, explore the example code, play around with it, and read the [API documentation][Javadoc] to get a better understanding of FastJ.
63
-
64
-
65
-
## Adding FastJ to your project without a template
48
+
## Adding FastJ to a Project
66
49
This library can be found in the following places:
50
+
-[jitpack.io][Jitpack.IO], as a dependency.
67
51
-[Maven Central][Maven-Central], as a dependency or as a jarfile.
68
52
- The [Releases][Releases] section of this repository.
69
53
54
+
70
55
### Adding the Dependency
71
-
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**.
56
+
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**.
72
57
73
58
A few common dependencies are provided below:
74
59
75
60
-**Gradle**
76
-
- Groovy:
77
-
```groovy
78
-
implementation 'io.github.lucasstarsz.fastj:fastj-library:[latest version here]'
79
-
```
80
-
- Kotlin:
81
-
```kotlin
82
-
implementation("io.github.lucasstarsz.fastj:fastj-library:[latest version here]")
83
-
```
61
+
- Groovy:
62
+
```groovy
63
+
repositories.maven {
64
+
url('https://jitpack.io')
65
+
}
66
+
67
+
dependencies.implementation('com.github.fastjengine:FastJ:[latest version here]')
68
+
```
69
+
- Kotlin:
70
+
```kotlin
71
+
repositories.maven {
72
+
setUrl("https://jitpack.io")
73
+
}
74
+
75
+
dependencies.implementation("com.github.fastjengine:FastJ:[latest version here]")
76
+
```
84
77
- **Maven**
85
78
```xml
79
+
<repository>
80
+
<id>jitpack.io</id>
81
+
<url>https://jitpack.io</url>
82
+
</repository>
83
+
86
84
<dependency>
87
-
<groupId>io.github.lucasstarsz.fastj</groupId>
88
-
<artifactId>fastj-library</artifactId>
85
+
<groupId>com.github.fastjengine</groupId>
86
+
<artifactId>FastJ</artifactId>
89
87
<version>[latest version here]</version>
90
88
</dependency>
91
89
```
92
-
-**Apache Ivy**
93
-
```xml
94
-
<dependencyorg="io.github.lucasstarsz.fastj"name="fastj-library"rev="[latest version here]" />
95
-
```
90
+
91
+
92
+
## Learning FastJ
93
+
There are many different ways to learn FastJ -- namely the API documentation, the examples, and the tutorials on the main website.
94
+
95
+
96
+
### Tutorials
97
+
[FastJ provides article tutorials][FastJ-Tutorials] on its website to accommodate as many types of developers as possible. From beginners to experts, the website tutorials are written to give enough information to satisfy anyone willing to learn!
98
+
99
+
100
+
### Code Examples
101
+
[Explore FastJ's code examples][FastJ-Examples] to see the different ways FastJ can be used, and all of its features. These come with in-example explanations and easy plug-and-playability to give you the best chance at understanding how FastJ works.
102
+
103
+
104
+
### API Documentation
105
+
[Check out FastJ's documentation][Javadoc] to get a better understanding of the code FastJ provides to improve your game-making experience.
96
106
97
107
98
108
## Contributing to FastJ
99
-
Plan on contributing to the repository? Great! Be sure to read over the [contribution guidelines][Contributing-Guidelines].
109
+
Plan on contributing to the repository? Great! Be sure to read over the [contribution guidelines][Contributing-Guidelines], and read on to discover how to get started.
110
+
100
111
101
112
### Building FastJ
102
113
You'll need a few things in order to work on the repository:
103
114
-[Git][Git-Link]
104
115
-[Java 11][AdoptOpenJDK-Java11-Link]
105
116
- (optional, but highly recommended!) A decent understanding of how to use [Gradle][Gradle-Link].
106
117
**Installation of Gradle is not required -- the project supplies the Gradle tools already.**
107
-
- For reference, this project currently makes use of Gradle 7.1.1.
118
+
- For reference, this project currently makes use of Gradle 7.1.1.
108
119
109
120
Once you have what you need, follow these simple steps:
0 commit comments