Reorganize project, add custom linter (#42)

The first major refactor of this project.

- Files have been reorganized to match Java Edition b1.2 and 1.14.4 locations
- GitHub Actions workflows have been added to verify compilation, clang-format, and linter
- `tools/lint.py` has been added, conforming some stylistic choices across the repo
- Current lint checks:
- - void params: `(void);` is not allowed, linter replaces with `()`
- - consistent float literals: `.f` is not allowed, linter replaces with `.0f`
- - newline at end of file
- - absolute include paths, newline after last include
- - `#pragma once` at the start of headers, newline after pragma
- - no written `virtual` if a virtual function is overriden
- - includes are placed at the top of a source file

Current progress: **6.975%**

4036/57867 functions decompiled

Author: GRAnimated

.clang-format

@@ -1,10 +1,10 @@
 ---
-Language:        Cpp
+Language: Cpp
 AccessModifierOffset: -4
 AlignAfterOpenBracket: Align
 AlignConsecutiveAssignments: false
 AlignConsecutiveDeclarations: false
-AlignOperands:   true
+AlignOperands: true
 AlignTrailingComments: true
 AllowAllParametersOfDeclarationOnNextLine: true
 AllowShortBlocksOnASingleLine: Never
@@ -22,21 +22,21 @@ BreakBeforeBinaryOperators: All
 BreakBeforeBraces: Attach
 BreakBeforeTernaryOperators: false
 BreakConstructorInitializersBeforeComma: false
-ColumnLimit:     110
-CommentPragmas:  '^ (IWYU pragma:|NOLINT)'
+ColumnLimit: 110
+CommentPragmas: "^ (IWYU pragma:|NOLINT)"
 ConstructorInitializerAllOnOneLineOrOnePerLine: false
 ConstructorInitializerIndentWidth: 4
 ContinuationIndentWidth: 4
 Cpp11BracedListStyle: true
 DerivePointerAlignment: false
-DisableFormat:   false
-ForEachMacros:   []
+DisableFormat: false
+ForEachMacros: []
 IndentCaseLabels: false
-IndentWidth:     4
+IndentWidth: 4
 IndentWrappedFunctionNames: false
 KeepEmptyLinesAtTheStartOfBlocks: false
-MacroBlockBegin: ''
-MacroBlockEnd:   ''
+MacroBlockBegin: ""
+MacroBlockEnd: ""
 MaxEmptyLinesToKeep: 1
 NamespaceIndentation: None
 ObjCBlockIndentWidth: 4
@@ -50,40 +50,22 @@ PenaltyExcessCharacter: 1000000
 PenaltyReturnTypeOnItsOwnLine: 60
 PointerAlignment: Left
 QualifierAlignment: Left
-ReflowComments:  true
+ReflowComments: true
 SpaceAfterCStyleCast: false
 SpaceBeforeAssignmentOperators: true
 SpaceBeforeParens: ControlStatements
 SpaceInEmptyParentheses: false
 SpacesBeforeTrailingComments: 2
-SpacesInAngles:  false
+SpacesInAngles: false
 SpacesInContainerLiterals: true
 SpacesInCStyleCastParentheses: false
 SpacesInParentheses: false
 SpacesInSquareBrackets: false
 Standard: c++17
-TabWidth:        4
-UseTab:          Never
+TabWidth: 4
+UseTab: Never
 WhitespaceSensitiveMacros: []
 
 SortIncludes: true
 IncludeBlocks: Preserve
 IncludeIsMainRegex: '([-_a-zA-Z0-9]+)\.(h|hpp)'
-IncludeCategories:
-  - Regex: '".*types\.h"'
-    Priority: 1
-  - Regex: '^"4J_Libraries_Source/'
-    Priority: 2
-  - Regex: '^"Minecraft\.Client/'
-    Priority: 3
-  - Regex: '^"Minecraft\.Nbt/'
-    Priority: 4
-  - Regex: '^"Minecraft\.Server/'
-    Priority: 5
-  - Regex: '^"Minecraft\.World/'
-    Priority: 6
-  - Regex: '^"PlatformLibraries_Source/'
-    Priority: 7
-  - Regex: '.*'
-    Priority: 8
-...

.github/workflows/lint.yml

@@ -0,0 +1,26 @@
+name: lint
+on: [push, pull_request]
+jobs:
+  clang-format:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: DoozyX/clang-format-lint-action@v0.20
+      with:
+        source: 'src'
+        clangFormatVersion: 20
+  custom-lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Set up python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.13'
+        cache: 'pip'
+    - name: Set up python package dependencies
+      run: pip install pyyaml
+    - name: Run custom code styling checks
+      run: python3 tools/lint.py

.github/workflows/test-compile.yml

@@ -0,0 +1,34 @@
+# Based on https://raw.githubusercontent.com/MonsterDruide1/OdysseyDecomp
+
+name: testcompile
+on: [push, pull_request]
+
+jobs:
+  test_compile:
+    runs-on: ubuntu-24.04
+    steps:
+    - name: Check out project
+      uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Set up dependencies
+      run: |
+        sudo apt update && sudo apt install -y ninja-build cmake ccache clang curl
+        wget http://archive.ubuntu.com/ubuntu/pool/universe/n/ncurses/libtinfo5_6.3-2_amd64.deb && sudo dpkg -i libtinfo5_6.3-2_amd64.deb && rm -f libtinfo5_6.3-2_amd64.deb
+    - name: Set up python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.13'
+        cache: 'pip'
+    - name: Set up python package dependencies
+      run: pip install toml
+    - name: Set up cache for toolchain
+      uses: actions/cache@v4
+      with:
+        key: clang-401
+        path: |
+          toolchain/clang-4.0.1
+    - name: Run simplified setup
+      run: python3 tools/setup.py --project
+    - name: Build project
+      run: python3 tools/build.py

CMakeLists.txt

@@ -38,6 +38,10 @@ set(NN_SDK_PATCH 1)
 set(NN_SDK_TYPE "Release")
 
 target_include_directories(mcswitch PRIVATE src)
+target_include_directories(mcswitch PRIVATE src/Minecraft.Client)
+target_include_directories(mcswitch PRIVATE src/Minecraft.World)
+target_include_directories(mcswitch PRIVATE src/4JLibraries_Source)
+target_include_directories(mcswitch PRIVATE src/PlatformLibraries_Source)
 target_include_directories(mcswitch PUBLIC lib/nnheaders/include)
 
 target_include_directories(mcswitch PUBLIC lib/stb_image)