docs(root): update checkout version of workflows, and fix some review…

… comment

.github/FUNDING.md

@@ -5,8 +5,6 @@ If you find this project useful and would like to provide financial support, we
 ## Funding Methods
 
 - [GitHub Sponsors](https://github.com/sponsors/MasterLaplace)
-- [Patreon](https://www.patreon.com/MasterLaplace)
-- [Open Collective](https://opencollective.com/MasterLaplace)
 
 ## Benefits for Financial Contributors
 

.github/workflows/build_laplace_libs.yml

@@ -14,7 +14,7 @@ jobs:
 
  steps:
  - name: Checkout
- uses: actions/checkout@v3
+ uses: actions/checkout@v4
 
  - name: make lib
  run: |

.github/workflows/commit_norm_check.yml

@@ -1,4 +1,4 @@
-name: Commit Name Checker
+name: Commit Norm Checker
 
 on:
  push:
@@ -14,19 +14,19 @@ jobs:
 
  steps:
  - name: Set up Git repository
- uses: actions/checkout@v3
+ uses: actions/checkout@v4
 
- - name: Commit Name Checker
+ - name: Commit Norm Checker
  run: |
  commit_msg=$(git log --format=%B -n 1 ${{ github.sha }})
- keyword_regex="^([a-z]+\([A-Za-z_.]+\)|^[a-z]+): "
+ keyword_regex="^([a-z]+\([A-Za-z_.-]+\)|^[a-z]+): "
 
  if [[ ! $commit_msg =~ $keyword_regex ]]; then
  if [[ $commit_msg =~ ^Merge\ .* ]]; then
  echo "Skipping merge commit"
  else
  echo $commit_msg
- echo "Commit message does not match expected format. Please use the following format:\"keyword(scope): comment\""
+ echo "Commit message does not match expected format. Please use the following format: \"keyword(scope): comment\""
  exit 1
  fi
  fi

.github/workflows/cpp_norm_checker.yml

@@ -13,10 +13,10 @@ jobs:
  runs-on: ubuntu-latest
  steps:
  - name: Set up C++ environment
- uses: actions/checkout@v3
+ uses: actions/checkout@v4
 
  - name: Install Python
- uses: actions/setup-python@v2
+ uses: actions/setup-python@v4
  with:
  python-version: '3.8'
 

.github/workflows/create-release.yml

@@ -18,7 +18,7 @@ jobs:
 
  steps:
  - name: Checkout code
- uses: actions/checkout@v2
+ uses: actions/checkout@v4
 
  - name: Check if PR is merged to main
  id: pr-check

.github/workflows/increment_major.yml

@@ -2,25 +2,26 @@ name: Increment Major Version
 
 on:
  pull_request:
- branches:
- - 'main'
- - 'master'
- - 'release'
- - 'release/*'
+ branches: [ main, master, release, release/* ]
 
 jobs:
  increment_major_version:
  runs-on: ubuntu-latest
 
  steps:
  - name: Check out code
- uses: actions/checkout@v2
+ uses: actions/checkout@v4
 
  - name: Increment Major Version
  run: |
  # Get the latest tag from the repository
  latest_tag=$(git describe --tags --abbrev=0)
 
+ if [[ -z "$latest_tag" ]]; then
+ echo "Failed to get the latest tag."
+ exit 1
+ fi
+
  # Extract the major, minor, and patch versions from the tag
  regex="([0-9]+)\.([0-9]+)\.([0-9]+)"
  if [[ $latest_tag =~ $regex ]]; then

.github/workflows/increment_minor.yml

@@ -2,22 +2,26 @@ name: Increment Minor Version
 
 on:
  pull_request:
- branches:
- - 'dev'
+ branches: [ dev ]
 
 jobs:
  increment_minor_version:
  runs-on: ubuntu-latest
 
  steps:
  - name: Check out code
- uses: actions/checkout@v2
+ uses: actions/checkout@v4
 
  - name: Increment Minor Version
  run: |
  # Get the latest tag from the repository
  latest_tag=$(git describe --tags --abbrev=0)
 
+ if [[ -z "$latest_tag" ]]; then
+ echo "Failed to get the latest tag."
+ exit 1
+ fi
+
  # Extract the major, minor, and patch versions from the tag
  regex="([0-9]+)\.([0-9]+)\.([0-9]+)"
  if [[ $latest_tag =~ $regex ]]; then

.github/workflows/increment_patch.yml

@@ -2,27 +2,26 @@ name: Increment Patch Version
 
 on:
  pull_request:
- branches:
- - '*'
- - '!dev'
- - '!main'
- - '!master'
- - '!release'
- - '!release/*'
+ branches: [ '*', '!dev', '!main', '!master', '!release', '!release/*' ]
 
 jobs:
  increment_version:
  runs-on: ubuntu-latest
 
  steps:
  - name: Check out code
- uses: actions/checkout@v2
+ uses: actions/checkout@v4
 
  - name: Increment Patch Version
  run: |
  # Get the latest tag from the repository
  latest_tag=$(git describe --tags --abbrev=0)
 
+ if [[ -z "$latest_tag" ]]; then
+ echo "Failed to get the latest tag."
+ exit 1
+ fi
+
  # Extract the major, minor, and patch versions from the tag
  regex="([0-9]+)\.([0-9]+)\.([0-9]+)"
  if [[ $latest_tag =~ $regex ]]; then

.github/workflows/run_test_engine.yml

@@ -15,7 +15,7 @@ jobs:
  run: sudo apt-get install -y cmake build-essential
 
  - name: Checkout
- uses: actions/checkout@v3
+ uses: actions/checkout@v4
 
  - name: Install CSFML
  run: ./Scripts/install_csfml.sh
@@ -24,7 +24,7 @@ jobs:
  run: sudo apt-get install libcriterion-dev
 
  - name: Build engine
- run: make build_tests
+ run: make re
 
  - name: Testing engine
  run: make run_tests

.github/workflows/update_readme.yml

@@ -15,15 +15,15 @@ jobs:
 
  steps:
  - name: Checkout code
- uses: actions/checkout@v2
+ uses: actions/checkout@v4
 
  - name: Set up Git
  run: |
  git config --local user.email $GH_BOT_ACC_EMAIL
  git config --local user.name $GH_BOT_ACC_NAME
 
  - name: Install Python
- uses: actions/setup-python@v2
+ uses: actions/setup-python@v4
  with:
  python-version: '3.x'
 

CONTRIBUTING.md

@@ -5,6 +5,7 @@ It is also essential for the development of the project.
 
 See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
 
+> **Note:** This project is released with a [Contributor Code of Conduct](.github/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
 > And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
 > - Star the project
 > - Tweet about it
@@ -36,7 +37,7 @@ See the [Table of Contents](#table-of-contents) for different ways to help and d
 
 Here, you can provide a brief overview of what the Engine-3D project is about and why contributions are important.
 
-v0.0.1 of the project is currently under development. You can find the latest release [here]().
+v0.1.6 of the project is currently under development. You can find the latest release [here](https://github.com/MasterLaplace/Engine-3D/releases/latest/) and the changelog [here](CHANGELOG.md).
 
 ----
 

Doxyfile.cfg

@@ -61,7 +61,7 @@ PROJECT_BRIEF = "Engine-3D made in C for EPITECH Hub."
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
 
-PROJECT_LOGO = ./Image/Logo_1-200x200.png
+PROJECT_LOGO = ./Images/Logo_1-200x200.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -1717,7 +1717,7 @@ DISABLE_INDEX = NO
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-GENERATE_TREEVIEW = NO
+GENERATE_TREEVIEW = YES
 
 # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
 # FULL_SIDEBAR option determines if the side bar is limited to only the treeview

Launcher/Makefile

@@ -31,7 +31,7 @@ type:
  @$(PYTHON) -m mypy src/*.py
 
 clean:
- @$(RM) __pycache__ .pytest_cache .mypy_cache
+ @$(RM) __pycache__ .pytest_cache .mypy_cache requirements.txt
  @-$(ECHO) $(BOLD) $(GREEN)✓$(LIGHT_BLUE)" CLEAN Launcher 💨"$(DEFAULT)
 
 fclean: clean

Launcher/src/ParseArgument.py

@@ -33,9 +33,16 @@
 """
 
 __CREDITS__ = """\
-Credits:
+Engine-3D Credits:
 
-Master_Laplace - Creator and maintainer of the project -\
+Website:
+https://github.com/MasterLaplace/Engine-3D
+
+Developer:
+Master_Laplace - Creator and maintainer of the project -
+
+Publicher:
+ME.inc - Publisher of the project -\
 """
 
 class ParseArgument:

Launcher/src/SceneManager.py

@@ -44,7 +44,7 @@ def InitUI(self):
 
  self.setGeometry(int(self.WIN_X/2), int(self.WIN_Y/2), self.WIN_X, self.WIN_Y)
  self.setWindowTitle('Engine-3D Launcher')
- self.setWindowIcon(QIcon('./Image/Logo_1.png'))
+ self.setWindowIcon(QIcon('./Images/Logo_1.png'))
  # Create system tray icon
  self.CreateSystemTrayIcon()
 
@@ -90,15 +90,14 @@ def SettingsPage(self)-> Widgets:
  def CreditsPage(self)-> Widgets:
  layout = QVBoxLayout()
 
- layout.addWidget(Widgets.CreateLabel([0, 0], 'Engine-3D Credits:'))
  layout.addWidget(Widgets.CreateLabel([0, 0], __CREDITS__))
  layout.addWidget(Widgets.CreateLabel([0, 0], 'Engine-3D Launcher version: ' + __VERSION__))
  layout.addWidget(Widgets.CreateButton([0, 0], [0, 0], 'Home', self.ShowHome))
 
  return Widgets(layout)
 
  def CreateSystemTrayIcon(self):
- self.tray_icon = QSystemTrayIcon(QIcon('./Image/Logo_1.png'), self)
+ self.tray_icon = QSystemTrayIcon(QIcon('./Images/Logo_1.png'), self)
  self.tray_icon.show()
 
  tray_menu = QMenu(self)
@@ -123,6 +122,8 @@ def CreateProject(self):
  if self.project_version == '':
  self.project_version = '0.2.0'
 
+ self.project_name = self.project_name.replace(' ', '_')
+
  __XML_TEMPLATE__ = f"""\
 <?xml version="1.0" encoding="UTF-8"?>
 <sbml xmlns="http://www.sbml.org/sbml/level3/version1/core" level="3" version="1">
@@ -174,6 +175,7 @@ def ShowRunProject(self):
  graphycal = match.group(2)
  version = match.group(3)
  os.system(f'make run {name} {graphycal} {version} -s')
+ self.show()
 
  def ShowFileDialog(self):
  options = QFileDialog.Options()

Launcher/src/Widgets.py

@@ -155,7 +155,7 @@ def CreateCheckBox(pos: list[int], size: list[int], text: str, func: object)-> Q
  text (str): _description_ text to show
  func (object): _description_ function to call when checked
  """
- check_box = QCheckBox(text, )
+ check_box = QCheckBox(text)
  check_box.setGeometry(pos[0], pos[1], size[0], size[1])
  check_box.stateChanged.connect(func)
  return check_box

Libs/Makefile

@@ -56,7 +56,7 @@ endif
 
 CFLAGS = -Wall -Werror -Wpedantic $(INCLUDE_LLIB) $(INCLUDE_LLINK) $(INCLUDE_LMAP) $(INCLUDE_LERROR)
 LDFLAGS = -L. -lLaplaceLib -lLaplaceLink -lLaplaceMap -lLaplaceError
-FASTFLAGS = -Ofast -march=native -mtune=native -flto -fomit-frame-pointer \
+FASTFLAGS = -Ofast -march=native -mtune=native -fomit-frame-pointer \
  -fopenmp -fprefetch-loop-arrays -pipe
 
 all: $(NAME_LLIB) $(NAME_LLINK) $(NAME_LMAP) $(NAME_LERROR)

README.md

@@ -102,20 +102,23 @@ temps réel.<br>
  - 3.3.1 OpenGL
  - 3.3.2 Vulkan
  - 3.3.3 DirectX
-4. Outils de développement (a faire)
+4. Outils de développement (à faire)
  - 4.1 Gestionnaire de version ✅
  - 4.2 Gestionnaire de paquets
  - 4.3 Launcher ✅
  - 4.4 mode Debug
  - 4.5 Profiler
  - 4.6 Documentation ✅
  - 4.7 Tests
-5. Optimisation (a faire)
- - 5.1 Multithreading
- - 5.2 SIMD
- - 5.3 Cache
- - 5.4 Mémoire
- - 5.5 GPU
+5. Réalité mixte (à faire)
+ - 5.1 Réalité augmentée
+ - 5.2 Réalité virtuelle
+6. Optimisation (à faire)
+ - 6.1 Multithreading
+ - 6.2 SIMD
+ - 6.3 Cache
+ - 6.4 Mémoire
+ - 6.5 GPU
 
 Il faut : ✅