Initial commit

.clang-format

@@ -0,0 +1,18 @@
+---
+BasedOnStyle: Chromium
+ColumnLimit: 100
+SortIncludes: true
+IncludeBlocks: Regroup
+IncludeCategories:
+  - Regex: '^<[a-zA-Z_\-\.]+>'
+    Priority: 1
+  - Regex: '^"[a-zA-Z_\-\.]+"'
+    Priority: 2
+  - Regex: '^(<|")common.*'
+    Priority: 3
+  - Regex: '^"(third-party|fmt|curl).*'
+    Priority: 4
+    SortPriority: 5
+  - Regex: '.*'
+    Priority: 5
+    SortPriority: 4

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+insert_final_newline = true
+charset = utf-8
+
+# https://editorconfig-specification.readthedocs.io/
+# https://docs.microsoft.com/en-us/visualstudio/ide/cpp-editorconfig-properties?view=vs-2019
+[*.{c++,cc,cpp,cxx,h,h++,hh,hpp,hxx,inl,ipp,tlh,tli}]

.gitattributes

@@ -0,0 +1,15 @@
+# Ensure line endings are consistently 'LF'
+* text=auto
+
+third-party/**/* linguist-vendored
+third-party/**/* linguist-generated
+test/decompiler/reference/** linguist-vendored
+# suppress from PR diffs - is just reviewing the same thing twice (if properly added to g_src)
+test/decompiler/reference/** linguist-generated
+goal_src/import/** linguist-vendored
+goal_src/import/** linguist-generated
+*.gc linguist-language=lisp
+*.gd linguist-language=lisp
+*.gs linguist-language=Scheme
+*.gp linguist-language=Scheme
+goal_src/engine/gfx/ocean/ocean-tables.gc linguist-vendored

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Feature Requests and Ideas
+    url: https://github.com/open-goal/jak-project/discussions/new/choose
+    about: Please use the discussion board to bring up feature requests and ideas. If there is interest in them, they can then be converted to an issue(s).
+  - name: Discord Help Channel
+    url: https://discord.gg/dPRCfsju3N
+    about: The best place for general help and asking questions.

.github/ISSUE_TEMPLATE/jak1-bug-report.yml

@@ -0,0 +1,74 @@
+name: "\U0001F41B Jak 1 Bug Report"
+description: Create a bug report for Jak 1.
+labels: ["bug", "jak1"]
+body:
+  - type: checkboxes
+    attributes:
+      label: Acknowledgements
+      description: Take a couple minutes to help our maintainers work faster.
+      options:
+        - label: I have [searched](https://github.com/open-goal/jak-project/issues?q=is%3Aissue+is%3Aopen+label%3Abug+label%3Ajak1+sort%3Aupdated-desc+) for duplicate or closed bug reports
+          required: true
+        - label: I understand that I am supposed to provide my own legitimately obtained copy of the game
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Describe the Bug
+      description: A clear and concise description of what the bug is. You may post screenshots or videos of the bug here.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: How To Reproduce
+      description: Steps to reproduce the behavior. You can also post a video of it here.
+    validations:
+      required: true
+
+  - type: dropdown
+    attributes:
+      label: Does this problem occur on original hardware or PCSX2?
+      description: Some things that may seem like bugs are actually exactly how the original game behaved.
+      options:
+        - Yes, it's unique to OpenGOAL
+        - Didn't check
+        - Not needed, bug is obvious
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A clear and concise description of the expected behavior.
+      placeholder: When I do X, Y should happen.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Environment Information
+      description: "You can upload the [Support Package](https://github.com/open-goal/launcher#asking-for-help) provided by the Launcher here, or you can provide the following information: CPU, GPU, OS Version, OpenGOAL Version (found in the window's title bar)"
+    validations:
+      required: true
+
+  - type: dropdown
+    attributes:
+      label: Game Version
+      options:
+        - NTSC 1.0 (black label)
+        - NTSC Greatest Hits version (red label)
+        - PAL
+        - JP
+    validations:
+      required: true
+
+  - type: dropdown
+    attributes:
+      label: Have you set the game to something other than `60fps`?
+      options:
+        - "No"
+        - "Yes"
+    validations:
+      required: true
+

.github/ISSUE_TEMPLATE/jak2-bug-report.yml

@@ -0,0 +1,74 @@
+name: "\U0001F41B Jak 2 Bug Report"
+description: Create a bug report for Jak 2.
+labels: ["bug", "jak2"]
+body:
+  - type: checkboxes
+    attributes:
+      label: Acknowledgements
+      description: Take a couple minutes to help our maintainers work faster.
+      options:
+        - label: I have [searched](https://github.com/open-goal/jak-project/issues?q=is%3Aissue+is%3Aopen+label%3Abug+label%3Ajak2+sort%3Aupdated-desc+) for duplicate or closed bug reports
+          required: true
+        - label: I understand that I am supposed to provide my own legitimately obtained copy of the game
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Describe the Bug
+      description: A clear and concise description of what the bug is. You may post screenshots or videos of the bug here.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: How To Reproduce
+      description: Steps to reproduce the behavior. You can also post a video of it here.
+    validations:
+      required: true
+
+  - type: dropdown
+    attributes:
+      label: Does this problem occur on original hardware or PCSX2?
+      description: Some things that may seem like bugs are actually exactly how the original game behaved.
+      options:
+        - Yes, it's unique to OpenGOAL
+        - Didn't check
+        - Not needed, bug is obvious
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A clear and concise description of the expected behavior.
+      placeholder: When I do X, Y should happen.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Environment Information
+      description: "You can upload the [Support Package](https://github.com/open-goal/launcher#asking-for-help) provided by the Launcher here, or you can provide the following information: CPU, GPU, OS Version, OpenGOAL Version (found in the window's title bar)"
+    validations:
+      required: true
+
+  - type: dropdown
+    attributes:
+      label: Game Version
+      options:
+        - NTSC 1.0 (black label)
+        - NTSC Greatest Hits version (red label)
+        - PAL
+        - JP
+    validations:
+      required: true
+
+  - type: dropdown
+    attributes:
+      label: Have you set the game to something other than `60fps`?
+      options:
+        - "No"
+        - "Yes"
+    validations:
+      required: true
+

.github/dependabot.yml

@@ -0,0 +1,8 @@
+# Set update schedule for GitHub Actions
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every week
+      interval: "monthly"

.github/scripts/releases/error-code-metadata.json

@@ -0,0 +1,29 @@
+{
+  "4000": {
+    "msg": "Validation Failed: Cannot locate ELF"
+  },
+  "4001": {
+    "msg": "Validation Failed: Game serial missing from valid game database"
+  },
+  "4002": {
+    "msg": "Validation Failed: ELF missing from valid game database"
+  },
+  "4010": {
+    "msg": "Validation Failed: Bad or unexpected ISO contents"
+  },
+  "4011": {
+    "msg": "Validation Failed: Extracted an unexpected amount of files from ISO"
+  },
+  "4020": {
+    "msg": "Validation Failed: ISO Extraction failed, output directory did not contain expected files"
+  },
+  "4030": {
+    "msg": "Decompilation Failed: An error occurred"
+  },
+  "4040": {
+    "msg": "Extraction Failed: Provided game data file was not an ISO file"
+  },
+  "4041": {
+    "msg": "Extraction Failed: Provided game data file was corrupt or has unexpected size"
+  }
+}

.github/scripts/releases/extract_build_unix.sh

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+
+set -e
+
+DEST=${1}
+BIN_SOURCE=${2}
+SOURCE=${3}
+
+mkdir -p $DEST
+
+PREP_BIN="${PREP_BIN:-true}"
+
+if [ "$PREP_BIN" = "true" ]; then
+  cp $BIN_SOURCE/game/gk $DEST
+  cp $BIN_SOURCE/goalc/goalc $DEST
+  cp $BIN_SOURCE/decompiler/extractor $DEST
+
+  chmod +x $DEST/gk
+  chmod +x $DEST/goalc
+  chmod +x $DEST/extractor
+fi
+
+mkdir -p $DEST/data
+mkdir -p $DEST/data/launcher/
+mkdir -p $DEST/data/decompiler/
+mkdir -p $DEST/data/game
+mkdir -p $DEST/data/log
+mkdir -p $DEST/data/game/graphics/opengl_renderer/
+
+cp -r $SOURCE/.github/scripts/releases/error-code-metadata.json $DEST/data/launcher/error-code-metadata.json
+cp -r $SOURCE/decompiler/config $DEST/data/decompiler/
+cp -r $SOURCE/goal_src $DEST/data
+cp -r $SOURCE/game/assets $DEST/data/game/
+cp -r $SOURCE/game/graphics/opengl_renderer/shaders $DEST/data/game/graphics/opengl_renderer
+cp -r $SOURCE/custom_assets $DEST/data

.github/scripts/releases/extract_build_windows.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+set -e
+
+DEST=${1}
+BIN_SOURCE=${2}
+SOURCE=${3}
+
+mkdir -p $DEST
+
+cp $BIN_SOURCE/gk.exe $DEST
+cp $BIN_SOURCE/goalc.exe $DEST
+cp $BIN_SOURCE/extractor.exe $DEST
+
+mkdir -p $DEST/data
+mkdir -p $DEST/data/launcher/
+mkdir -p $DEST/data/decompiler/
+mkdir -p $DEST/data/game
+mkdir -p $DEST/data/log
+mkdir -p $DEST/data/game/graphics/opengl_renderer/
+
+cp -r $SOURCE/.github/scripts/releases/error-code-metadata.json $DEST/data/launcher/error-code-metadata.json
+cp -r $SOURCE/decompiler/config $DEST/data/decompiler/
+cp -r $SOURCE/goal_src $DEST/data
+cp -r $SOURCE/game/assets $DEST/data/game/
+cp -r $SOURCE/game/graphics/opengl_renderer/shaders $DEST/data/game/graphics/opengl_renderer
+cp -r $SOURCE/custom_assets $DEST/data

.github/workflows/architecture/releases.md

@@ -0,0 +1,15 @@
+# Release Process
+
+```mermaid
+sequenceDiagram
+  Project Repo->>Project Repo: New tag created via workflow dispatch
+  Project Repo->>Project Repo: Create a draft release
+  Project Repo->>Project Repo: Run Builds
+  loop Every build we intend to release
+    Project Repo->>Project Repo: Upload Asset to Draft Release
+    opt If All assets have been uploaded
+      Project Repo->>Project Repo: Publish the release
+    end
+  end
+  Launcher Repo->>Project Repo: Pull down latest/pinned release for it's process
+```

.github/workflows/build-matrix.yaml

@@ -0,0 +1,67 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  merge_group: {}
+
+jobs:
+  # Windows
+  build_windows_clang:
+    name: "🖥️ Windows (Clang)"
+    uses: ./.github/workflows/windows-build-clang.yaml
+    if: github.repository == 'OpenGOAL-Mods/OG-Mod-Base'
+    with:
+      cmakePreset: "Release-windows-clang"
+      cachePrefix: ""
+    secrets: inherit
+
+  build_windows_msvc:
+    name: "🖥️ Windows (MSVC)"
+    uses: ./.github/workflows/windows-build-msvc.yaml
+    if: github.repository == 'OpenGOAL-Mods/OG-Mod-Base'
+    with:
+      cmakePreset: "Release-windows-msvc"
+      cachePrefix: ""
+    secrets: inherit
+
+  # Linux
+  build_linux_clang:
+    name: "🐧 Linux (Clang)"
+    uses: ./.github/workflows/linux-build-clang.yaml
+    if: github.repository == 'OpenGOAL-Mods/OG-Mod-Base'
+    with:
+      cmakePreset: "Release-linux-clang-asan"
+      cachePrefix: ""
+    secrets: inherit
+
+  build_linux_gcc:
+    name: "🐧 Linux (GCC)"
+    uses: ./.github/workflows/linux-build-gcc.yaml
+    if: github.repository == 'OpenGOAL-Mods/OG-Mod-Base'
+    with:
+      cmakePreset: "Release-linux-gcc"
+      cachePrefix: ""
+    secrets: inherit
+
+  # MacOS
+  build_macos_intel:
+    name: "🍎 MacOS"
+    uses: ./.github/workflows/macos-build.yaml
+    if: github.repository == 'OpenGOAL-Mods/OG-Mod-Base'
+    with:
+      cmakePreset: "Release-macos-clang"
+      cachePrefix: ""
+
+  # Q4 2023 there will hopefully be native arm64 runners
+  # https://github.com/github/roadmap/issues/528
+  # build_macos_arm:
+  #   name: "🍎 MacOS"
+  #   uses: ./.github/workflows/macos-build-arm.yaml
+  #   with:
+  #     cmakePreset: "Release-macos-clang"
+  #     cachePrefix: ""