chore: improving repo hygiene

.github/workflows/release-packaging.yml

@@ -62,43 +62,6 @@ jobs:
           path: dist/*
           retention-days: 1
 
-  deploy:
-    runs-on: ubuntu-22.04
-    timeout-minutes: 30
-    needs: [check]
-
-    if: github.ref == 'refs/heads/main'
-
-    steps:
-      - uses: actions/checkout@v4
-      - uses: extractions/setup-just@v2
-
-      - name: Load dotenv
-        run: just ci-load-dotenv
-
-      - name: Cache Godot
-        uses: actions/cache@v4
-        with:
-          path: |
-            ~/.mkflower/bin
-            ~/.local/share/godot/export_templates
-          key: ${{ env.godot_version }}
-
-      - name: Export
-        run: just export-web
-
-      # Installing rsync is needed in order to deploy to GitHub Pages. Without it, the build will fail.
-      - name: Install rsync
-        run: |
-          sudo apt-get update && sudo apt-get install -y rsync
-
-      - name: Deploy to GitHub Pages
-        uses: JamesIves/github-pages-deploy-action@v4
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          branch: gh-pages
-          folder: build/web
-
   publish:
     runs-on: ubuntu-22.04
     timeout-minutes: 30

.pre-commit-config.yaml

@@ -1,3 +1,9 @@
+ci:
+  autofix_prs: false
+  autoupdate_commit_msg: 'chore(deps): Bump pre-commit hooks'
+  autoupdate_schedule: weekly
+  skip: [format-shaders]
+
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v4.4.0
@@ -15,6 +21,10 @@ repos:
   - id: end-of-file-fixer       # Checks for ending with a newline
   - id: mixed-line-ending       # Consistent LF or CRLF
   - id: trailing-whitespace     # No trailing whitespace
+- repo: https://github.com/fsfe/reuse-tool
+  rev: v4.0.3
+  hooks:
+  - id: reuse
 - repo: https://github.com/codespell-project/codespell
   rev: v2.2.5
   hooks:
@@ -36,14 +46,18 @@ repos:
     exclude: |
       (?x)^(
           .godot/|
+          .reuse/|
           addons/gd-plug/|
           assets/models/|
+          CHANGELOG.md|
+          CONTRIBUTING.md|
           CREDITS.md|
           Justfile|
           LICENSE.md|
           LICENSES/|
           public/|
-          README.md
+          README.md|
+          RELEASING.md
       )
   - id: format-shaders
     name: format shaders

.reuse/dep5

@@ -0,0 +1,89 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: Frogger3D
+Upstream-Contact: Florian Vazelle <[email protected]>
+Source: https://github.com/MechanicalFlower/Frogger3D
+
+Files: *
+Copyright: 2024-present Florian Vazelle
+License: MIT
+
+# Addons
+
+Files: addons/debug_menu/*
+Copyright: 2023-present Hugo Locurcio and contributors
+License: MIT
+Source: https://github.com/godot-extended-libraries/godot-debug-menu
+
+Files: addons/gd-plug/*
+Copyright: 2021 Tan Jian Ping
+License: MIT
+Source: https://github.com/imjp94/gd-plug
+
+# Models
+
+Files: assets/models/*
+Copyright: 2022 Kenney
+License: CC0-1.0
+Source: https://www.kenney.nl/
+
+# Fonts
+
+Files: assets/fonts/ka1.ttf
+Copyright: 2005 Vic Fieger
+License: CC0-1.0
+Source: https://www.dafont.com/karmatic-arcade.font
+
+Files: assets/fonts/vcr_osd_mono.001.ttf
+Copyright: 2014 Riciery Leal
+License: CC0-1.0
+Source: https://www.dafont.com/vcr-osd-mono.font
+
+# Sounds
+
+Files: assets/sounds/sfx/river/running-water.mp3
+Copyright: 2022 JackClearyMusic
+License: LicenseRef-Pixabay
+Source: https://pixabay.com/pt/sound-effects/running-water-48518/
+
+Files: assets/sounds/sfx/river/water-splosh.mp3
+Copyright: 2022 benj500
+License: LicenseRef-Pixabay
+Source: https://pixabay.com/pt/sound-effects/running-water-48518/
+
+Files: assets/sounds/sfx/river/water-stream.mp3
+Copyright: 2022
+License: LicenseRef-Pixabay
+Source: https://pixabay.com/pt/sound-effects/water-stream-108384/
+
+Files: assets/sounds/sfx/road/car-ambiant.mp3
+Copyright: 2022 jackthemurray
+License: LicenseRef-Pixabay
+Source: https://pixabay.com/pt/sound-effects/inside-car-noise-while-driving-29978/
+
+Files: assets/sounds/sfx/road/car-horn.mp3
+Copyright: 2021 keweldog
+License: LicenseRef-Pixabay
+Source: https://pixabay.com/pt/sound-effects/car-horn-6408/
+Comment: Edited by Florian Vazelle, with audacity, to start directly on the horn sound
+
+Files: assets/sounds/sfx/collect.mp3
+Copyright: 2021 Wagna
+License: LicenseRef-Pixabay
+Source: https://pixabay.com/pt/sound-effects/collect-5930/
+
+# Shaders
+
+Files: shaders/sky.gdshader
+Copyright: 2023 axilirate
+License: CC0-1.0
+Source: https://godotshaders.com/shader/stylized-sky-shader-with-clouds/
+
+Files: shaders/checkbox.gdshader
+Copyright: 2021 Lordinator
+License: CC0-1.0
+Source: https://godotshaders.com/shader/world-coordinates-grid-bw-shader/
+
+Files: shaders/water.gdshader
+Copyright: 2014 ScriptedWave
+License: CC0-1.0
+Source: https://godotshaders.com/shader/stylized-water-shader-2/

CHANGELOG.md

@@ -0,0 +1,14 @@
+# CHANGELOG
+Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+
+## [Unreleased]
+### Added
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security
+### Dependencies
+
+[Unreleased]: https://github.com/MechanicalFlower/Frogger3D/compare/0.1.0...HEAD
+[0.1.0]: https://github.com/MechanicalFlower/Frogger3D/commits/0.1.0

CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Contributing
+
+We welcome contributions to our open source Godot
+ game project! There are many ways you can help,
+ including reporting bugs, improving documentation,
+ and contributing code.
+
+## Code of Conduct
+
+We value the participation of every member of our
+ community and want to ensure that everyone
+ has an enjoyable and fulfilling experience. As
+ such, we have adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as
+ our code of conduct. By participating in this
+ project, you agree to abide by its terms.
+
+## Contributing Code
+
+To contribute code to the project, follow these steps:
+
+1. Fork the repository to your own GitHub account.
+2. Clone the repository to your local machine.
+3. Create a new branch for your changes.
+4. Make your changes and commit them to your local repository.
+5. Push your changes to your forked repository on GitHub.
+6. Create a pull request from your forked repository to the original repository.
+
+Please note that all code contributions should
+ pass the continuous integration (CI) checks
+ that are set up for the project. These checks
+ ensure that the code is well-formatted and
+ that tests are passing.
+
+
+## Reporting Bugs
+
+If you find a bug in the project, please report
+ it by creating an issue in the repository's issue
+ tracker. Be sure to include as much information
+ as possible, including the steps to reproduce
+ the bug and any relevant error messages.
+
+## Improving Documentation
+
+If you would like to improve the documentation
+ for the project, you can do so by submitting a
+ pull request with your changes. Please follow
+ the same process as for contributing code, and
+ make sure that your changes are properly formatted
+ and well-written.
+
+## Questions and Feedback
+
+If you have any questions or feedback about the
+ project, don't hesitate to reach out! You can
+ create an issue in the repository's issue tracker,
+ or contact us directly through our website or
+ social media channels.
+
+Thank you for considering contributing to our
+ open source Godot game project! We appreciate
+ your help and look forward to working with you.

CREDITS.md

@@ -0,0 +1,21 @@
+# Credits
+
+## Addons
+- "[addons/debug_menu/*](https://github.com/godot-extended-libraries/godot-debug-menu)" by **Hugo Locurcio and contributors** licensed under [MIT](./LICENSES/MIT.txt)
+- "[addons/gd-plug/*](https://github.com/imjp94/gd-plug)" by **Tan Jian Ping** licensed under [MIT](./LICENSES/MIT.txt)
+## Models
+- "[assets/models/*](https://www.kenney.nl/)" by **Kenney** licensed under [CC0-1.0](./LICENSES/CC0-1.0.txt)
+## Fonts
+- "[assets/fonts/ka1.ttf](https://www.dafont.com/karmatic-arcade.font)" by **Vic Fieger** licensed under [CC0-1.0](./LICENSES/CC0-1.0.txt)
+- "[assets/fonts/vcr_osd_mono.001.ttf](https://www.dafont.com/vcr-osd-mono.font)" by **Riciery Leal** licensed under [CC0-1.0](./LICENSES/CC0-1.0.txt)
+## Sounds
+- "[assets/sounds/sfx/river/running-water.mp3](https://pixabay.com/pt/sound-effects/running-water-48518/)" by **JackClearyMusic** licensed under [LicenseRef-Pixabay](./LICENSES/LicenseRef-Pixabay.txt)
+- "[assets/sounds/sfx/river/water-splosh.mp3](https://pixabay.com/pt/sound-effects/running-water-48518/)" by **benj500** licensed under [LicenseRef-Pixabay](./LICENSES/LicenseRef-Pixabay.txt)
+- "[assets/sounds/sfx/river/water-stream.mp3](https://pixabay.com/pt/sound-effects/water-stream-108384/)" by **** licensed under [LicenseRef-Pixabay](./LICENSES/LicenseRef-Pixabay.txt)
+- "[assets/sounds/sfx/road/car-ambiant.mp3](https://pixabay.com/pt/sound-effects/inside-car-noise-while-driving-29978/)" by **jackthemurray** licensed under [LicenseRef-Pixabay](./LICENSES/LicenseRef-Pixabay.txt)
+- "[assets/sounds/sfx/road/car-horn.mp3](https://pixabay.com/pt/sound-effects/car-horn-6408/)" by **keweldog** licensed under [LicenseRef-Pixabay](./LICENSES/LicenseRef-Pixabay.txt)
+- "[assets/sounds/sfx/collect.mp3](https://pixabay.com/pt/sound-effects/collect-5930/)" by **Wagna** licensed under [LicenseRef-Pixabay](./LICENSES/LicenseRef-Pixabay.txt)
+## Shaders
+- "[shaders/sky.gdshader](https://godotshaders.com/shader/stylized-sky-shader-with-clouds/)" by **axilirate** licensed under [CC0-1.0](./LICENSES/CC0-1.0.txt)
+- "[shaders/checkbox.gdshader](https://godotshaders.com/shader/world-coordinates-grid-bw-shader/)" by **Lordinator** licensed under [CC0-1.0](./LICENSES/CC0-1.0.txt)
+- "[shaders/water.gdshader](https://godotshaders.com/shader/stylized-water-shader-2)" by **ScriptedWave** licensed under [CC0-1.0](./LICENSES/CC0-1.0.txt)

Justfile

@@ -141,6 +141,10 @@ fmt:
     just venv pip install pre-commit==3.*
     just venv pre-commit run -a
 
+# Generate the CREDTIS.md file
+credits:
+    just venv python ./generate_credits.py
+
 # === Godot ===
 #
 # Recipes for managing the Godot binary.