From 3bf17642a0d18f61c09ca42ffaa99668cdaa923c Mon Sep 17 00:00:00 2001 From: Miguel Date: Fri, 1 Nov 2024 00:04:44 +0100 Subject: [PATCH 1/4] readme made by: Marchusky (Marc Gallardo) --- README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 44 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 03d21982..8ca747a7 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,48 @@ # EclipseEngine -A 3D game engine made by 4 university students for the Game Engines subject. +A 3D game engine made from scratch by 4 university students for the Game Engines subject. ## The Team This team is composed by: -- Marc Gallardo: [https://github.com/Marchusky](https://github.com/Marchusky) -- Marc San José: [https://github.com/marcsjm19](https://github.com/marcsjm19) -- Miguel Tamaño: [https://github.com/migon25](https://github.com/migon25) -- Oscar Escofet: [https://github.com/OscarEFO](https://github.com/OscarEFO) +- **Marc Gallardo**: [https://github.com/Marchusky](https://github.com/Marchusky) +- **Marc San José**: [https://github.com/marcsjm19](https://github.com/marcsjm19) +- **Miguel Tamaño**: [https://github.com/migon25](https://github.com/migon25) +- **Oscar Escofet**: [https://github.com/OscarEFO](https://github.com/OscarEFO) + +## Key Functionalities +- **File Handling**: + - Supports drag-and-drop of **FBX** files from any location on the hard drive. + - Accepts **DDS/PNG** files for texture application to selected GameObjects. + +- **GameObject Structure**: + - Each loaded mesh creates a **GameObject** with three display-only components: **Transform**, **Mesh**, and **Texture**. + +- **Camera Controls**: + - **Right-click + WASDQE**: FPS-like movement and free look. + - **Mouse Wheel**: Zoom in and out. + - **Alt + Left Click**: Orbit the object. + - Press **“F”**: Focus the camera around the geometry. + - Holding **SHIFT**: Increases movement speed. + +- **Editor Windows**: + - **Console**: + - Logs the geometry loading process from ASSIMP and external library initialization. + - **Configuration**: + - Graph for FPS display. + - Adjustable settings for renderer, window, input, and textures. + - Displays memory consumption, hardware detection, and software version information (SDL, OpenGL, DevIL). + - **Hierarchy**: + - Lists all GameObjects; allows selection of GameObjects. + - **Inspector**: + - Displays component details of the selected GameObject: + - **Transform**: Position, rotation, and scale (read-only). + - **Mesh**: Mesh details with an option to show normals (per-triangle and per-face). + - **Texture**: Shows texture size and path, with an option for a checkered texture view. + +- **General Menu**: + - Options to quit the engine, visit the GitHub page, and view engine information (“About”). + - Ability to turn features on/off. + +## How to Use the Engine +1. Drag and drop **FBX** files and **DDS/PNG** textures into the engine. +2. Use the **camera controls** for navigating the scene. +3. Access **Editor Windows** for GameObject management and detailed information. From 56551042e33ab79680d86ea833da639616889c83 Mon Sep 17 00:00:00 2001 From: Miguel Date: Tue, 19 Nov 2024 12:08:45 +0100 Subject: [PATCH 2/4] Create msbuild.yml --- .github/workflows/msbuild.yml | 43 +++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 .github/workflows/msbuild.yml diff --git a/.github/workflows/msbuild.yml b/.github/workflows/msbuild.yml new file mode 100644 index 00000000..38b0f059 --- /dev/null +++ b/.github/workflows/msbuild.yml @@ -0,0 +1,43 @@ +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +name: MSBuild + +on: + push: + branches: [ "*" ] + pull_request: + branches: [ "*" ] + workflow_dispatch: + +env: + # Path to the solution file relative to the root of the project. + SOLUTION_FILE_PATH: EclipseEngine/EclipseEngine.sln + + # Configuration type to build. + # You can convert this to a build matrix if you need coverage of multiple configuration types. + # https://docs.github.com/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix + BUILD_CONFIGURATION: Release + +permissions: + contents: read + +jobs: + build: + runs-on: windows-latest + + steps: + - uses: actions/checkout@v4 + with: + submodules: 'recursive' + + - name: Add MSBuild to PATH + uses: microsoft/setup-msbuild@2 + + - name: Build + working-directory: ${{env.GITHUB_WORKSPACE}} + # Add additional options to the MSBuild command line here (like platform or verbosity level). + # See https://docs.microsoft.com/visualstudio/msbuild/msbuild-command-line-reference + run: msbuild /m /p:Configuration=${{env.BUILD_CONFIGURATION}} ${{env.SOLUTION_FILE_PATH}} From 2f624f9ef84353eece9606c5bc133090c51c0433 Mon Sep 17 00:00:00 2001 From: Miguel Date: Tue, 19 Nov 2024 12:09:55 +0100 Subject: [PATCH 3/4] Update msbuild.yml --- .github/workflows/msbuild.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/msbuild.yml b/.github/workflows/msbuild.yml index 38b0f059..85724cbc 100644 --- a/.github/workflows/msbuild.yml +++ b/.github/workflows/msbuild.yml @@ -34,7 +34,7 @@ jobs: submodules: 'recursive' - name: Add MSBuild to PATH - uses: microsoft/setup-msbuild@2 + uses: microsoft/setup-msbuild@v2 - name: Build working-directory: ${{env.GITHUB_WORKSPACE}} From c97b83548afd361858fa0fd4346b60f015efeb85 Mon Sep 17 00:00:00 2001 From: Miguel Date: Fri, 22 Nov 2024 15:29:33 +0100 Subject: [PATCH 4/4] ignore vcpkg --- .gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index c7b64173..312d1c2d 100644 --- a/.gitignore +++ b/.gitignore @@ -398,4 +398,5 @@ FodyWeavers.xsd *.sln.iml # vcpkg_installed -EclipseEngine/vcpkg_installed/ \ No newline at end of file +vcpkg_installed/ +vcpkg/ \ No newline at end of file