Skip to content

Commit b6d7933

Browse files
committed
initial commit
0 parents  commit b6d7933

File tree

13 files changed

+499
-0
lines changed

13 files changed

+499
-0
lines changed

.gitignore

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Ignore Gradle project-specific cache directory
2+
.gradle/
3+
4+
# Ignore build output directories
5+
build/
6+
out/
7+
8+
# Ignore metadata
9+
meta/
10+
11+
# Ignore sandbox testing grounds
12+
sandbox/
13+
14+
# Ignore project files
15+
.idea/
16+
17+
# Ignore important information
18+
gradle.properties
19+
20+
# The next part was created by: https://www.toptal.com/developers/gitignore/api/java
21+
22+
### Java ###
23+
# Compiled class file
24+
*.class
25+
26+
# Log files
27+
*.log
28+
29+
# BlueJ files
30+
*.ctxt
31+
32+
# Mobile Tools for Java (J2ME)
33+
.mtj.tmp/
34+
35+
# Package Files
36+
*.jar
37+
# except gradle-wrapper
38+
!gradle-wrapper.jar
39+
*.war
40+
*.nar
41+
*.ear
42+
*.zip
43+
*.tar.gz
44+
*.rar
45+
46+
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
47+
hs_err_pid*
48+
49+

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# FastJ Java Template Program
2+
3+
## How to Access
4+
5+
- Clone the repository `git clone https://github.com/lucasstarsz/fastj-java-template`
6+
- Or download from https://github.com/lucasstarsz/fastj-java-template/releases/latest
7+
8+
9+
## Running the Program
10+
11+
1. Build the program:
12+
```bash
13+
./gradlew build
14+
```
15+
2. Run the template program:
16+
```bash
17+
./gradlew run
18+
```
19+
20+
21+
## Distributing as Executable
22+
23+
1. Build the program:
24+
```bash
25+
./gradlew build
26+
```
27+
2. Create the executable:
28+
```bash
29+
./gradlew jpackage
30+
```
31+
32+
_Having trouble using `gradlew`? Read [this][Terminals Are Different]._
33+
34+
35+
## Configuring the Project Variables
36+
37+
Please view the [build.gradle](build.gradle) file -- it contains general instructions for modifying the base example.
38+
39+
40+
[Terminals Are Different]: https://gist.github.com/lucasstarsz/9bbc306f8655b916367d557043e498ad "Terminals Access Files Differently"
41+

build.gradle

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
/*
2+
* FastJ Java Template Build Script
3+
*
4+
* Thank you for choosing FastJ! This is a Gradle-based build script that will help you manage your
5+
* project with ease. */
6+
7+
plugins {
8+
/* To begin with, Gradle needs the 'java' plugin so that it knows this is a Java project. */
9+
id 'java'
10+
/* This template is for an application -- we'll need this plugin to make sure Gradle knows
11+
* this, too. */
12+
id 'application'
13+
/* To create distributable files for your game, we use this jlink plugin. */
14+
id 'org.beryx.jlink' version '2.24.0'
15+
}
16+
17+
/* Your project's group name goes here.
18+
* This should be a domain name you own.
19+
* If you don't own a domain, don't worry! You can always set this to 'io.github.yourgithubusername'. */
20+
group('io.github.yourgithubusername')
21+
22+
/* Your project's version.
23+
* When you want to distribute a new version of your project, always make sure to update the
24+
* project version. */
25+
version('0.0.1')
26+
27+
/* Your project's description.
28+
* Give a one or two sentence description of your project -- if you publish it somewhere, you'll be
29+
* able to use it. */
30+
description('A Java Template for FastJ.')
31+
32+
/* Here, we specify where the main entrypoint of the project.
33+
* Feel free to change these as needed. */
34+
application.getMainClass().set('tech.fastj.template.Game')
35+
application.mainModule.set('fastj.templategame')
36+
37+
38+
/* When you add a dependency on another project (like FastJ), you need to add specify where the
39+
* dependencies are coming from!
40+
* FastJ is hosted on Maven Central, so we'll add it here. */
41+
repositories.maven {
42+
url('https://oss.sonatype.org/content/repositories/snapshots/')
43+
}
44+
repositories.mavenCentral()
45+
46+
/* The dependency for FastJ, the game engine this template depends on. */
47+
dependencies.implementation('io.github.lucasstarsz.fastj:fastj-library:1.5.0-SNAPSHOT')
48+
49+
50+
/* JLink is used to configure the executables and other distributions for your project. */
51+
jlink {
52+
53+
options.addAll(
54+
'--strip-debug',
55+
'--compress', '2',
56+
'--no-header-files',
57+
'--no-man-pages'
58+
)
59+
60+
launcher {
61+
name = project.name
62+
noConsole = true
63+
}
64+
65+
jpackage {
66+
67+
/* Use this to define the path of the icons for your project. */
68+
def iconPath = 'project-resources/fastj_icon'
69+
def currentOs = org.gradle.internal.os.OperatingSystem.current()
70+
71+
installerOptions += [
72+
'--description', project.description,
73+
'--vendor', project.group,
74+
'--app-version', project.version
75+
]
76+
77+
78+
if (currentOs.windows) {
79+
installerType = 'msi'
80+
icon = "${iconPath}.ico"
81+
installerOptions += ['--win-per-user-install', '--win-dir-chooser', '--win-shortcut']
82+
} else if (currentOs.linux) {
83+
installerType = 'deb'
84+
icon = "${iconPath}.png"
85+
installerOptions += ['--linux-shortcut']
86+
} else if (currentOs.macOsX) {
87+
installerType = 'pkg'
88+
icon = "${iconPath}.icns"
89+
installerOptions += ['--mac-package-name', project.name]
90+
}
91+
}
92+
}
93+

