Import the base tree (MIT, see LICENSE)

.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: ['https://www.donationalerts.com/r/another project']

.github/ISSUE_TEMPLATE/1-crash.yml

@@ -0,0 +1,100 @@
+name: Crash
+description: The game closes, freezes or shows a FATAL message.
+labels: [bug, crash]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Check the pinned issues at the top of the issue list first: they cover the known crashes and their workarounds.
+
+        Do not attach or link game files, keys, firmware or builds. Issues that do are closed.
+  - type: checkboxes
+    id: duplicates
+    attributes:
+      label: Existing issues
+      options:
+        - label: I read the pinned issues and [searched open and closed issues](https://github.com/another recompilation project/issues?q=is%3Aissue) for this crash.
+          required: true
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: The title line of the settings menu (F1), for example "NX2navi Recomp 0.1.0, game 1.4.3".
+    validations:
+      required: true
+  - type: input
+    id: last-good
+    attributes:
+      label: Last version that worked
+      description: If an earlier version did not crash at this point, which one.
+  - type: textarea
+    id: system
+    attributes:
+      label: System info
+      description: Paste what Copy system info (F1, Advanced tab) puts on the clipboard. On a Steam Deck, add LCD or OLED.
+      render: text
+    validations:
+      required: true
+  - type: textarea
+    id: mods
+    attributes:
+      label: Mods and cheats
+      description: The folders in mods/ with their download links, or "none". Say whether it also crashes without them.
+    validations:
+      required: true
+  - type: dropdown
+    id: when
+    attributes:
+      label: When does it crash?
+      options:
+        - At startup, before the Nintendo logo
+        - Between the Nintendo logo and the title screen
+        - While loading a save
+        - In gameplay
+        - In a cutscene
+    validations:
+      required: true
+  - type: dropdown
+    id: blocker
+    attributes:
+      label: Can you keep playing?
+      options:
+        - "Yes, it does not happen again after a restart, or I can avoid it"
+        - "No, it happens every time at the same point"
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: What you did before the crash
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        ### The log
+
+        - The log of the run that crashed is `logs\nx2navi.log` in the folder of `nx2navi.exe` (F1, Advanced tab, Open log folder). Copy it before you start the game again: the next start renames it to `nx2navi.1.log`, and after five starts it is gone.
+        - Attach the whole file. Do not cut or edit it: the crash report is at the end, the GPU and driver lines are at the start.
+        - The log says `device lost` or `VK_ERROR_DEVICE_LOST` and the GPU is an NVIDIA one: set GPU pass marks to On (F1, Advanced tab, Diagnostics), restart the game, make it crash again and attach that log. The `vk: pass marks` lines then name what the GPU was drawing.
+  - type: textarea
+    id: log
+    attributes:
+      label: Log
+      description: Drag nx2navi.log into this field.
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        ### Save and input recording
+
+        When the crash comes back at one place in the game (an area, a shrine, a cutscene, a quest step), the save that gets there lets us crash it on our machine.
+
+        1. Zip the `profile` folder next to `nx2navi.exe` and attach it. Say which slot you load, or that you use the autosave.
+        2. If it takes more than walking a few steps from the save: turn on Input recording (F1, Advanced tab, Diagnostics), restart the game, load the save, make it crash, and attach `input-record.txt` from the logs folder together with the `nx2navi.log` of that run.
+  - type: textarea
+    id: save
+    attributes:
+      label: Save and input recording
+      description: Drag the zipped profile folder and input-record.txt into this field, when the crash comes back at one place.

.github/ISSUE_TEMPLATE/2-graphics.yml

@@ -0,0 +1,74 @@
+name: Graphics glitch
+description: Artifacts, missing or broken textures, flicker, wrong colours or shadows.
+labels: [bug, graphics]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Check the pinned issues at the top of the issue list first: they cover the known glitches on each GPU.
+
+        Do not attach or link game files, keys, firmware or builds. Issues that do are closed.
+  - type: checkboxes
+    id: duplicates
+    attributes:
+      label: Existing issues
+      options:
+        - label: I read the pinned issues and [searched open and closed issues](https://github.com/another recompilation project/issues?q=is%3Aissue) for this glitch.
+          required: true
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: The title line of the settings menu (F1), for example "NX2navi Recomp 0.1.0, game 1.4.3".
+    validations:
+      required: true
+  - type: input
+    id: last-good
+    attributes:
+      label: Last version that worked
+      description: If an earlier version drew this correctly, which one.
+  - type: textarea
+    id: system
+    attributes:
+      label: System info
+      description: Paste what Copy system info (F1, Advanced tab) puts on the clipboard. It lists the settings you changed too. On a Steam Deck, add LCD or OLED.
+      render: text
+    validations:
+      required: true
+  - type: textarea
+    id: mods
+    attributes:
+      label: Mods and cheats
+      description: The folders in mods/ with their download links, or "none". Say whether the glitch also shows without them. Turn off ReShade and other overlays that draw into the game before you report.
+    validations:
+      required: true
+  - type: textarea
+    id: screenshot
+    attributes:
+      label: Screenshot or video
+      description: Drag the file into this field. Say where in the game it was taken. Flicker needs a video.
+    validations:
+      required: true
+  - type: textarea
+    id: details
+    attributes:
+      label: What looks wrong and when
+      description: Does it show all the time, in one place, or after some time in play? Does it go away after a restart, or when you change a setting?
+    validations:
+      required: true
+  - type: dropdown
+    id: blocker
+    attributes:
+      label: Can you keep playing?
+      options:
+        - "Yes"
+        - "No, I cannot see enough to play"
+    validations:
+      required: true
+  - type: textarea
+    id: log
+    attributes:
+      label: Log
+      description: Drag logs\nx2navi.log from the folder of nx2navi.exe into this field, from the run that showed the glitch. Copy it before you start the game again.
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/3-performance.yml

@@ -0,0 +1,108 @@
+name: Performance
+description: Low frame rate, freezes, hitches, stutter or long loading.
+labels: [performance]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Check the pinned issues at the top of the issue list first.
+
+        Shaders the setup did not prepare are built the first time they are needed, so a short hitch the first time an area or effect shows is expected. Report it when it happens again in the same place.
+
+        Do not attach or link game files, keys, firmware or builds. Issues that do are closed.
+  - type: checkboxes
+    id: duplicates
+    attributes:
+      label: Existing issues
+      options:
+        - label: I read the pinned issues and [searched open and closed issues](https://github.com/another recompilation project/issues?q=is%3Aissue) for this problem.
+          required: true
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: The title line of the settings menu (F1), for example "NX2navi Recomp 0.1.0, game 1.4.3".
+    validations:
+      required: true
+  - type: input
+    id: last-good
+    attributes:
+      label: Last version that ran better
+      description: If an earlier version was faster in the same place, which one.
+  - type: textarea
+    id: system
+    attributes:
+      label: System info
+      description: Paste what Copy system info (F1, Advanced tab) puts on the clipboard. It lists the settings you changed too. On a Steam Deck, add LCD or OLED.
+      render: text
+    validations:
+      required: true
+  - type: dropdown
+    id: machine
+    attributes:
+      label: Machine
+      options:
+        - Desktop PC
+        - Laptop, on mains power
+        - Laptop, on battery
+        - Steam Deck
+        - Other handheld PC
+    validations:
+      required: true
+  - type: textarea
+    id: mods
+    attributes:
+      label: Mods and cheats
+      description: The folders in mods/ with their download links, or "none".
+    validations:
+      required: true
+  - type: dropdown
+    id: kind
+    attributes:
+      label: What kind of problem?
+      options:
+        - The frame rate is low all the time
+        - Short freezes or hitches that come back in the same place
+        - The frame rate is fine, but motion is not smooth
+        - It gets slower the longer I play
+        - Loading takes long
+    validations:
+      required: true
+  - type: textarea
+    id: where
+    attributes:
+      label: Where and what you were doing
+      description: For example "Lookout Landing, walking to the tower", "the Depths below Hyrule Castle", "fighting a Talus in the Sky". How long into the session it started.
+    validations:
+      required: true
+  - type: textarea
+    id: overlay
+    attributes:
+      label: Performance overlay
+      description: Press F10 twice (or both stick clicks) for the full panel. Stay a minute in the place and write down the frame rate, the mean and the longest frame time, or attach a screenshot of the panel.
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        ### Recording the log
+
+        1. In the settings menu (F1), Advanced tab, Diagnostics: turn on Performance log. For freezes and hitches, also turn on Flight recorder. Restart the game: both take effect at the next start.
+        2. Play at least three minutes in the place where it happens. The log gets a frame-time summary every 60 s, and a line for every frame over 50 ms that names what the frame waited for.
+        3. With the flight recorder on, press F8 right after a hitch. It also saves on its own after every frame longer than the freeze threshold (100 ms), at most once per 10 s.
+        4. Close the game with Quit game in the menu or the window's close button. Do not end it from Task Manager: the last summary is written when the game exits.
+        5. Copy `logs\nx2navi.log` from the folder of `nx2navi.exe` before you start the game again.
+        6. Each flight recorder save is a folder; the log line `flight: dump` names it. Zip the folders and attach them.
+        7. Turn both off again afterwards: they cost a little frame time.
+  - type: textarea
+    id: log
+    attributes:
+      label: Log
+      description: Drag nx2navi.log into this field.
+    validations:
+      required: true
+  - type: textarea
+    id: flight
+    attributes:
+      label: Flight recorder saves
+      description: Drag the zipped folders into this field, for freezes and hitches.

.github/ISSUE_TEMPLATE/4-bug.yml

@@ -0,0 +1,94 @@
+name: Other bug
+description: Sound, controls, the settings menu, the installer, or game logic.
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Check the pinned issues at the top of the issue list first. Crashes, graphics glitches and performance have their own templates.
+
+        Do not attach or link game files, keys, firmware or builds. Issues that do are closed.
+  - type: checkboxes
+    id: duplicates
+    attributes:
+      label: Existing issues
+      options:
+        - label: I read the pinned issues and [searched open and closed issues](https://github.com/another recompilation project/issues?q=is%3Aissue) for this bug.
+          required: true
+  - type: dropdown
+    id: area
+    attributes:
+      label: Area
+      options:
+        - Audio
+        - Controls and input
+        - Settings menu and overlay
+        - Installer
+        - Game logic and physics
+        - Something else
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: The title line of the settings menu (F1), for example "NX2navi Recomp 0.1.0, game 1.4.3". For the installer, the version of NX2navi-Setup.
+    validations:
+      required: true
+  - type: input
+    id: last-good
+    attributes:
+      label: Last version that worked
+      description: If an earlier version did this correctly, which one.
+  - type: textarea
+    id: system
+    attributes:
+      label: System info
+      description: Paste what Copy system info (F1, Advanced tab) puts on the clipboard. On a Steam Deck, add LCD or OLED. For the installer, write your OS and the install disk.
+      render: text
+    validations:
+      required: true
+  - type: textarea
+    id: mods
+    attributes:
+      label: Mods and cheats
+      description: The folders in mods/ with their download links, or "none". Say whether it also happens without them.
+    validations:
+      required: true
+  - type: dropdown
+    id: blocker
+    attributes:
+      label: Can you keep playing?
+      options:
+        - "Yes"
+        - "No, it stops the game or a quest"
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: What happened and how to reproduce it
+      description: What you expected, what happened instead, and the steps that lead there.
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        ### What to attach for your area
+
+        Close the game with Quit game in the menu or the window's close button, then copy `logs\nx2navi.log` from the folder of `nx2navi.exe` before you start the game again.
+
+        **Audio.** Open `nx2navi.ini` in the folder of `nx2navi.exe` and add the line `trace = audio`; when the file already has `trace = perf` (Performance log on), change it to `trace = perf,audio`. Start the game, play at least two minutes where the sound goes wrong and close the game. The log then has an `audio:` line every 5 s with the buffer underruns. Name the output device and how it is connected (speakers, headphones, USB, Bluetooth, HDMI), and attach a short video with sound if you can. Remove the line afterwards.
+
+        **Controls and input.** Name the controller and how it is connected (USB, Bluetooth, Steam Input). Does it also happen with keyboard and mouse?
+
+        **Controls, game logic, anything you can trigger again.** Turn on Input recording (F1, Advanced tab, Diagnostics), restart the game, load a save, make the bug happen and close the game. Attach `input-record.txt` from the logs folder and a zip of the save you loaded: the `profile` folder next to `nx2navi.exe`. The recording replays what you did, so we can see the bug on our machine.
+
+        **Installer.** Attach the newest `install-*.log` from `temp\logs` in the folder of `NX2navi-Setup.exe` (on Linux: `.setup-temp/logs` in the install folder), and the log file the error message names.
+  - type: textarea
+    id: log
+    attributes:
+      label: Log and other files
+      description: Drag nx2navi.log and the files your area asks for into this field.
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/5-feature.yml

@@ -0,0 +1,17 @@
+name: Feature request
+description: A setting, option or support for something the port does not do yet.
+labels: [enhancement]
+body:
+  - type: checkboxes
+    id: duplicates
+    attributes:
+      label: Existing issues
+      options:
+        - label: I [searched open and closed issues](https://github.com/another recompilation project/issues?q=is%3Aissue) and the Planned section of the README for this request.
+          required: true
+  - type: textarea
+    id: request
+    attributes:
+      label: What you want and why
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Question or help with setup
+    url: https://github.com/another recompilation project/discussions
+    about: Installing, updating and configuring the port. Ask in Discussions.

.github/workflows/content-guard.yml

@@ -0,0 +1,15 @@
+name: Content guard
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: python tools/check_content.py