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: COMPILING.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,8 @@
1
1
# How to Compile FNF:JE
2
2
3
+
> [!TIP]
4
+
> If you want some helpful info about the Gradle tasks (or the framework FNF:JE uses), consider taking a look at [LIBGDX.md](LIBGDX.md)!
5
+
3
6
There are two main ways you can download and compile the game's code: with GitHub Desktop or the terminal.
4
7
5
8
In this guide, we'll use the GitHub Desktop method, since it the most user-friendly experience, which provides you a nice UI and does all the hard stuff for you!
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-40Lines changed: 5 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,49 +62,14 @@ public static
62
62
FunkinSound playSound (String
63
63
path)
64
64
{
65
+
// create da sound object duurrr
65
66
FunkinSound sound =newFunkinSound(path);
67
+
// six seven
66
68
if
67
69
(sound.ID!=-1){ // i have lito have no idea what this does :wilted_flower:
68
-
soundPool.put(sound.ID, sound);
70
+
soundPool.put(sound.ID, sound);// puts da sound in der sound pool :3
69
71
}
70
-
sound.play();
71
-
return sound;
72
+
sound.play();// you already know dawg.
73
+
return sound;// return the sound or whatever
72
74
}
73
75
```
74
-
75
-
# libGDX
76
-
77
-
This is a [libGDX](https://libgdx.com/) project generated with [gdx-liftoff](https://github.com/libgdx/gdx-liftoff).
78
-
79
-
## Platforms
80
-
81
-
FNF:JE is designed to run on multiple different platforms. Below are the different modules that hold the code for each one.
82
-
83
-
-`core`: Main module with the game's logic shared by all platforms. <u>This is where you want to write your source code!</u>
84
-
-`lwjgl3`: Primary desktop platform using [LWJGL3](https://www.lwjgl.org/). This is what launches the desktop versions of the game!
85
-
-`android`: Android mobile platform. <u>This requires the Android SDK, which can be downloaded and configured simply by running the universal [setup file](setup/android_setup.sh)!</u>
86
-
87
-
## Gradle
88
-
89
-
This project uses [Gradle](https://gradle.org/) to manage dependencies.
90
-
The Gradle wrapper was included, so you can run Gradle tasks using `gradlew.bat` or `./gradlew` commands.
91
-
92
-
# Gradle Flags and Tasks
93
-
94
-
-`--continue`: when using this flag, errors will not stop the tasks from running.
95
-
-`--daemon`: thanks to this flag, Gradle daemon will be used to run chosen tasks.
96
-
-`--offline`: when using this flag, cached dependency archives will be used.
97
-
-`--refresh-dependencies`: this flag forces validation of all dependencies. Useful for snapshot versions.
-`build`: builds sources and archives of every project.
100
-
-`cleanEclipse`: removes Eclipse project data.
101
-
-`cleanIdea`: removes IntelliJ project data.
102
-
-`clean`: removes `build` folders, which store compiled classes and built archives.
103
-
-`eclipse`: generates Eclipse project data.
104
-
-`idea`: generates IntelliJ project data.
105
-
-`lwjgl3:jar`: builds the game's runnable jar, which can be found at `lwjgl3/build/libs`.
106
-
-`lwjgl3:run`: starts the desktop version of the game.
107
-
-`test`: runs unit tests (if any).
108
-
109
-
Note that most tasks that are not specific to a single project can be run with `name:` prefix, where the `name` should be replaced with the ID of a specific project.
110
-
For example, `core:clean` removes `build` folder only from the `core` project.
## This is a [libGDX](https://libgdx.com/) project generated with [gdx-liftoff](https://github.com/libgdx/gdx-liftoff).
2
+
3
+
# Platforms
4
+
5
+
FNF:JE is designed to run on multiple different platforms. Below are the different modules that hold the code for each one.
6
+
7
+
-`core`: Main module with the game's logic shared by all platforms. <u>This is where you want to write your source code!</u>
8
+
-`lwjgl3`: Primary desktop platform using [LWJGL3](https://www.lwjgl.org/). <u>This is what launches the desktop versions of the game!</u>
9
+
-`android`: Android mobile platform. <u>This requires the Android SDK, which can be downloaded and configured simply by running the universal [setup file](setup/android_setup.sh)!</u>
10
+
11
+
> [!IMPORTANT]
12
+
> When you install the Android SDK, you need to make sure that either your `ANDROID_HOME` path is configured correctly, or you have a `local.properties` file created with an `sdk.dir` property assigned to your SDK path; otherwise, it won't work!
13
+
14
+
# Gradle
15
+
16
+
This project uses [Gradle](https://gradle.org/) to manage dependencies.
17
+
The Gradle wrapper was included, so you can run Gradle tasks using `gradlew.bat` or `./gradlew` commands.
18
+
19
+
## Flags
20
+
21
+
-`--continue`: when using this flag, errors will not stop the tasks from running.
22
+
-`--daemon`: thanks to this flag, Gradle daemon will be used to run chosen tasks.
23
+
-`--offline`: when using this flag, cached dependency archives will be used.
24
+
-`--refresh-dependencies`: this flag forces validation of all dependencies. Useful for snapshot versions.
-`build`: builds sources and archives of every project.
30
+
-`cleanEclipse`: removes Eclipse project data.
31
+
-`cleanIdea`: removes IntelliJ project data.
32
+
-`clean`: removes `build` folders, which store compiled classes and built archives.
33
+
-`eclipse`: generates Eclipse project data.
34
+
-`idea`: generates IntelliJ project data.
35
+
-`lwjgl3:jar`: builds the game's runnable jar, which can be found at `lwjgl3/build/libs`.
36
+
-`lwjgl3:run`: starts the desktop version of the game.
37
+
-`test`: runs unit tests (if any).
38
+
39
+
Note that most tasks that are not specific to a single project can be run with `name:` prefix, where the `name` should be replaced with the ID of a specific project.
40
+
For example, `core:clean` removes `build` folder only from the `core` project.
0 commit comments