Skip to content

Commit a48d1c5

Browse files
committed
Fixed Documentation Typos
1 parent 01853cf commit a48d1c5

47 files changed

Lines changed: 1919 additions & 559 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/j3o-scan.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: J3O Scan
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- '**/*.j3o'
7+
- 'jme3-desktop/src/main/resources/com/jme3/system/j3o-baseline.txt'
8+
- 'jme3-desktop/src/main/java/com/jme3/system/J3OScanner.java'
9+
- 'jme3-desktop/build.gradle'
10+
- '.github/workflows/j3o-scan.yml'
11+
push:
12+
branches:
13+
- master
14+
- main
15+
paths:
16+
- '**/*.j3o'
17+
- 'jme3-desktop/src/main/resources/com/jme3/system/j3o-baseline.txt'
18+
- 'jme3-desktop/src/main/java/com/jme3/system/J3OScanner.java'
19+
- 'jme3-desktop/build.gradle'
20+
- '.github/workflows/j3o-scan.yml'
21+
22+
permissions:
23+
contents: read
24+
25+
jobs:
26+
scan-j3o:
27+
name: Validate J3O assets
28+
runs-on: ubuntu-latest
29+
steps:
30+
- name: Checkout repository
31+
uses: actions/checkout@v4
32+
33+
- name: Set up Java
34+
uses: actions/setup-java@v4
35+
with:
36+
distribution: temurin
37+
java-version: '17'
38+
39+
- name: Scan J3O assets
40+
run: ./gradlew :jme3-desktop:scanJ3O --console=plain

.github/workflows/main.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ jobs:
7171
distribution: 'temurin'
7272
java-version: '21'
7373
- name: Validate the Gradle wrapper
74-
uses: gradle/actions/wrapper-validation@v5.0.2
74+
uses: gradle/actions/wrapper-validation@v6.0.1
7575
- name: Run Checkstyle
7676
run: |
7777
./gradlew checkstyleMain checkstyleTest --console=plain --stacktrace
@@ -98,7 +98,7 @@ jobs:
9898
distribution: 'temurin'
9999
java-version: '21'
100100
- name: Validate the Gradle wrapper
101-
uses: gradle/actions/wrapper-validation@v5.0.2
101+
uses: gradle/actions/wrapper-validation@v6.0.1
102102
- name: Run SpotBugs
103103
run: |
104104
./gradlew -PenableSpotBugs=true spotbugsMain spotbugsTest --console=plain --stacktrace
@@ -135,7 +135,7 @@ jobs:
135135
echo "MESA_LOADER_DRIVER_OVERRIDE=$MESA_LOADER_DRIVER_OVERRIDE"
136136
echo "GALLIUM_DRIVER=$GALLIUM_DRIVER"
137137
- name: Validate the Gradle wrapper
138-
uses: gradle/actions/wrapper-validation@v5.0.2
138+
uses: gradle/actions/wrapper-validation@v6.0.1
139139
- name: Test with Gradle Wrapper
140140
run: |
141141
./gradlew :jme3-screenshot-test:screenshotTest
@@ -176,7 +176,7 @@ jobs:
176176
fetch-depth: 1
177177

178178
- name: Validate the Gradle wrapper
179-
uses: gradle/actions/wrapper-validation@v5.0.2
179+
uses: gradle/actions/wrapper-validation@v6.0.1
180180

181181
- name: Build
182182
run: |
@@ -218,7 +218,7 @@ jobs:
218218
cmake --version
219219
220220
- name: Validate the Gradle wrapper
221-
uses: gradle/actions/wrapper-validation@v5.0.2
221+
uses: gradle/actions/wrapper-validation@v6.0.1
222222

223223
- name: Build
224224
run: |
@@ -282,7 +282,7 @@ jobs:
282282
path: jme3-ios-native/template/META-INF/robovm/ios/libs/jme3-ios-native.xcframework
283283

284284
- name: Validate the Gradle wrapper
285-
uses: gradle/actions/wrapper-validation@v5.0.2
285+
uses: gradle/actions/wrapper-validation@v6.0.1
286286
- name: Build Engine
287287
shell: bash
288288
run: |

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,22 @@ You can restore the project to a pristine state:
110110
+ using Bash or Fish or PowerShell or Zsh: `./gradlew clean`
111111
+ using Windows Command Prompt: `.\gradlew clean`
112112

113+
114+
## Running examples
115+
116+
The engine comes with some examples that you can run with:
117+
118+
```bash
119+
./gradlew runExamples
120+
```
121+
122+
You can optionally use the `-Pexample` property to specify an example to start without the need to navigate the test chooser, e.g.:
123+
124+
```bash
125+
./gradlew runExamples -Pexample=jme3test.light.pbr.TestPBRSimple
126+
```
127+
128+
113129
## Running Tests
114130

115131
To run all tests and generate a JaCoCo code coverage report, run the `testCodeCoverageReport` Gradle task. To avoid the generation of the report, use the `test` task instead.

gradle.properties

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ buildJavaDoc = true
1919
buildNativeProjects = false
2020
buildAndroidExamples = false
2121

22-
buildForPlatforms = Linux64,Linux32,Windows64,Windows32,Mac64
2322
# Forcefully ignore prebuilt libraries
2423
skipPrebuildLibraries=false
2524

jme3-android-native/openalsoft.gradle

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,12 +86,10 @@ def ndkPath = new File(rootProject.ndkCommandPath).getParent()
8686
def cmakeToolchain = "${ndkPath}/build/cmake/android.toolchain.cmake"
8787

8888
// 1) list your ABIs here
89-
def openalAbis = [
90-
"armeabi-v7a",
91-
"arm64-v8a",
92-
"x86",
93-
"x86_64"
94-
]
89+
def openalAbis = [
90+
"arm64-v8a",
91+
"x86_64"
92+
]
9593

9694
// 2) for each ABI, register a configure/build pair
9795
openalAbis.each { abi ->
@@ -170,7 +168,7 @@ task buildOpenAlSoftNativeLib(type: Exec) {
170168
// the cmake-build-<ABI> folders.
171169
args(
172170
// let ndk-build know which ABIs to build for
173-
"APP_ABI=armeabi-v7a,arm64-v8a,x86,x86_64",
171+
"APP_ABI=arm64-v8a,x86_64",
174172

175173
// pass in the path to the CMake output root
176174
"OPENALSOFT_BUILD_ROOT=${openalsoftBuildDir}/${openALSoftFolder}",

jme3-android-native/src/native/jme_bufferallocator/Application.mk

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,8 @@
3333
# Created by pavl_g on 5/17/22.
3434
# For more : https://developer.android.com/ndk/guides/application_mk.
3535
##
36-
APP_PLATFORM := android-19
36+
APP_PLATFORM := android-21
3737
# change this to 'debug' to see android logs
3838
APP_OPTIM := release
39-
APP_ABI := armeabi-v7a,arm64-v8a,x86,x86_64
39+
APP_ABI := arm64-v8a,x86_64
4040
APP_SUPPORT_FLEXIBLE_PAGE_SIZES := true
41-
Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
APP_PLATFORM := android-9
1+
APP_PLATFORM := android-21
22
APP_OPTIM := release
3-
APP_ABI := armeabi-v7a,arm64-v8a,x86,x86_64
3+
APP_ABI := arm64-v8a,x86_64
44
APP_SUPPORT_FLEXIBLE_PAGE_SIZES := true
5-

0 commit comments

Comments
 (0)