gradle/wrapper/gradle-wrapper.jar

57.8 KB
Binary file not shown.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
distributionBase=GRADLE_USER_HOME
2+
distributionPath=wrapper/dists
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-7.1.1-bin.zip
4+
zipStoreBase=GRADLE_USER_HOME
5+
zipStorePath=wrapper/dists

gradlew

Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,185 @@
1+
#!/usr/bin/env sh
2+
3+
#
4+
# Copyright 2015 the original author or authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#
18+
19+
##############################################################################
20+
##
21+
## Gradle start up script for UN*X
22+
##
23+
##############################################################################
24+
25+
# Attempt to set APP_HOME
26+
# Resolve links: $0 may be a link
27+
PRG="$0"
28+
# Need this for relative symlinks.
29+
while [ -h "$PRG" ] ; do
30+
ls=`ls -ld "$PRG"`
31+
link=`expr "$ls" : '.*-> \(.*\)$'`
32+
if expr "$link" : '/.*' > /dev/null; then
33+
PRG="$link"
34+
else
35+
PRG=`dirname "$PRG"`"/$link"
36+
fi
37+
done
38+
SAVED="`pwd`"
39+
cd "`dirname \"$PRG\"`/" >/dev/null
40+
APP_HOME="`pwd -P`"
41+
cd "$SAVED" >/dev/null
42+
43+
APP_NAME="Gradle"
44+
APP_BASE_NAME=`basename "$0"`
45+
46+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
47+
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
48+
49+
# Use the maximum available, or set MAX_FD != -1 to use that value.
50+
MAX_FD="maximum"
51+
52+
warn () {
53+
echo "$*"
54+
}
55+
56+
die () {
57+
echo
58+
echo "$*"
59+
echo
60+
exit 1
61+
}
62+
63+
# OS specific support (must be 'true' or 'false').
64+
cygwin=false
65+
msys=false
66+
darwin=false
67+
nonstop=false
68+
case "`uname`" in
69+
CYGWIN* )
70+
cygwin=true
71+
;;
72+
Darwin* )
73+
darwin=true
74+
;;
75+
MINGW* )
76+
msys=true
77+
;;
78+
NONSTOP* )
79+
nonstop=true
80+
;;
81+
esac
82+
83+
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
84+
85+
86+
# Determine the Java command to use to start the JVM.
87+
if [ -n "$JAVA_HOME" ] ; then
88+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
89+
# IBM's JDK on AIX uses strange locations for the executables
90+
JAVACMD="$JAVA_HOME/jre/sh/java"
91+
else
92+
JAVACMD="$JAVA_HOME/bin/java"
93+
fi
94+
if [ ! -x "$JAVACMD" ] ; then
95+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
96+
97+
Please set the JAVA_HOME variable in your environment to match the
98+
location of your Java installation."
99+
fi
100+
else
101+
JAVACMD="java"
102+
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
103+
104+
Please set the JAVA_HOME variable in your environment to match the
105+
location of your Java installation."
106+
fi
107+
108+
# Increase the maximum file descriptors if we can.
109+
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
110+
MAX_FD_LIMIT=`ulimit -H -n`
111+
if [ $? -eq 0 ] ; then
112+
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
113+
MAX_FD="$MAX_FD_LIMIT"
114+
fi
115+
ulimit -n $MAX_FD
116+
if [ $? -ne 0 ] ; then
117+
warn "Could not set maximum file descriptor limit: $MAX_FD"
118+
fi
119+
else
120+
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
121+
fi
122+
fi
123+
124+
# For Darwin, add options to specify how the application appears in the dock
125+
if $darwin; then
126+
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
127+
fi
128+
129+
# For Cygwin or MSYS, switch paths to Windows format before running java
130+
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
131+
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
132+
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
133+
134+
JAVACMD=`cygpath --unix "$JAVACMD"`
135+
136+
# We build the pattern for arguments to be converted via cygpath
137+
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
138+
SEP=""
139+
for dir in $ROOTDIRSRAW ; do
140+
ROOTDIRS="$ROOTDIRS$SEP$dir"
141+
SEP="|"
142+
done
143+
OURCYGPATTERN="(^($ROOTDIRS))"
144+
# Add a user-defined pattern to the cygpath arguments
145+
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
146+
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
147+
fi
148+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
149+
i=0
150+
for arg in "$@" ; do
151+
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
152+
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
153+
154+
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
155+
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
156+
else
157+
eval `echo args$i`="\"$arg\""
158+
fi
159+
i=`expr $i + 1`
160+
done
161+
case $i in
162+
0) set -- ;;
163+
1) set -- "$args0" ;;
164+
2) set -- "$args0" "$args1" ;;
165+
3) set -- "$args0" "$args1" "$args2" ;;
166+
4) set -- "$args0" "$args1" "$args2" "$args3" ;;
167+
5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
168+
6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
169+
7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
170+
8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
171+
9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
172+
esac
173+
fi
174+
175+
# Escape application args
176+
save () {
177+
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
178+
echo " "
179+
}
180+
APP_ARGS=`save "$@"`
181+
182+
# Collect all arguments for the java command, following the shell quoting and substitution rules
183+
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
184+
185+
exec "$JAVACMD" "$@"

0 commit comments

Comments
 (0)