feat: add checkstyle linter and github actions

Author: martinnicolas

.github/workflows/lint.yml

@@ -0,0 +1,22 @@
+name: Lint
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  checkstyle:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: '21'
+
+      - uses: gradle/actions/setup-gradle@v4
+
+      - run: chmod +x gradlew
+      - run: ./gradlew checkstyleMain checkstyleTest

README.md

@@ -1,13 +1,16 @@
-# CivilWar
+# Civil War
 
 [![Build](https://github.com/martinnicolas/CivilWar/actions/workflows/build.yml/badge.svg)](https://github.com/martinnicolas/CivilWar/actions/workflows/build.yml)
 
+[![Lint](https://github.com/martinnicolas/CivilWar/actions/workflows/lint.yml/badge.svg)](https://github.com/martinnicolas/CivilWar/actions/workflows/lint.yml)
+
 3D Game, FPS (First Person Shooter)
 
 # Requirements
 
-  + JMonkeyEngine 3.8.1 Stable
-  + JDK 21
+  + Java 21
+  + [jMonkeyEngine 3.8.1 Stable](https://jmonkeyengine.org/)
+  + Gradle
 
 <p align="center">
 <img src="https://user-images.githubusercontent.com/5104496/61678559-8c1b7080-acd9-11e9-9828-932e21c7c888.png" alt="CivilWar1" width="350" height="200"/> <img src="https://user-images.githubusercontent.com/5104496/61678611-bc630f00-acd9-11e9-8350-4997ef8ba1d1.png" alt="CivilWar3" width="350" height="200"/>

build.gradle

@@ -1,6 +1,7 @@
 plugins {
     id 'java'
     id 'application'
+    id 'checkstyle'
 }
 
 group 'com.mygame'
@@ -93,3 +94,7 @@ java {
 wrapper {
     gradleVersion = '8.6'
 }
+
+checkstyle {
+    toolVersion = '10.26.1'
+}

config/checkstyle/checkstyle.xml

@@ -0,0 +1,21 @@
+<!DOCTYPE module PUBLIC
+          "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+          "https://checkstyle.org/dtds/configuration_1_3.dtd">
+
+<module name="Checker">
+    <property name="charset" value="UTF-8"/>
+
+    <module name="TreeWalker">
+        <module name="UnusedImports"/>
+        <module name="AvoidStarImport"/>
+        <module name="NeedBraces"/>
+    	<module name="ConstantName"/>
+	<module name="ModifierOrder"/>
+        <module name="EmptyBlock"/>
+        <module name="FallThrough"/>
+        <module name="ModifierOrder"/>
+        <module name="RedundantImport"/>
+        <module name="WhitespaceAfter"/>
+        <module name="WhitespaceAround"/>
+    </module>
+</module>

src/main/java/com/mygame/characters/Player.java

@@ -33,7 +33,7 @@
  *
  * @author martin
  */
-public class Player implements ActionListener{
+public class Player implements ActionListener {
 
     private Vector3f walkDirection = Vector3f.ZERO;
     private SimpleApplication app;
@@ -87,7 +87,7 @@ private void setUpProperties() {
      * Setup player weapon
      */
     private void setUpPlayerWeapon() {
-        AK47Weapon ak47 = new AK47Weapon(this.getApp().getAssetManager(), new Vector3f(-1f,-1.1f, 2f));
+        AK47Weapon ak47 = new AK47Weapon(this.getApp().getAssetManager(), new Vector3f(-1f, -1.1f, 2f));
         ak47.getSpatial().setLocalRotation(new Quaternion(0f, -1f, 0f, 1f));        
         //Create camera node for weapon spatial
         CameraNode cameraNode = new CameraNode("camera_node", this.getApp().getCamera());

src/main/java/com/mygame/controls/TerrainTrackControl.java

@@ -20,8 +20,8 @@
  */
 public class TerrainTrackControl extends AbstractControl {
 
-    private final Ray ray = new Ray(Vector3f.ZERO.clone(), new Vector3f(0,-1,0));
-    private final Vector3f up = new Vector3f(0, 50 , 0);
+    private final Ray ray = new Ray(Vector3f.ZERO.clone(), new Vector3f(0, -1, 0));
+    private final Vector3f up = new Vector3f(0, 50, 0);
     private final CollisionResults results = new CollisionResults();
     private final float offset = 0.1745207f;
     private Spatial terrain;
@@ -40,16 +40,16 @@ protected void controlUpdate(float tpf) {
             terrain.collideWith(ray, results);
             for (CollisionResult collisionResult : results) {
                 if (isTerrain(collisionResult.getGeometry())) {
-                    Vector3f loc = collisionResult.getContactPoint();
-                    spatial.setLocalTranslation(spatial.getLocalTranslation().setY(loc.getY() - offset));
+                    Vector3f location = collisionResult.getContactPoint();
+                    spatial.setLocalTranslation(spatial.getLocalTranslation().setY(location.getY() - offset));
                     return;
                 }
             }
         }
     }
 
     private boolean isTerrain(Spatial spat) {
-        while(true) {
+        while (true) {
             if (spat == null) {
                 return false;
             } else if (spat.getName().contains("terrain")) {

src/main/java/com/mygame/levels/Level.java

@@ -231,8 +231,8 @@ public void removeSettings() {
             this.getAudioNode().removeFromParent();
         }
         ViewPort viewPort = this.getApp().getViewPort();
-        for(SceneProcessor processor: viewPort.getProcessors()){
-            if(processor instanceof FilterPostProcessor filterPostProcessor){
+        for (SceneProcessor processor: viewPort.getProcessors()) {
+            if (processor instanceof FilterPostProcessor filterPostProcessor) {
                 filterPostProcessor.removeAllFilters();
             }
             viewPort.removeProcessor(processor);

src/main/java/com/mygame/levels/Level1.java

@@ -35,7 +35,6 @@
 import com.mygame.bonuses.AmmoBonus;
 import com.mygame.bonuses.HealthBonus;
 import com.mygame.characters.Player;
-import com.mygame.controls.PlayerHUDControl;
 
 /**
  *
@@ -376,7 +375,7 @@ private void pickBonus(Spatial bonusSpatial) {
         if (bonusSpatial == null) { return; }
 
         RigidBodyControl spatialControl = bonusSpatial.getControl(RigidBodyControl.class);
-        if(spatialControl != null && spatialControl.isEnabled()) {
+        if (spatialControl != null && spatialControl.isEnabled()) {
             this.getPlayer().plusPickedBonus(bonusSpatial);
             spatialControl.setEnabled(false);
             this.getBulletAppState().getPhysicsSpace().remove(spatialControl);

src/main/java/com/mygame/screens/PauseScreen.java

@@ -20,7 +20,7 @@
  *
  * @author martin
  */
-public class PauseScreen extends AbstractScreen implements ScreenController{
+public class PauseScreen extends AbstractScreen implements ScreenController {
 
     private Level level;
     private Element popUpExit;

src/main/java/com/mygame/screens/StartScreen.java

@@ -26,7 +26,7 @@ public class StartScreen extends AbstractScreen implements ScreenController {
     @Override
     public void initialize(AppStateManager stateManager, Application app) {
         super.initialize(stateManager, app); //To change body of generated methods, choose Tools | Templates.
-        this.setApp((Main)app);
+        this.setApp((Main) app);
         this.setAudioNode(new AudioNode(this.getApp().getAssetManager(), "Sounds/Music/ambientmain_0.ogg", AudioData.DataType.Stream));
         this.getAudioNode().setName("audio_start_screen");
         this.getAudioNode().setLooping(true);  // activate continuous playing