rob/Pawn
4
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Readme version 2

Browse Source
This commit is contained in:
Maxime Maurin 2023-08-07 20:13:13 +02:00
parent 214a72ed58
commit 570338f383
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,5 +1,7 @@
# Guide d'installation du projet # Guide d'installation du projet
[TOC]
## Installation des logiciels ## Installation des logiciels
------ ------
@ -16,7 +18,7 @@ Pour installer Unreal Engine, il est nécessaire de télécharger Epic Games au
Dans le menu `Unreal Engine > Bibliothèque`, cliquez sur le bouton **+** à côté de **VERSIONS DU MOTEUR**. Veillez à bien sélectionner la version 5.2.1. puis cliquez sur **Installer**. Dans le menu `Unreal Engine > Bibliothèque`, cliquez sur le bouton **+** à côté de **VERSIONS DU MOTEUR**. Veillez à bien sélectionner la version 5.2.1. puis cliquez sur **Installer**.
![image-20230807193641409](.\Resources\Readme\Unreal_engine.png) ![Unreal_engine](Resources\Readme\Unreal_engine.png)
#### Installation de Visual Studio 2019 ou 2022 #### Installation de Visual Studio 2019 ou 2022
@ -24,11 +26,11 @@ Vous n'aurez pas besoin d'ouvrir le logiciel durant la production. Il est néces
Visual Studio 2022 est disponible ici : [Visual Studio 2022](https://visualstudio.microsoft.com/fr/vs/). La version Community 2022 est gratuite, c'est celle-ci que vous devez prendre. Lors de l'installation, veillez à cocher **Développement .NET Desktop** et **Développement de jeux avec C++**. L'option **Développement Desktop en C++** <u>n'est **PAS** obligatoire</u>. Visual Studio 2022 est disponible ici : [Visual Studio 2022](https://visualstudio.microsoft.com/fr/vs/). La version Community 2022 est gratuite, c'est celle-ci que vous devez prendre. Lors de l'installation, veillez à cocher **Développement .NET Desktop** et **Développement de jeux avec C++**. L'option **Développement Desktop en C++** <u>n'est **PAS** obligatoire</u>.
![Visual_studio](.\Resources\Readme\Visual_studio.png) ![Visual_studio](Resources\Readme\Visual_studio.png)
Si vous avez déjà installé Visual Studio sur votre ordinateur mais que ces modules ne sont pas installés, vous pouvez les installer en ouvrir **Visual Studio Installer** puis cliquer sur le bouton **Modifier** à côté de la version de Visual Studio que vous souhaitez utiliser. Si vous avez déjà installé Visual Studio sur votre ordinateur mais que ces modules ne sont pas installés, vous pouvez les installer en ouvrir **Visual Studio Installer** puis cliquer sur le bouton **Modifier** à côté de la version de Visual Studio que vous souhaitez utiliser.
![Visual_studio_2](.\Resources\Readme\Visual_studio_2.png) ![Visual_studio_2](Resources\Readme\Visual_studio_2.png)
#### Installation de Git #### Installation de Git
@ -44,20 +46,20 @@ Pour récupérer le projet, je supposerai ici que vous utilisez **GitHub Desktop
2. Cliquez sur l'onglet **URL** et rentrez le l'URL du dépôt du projet https://git.zblorg.xyz/rob/Pawn ainsi que le chemin où vous souhaiter installer les fichiers du projet. 2. Cliquez sur l'onglet **URL** et rentrez le l'URL du dépôt du projet https://git.zblorg.xyz/rob/Pawn ainsi que le chemin où vous souhaiter installer les fichiers du projet.
![Github_desktop](.\Resources\Readme\Github_desktop.png) ![Github_desktop](Resources\Readme\Github_desktop.png)
3. Cliquez sur **Clone**. Il est possible qu'on vous demande votre identifiant et mot de passe. Renseignez ceux associés au site https://git.zblorg.xyz/rob/Pawn. 3. Cliquez sur **Clone**. Il est possible qu'on vous demande votre identifiant et mot de passe. Renseignez ceux associés au site https://git.zblorg.xyz/rob/Pawn.
4. Une fois le projet récupéré, ouvrez l'explorateur de fichier à l'endroit où sont installés les fichiers. Vous devriez voir les dossiers et fichiers suivants. 4. Une fois le projet récupéré, ouvrez l'explorateur de fichier à l'endroit où sont installés les fichiers. Vous devriez voir les dossiers et fichiers suivants.
![explorateur](.\Resources\Readme\explorateur.png) ![explorateur](Resources\Readme\explorateur.png)
5. Copiez le fichier `vars.bat` se trouvant dans le dossier `Resources`, puis collez-le dans le dossier `Pawn_Unreal`. 5. Copiez le fichier `vars.bat` se trouvant dans le dossier `Resources`, puis collez-le dans le dossier `Pawn_Unreal`.
6. Vérifiez le chemin d'accès au moteur Unreal Engine 5.2.1 sur votre PC. Si le chemin est **identique** à celui-ci (chaque caractère compte) `C:\Program Files\Epic Games\UE_5.2`, **passez** à l'**étape 9**. 6. Vérifiez le chemin d'accès au moteur Unreal Engine 5.2.1 sur votre PC. Si le chemin est **identique** à celui-ci (chaque caractère compte) `C:\Program Files\Epic Games\UE_5.2`, **passez** à l'**étape 9**.
7. Si vous avez un chemin d'accès au moteur différent, ouvrez le fichiers `vars.bat` que vous avez collé dans le dossier `Pawn_Unreal` en faisant `Clique droit > Modifier`. 7. Si vous avez un chemin d'accès au moteur différent, ouvrez le fichiers `vars.bat` que vous avez collé dans le dossier `Pawn_Unreal` en faisant `Clique droit > Modifier`.
8. Modifiez la 10e ligne (la variable UE5_DIR) et remplacez le chemin d'accès du moteur par le votre. 8. Modifiez la 10e ligne (la variable UE5_DIR) et remplacez le chemin d'accès du moteur par le votre.
![vars](.\Resources\Readme\vars.png) ![vars](Resources\Readme\vars.png)
9. Exécutez (double-cliquez) le script `build_and_editor.bat` présent dans le dossier `Pawn_Unreal`. Ce fichier va exécuter les scripts `build.bat` et `editor.bat`, également présents dans le dossier. Ces scripts vont, respectivement, compiler les nouveaux fichiers C++ en binaire et ouvrir l'éditeur. **<u>A chaque fois que vous souhaiterez ouvrir le projet, exécuter ce script.</u>** Si vous ouvrez directement depuis Epic Games, Unreal Engine ou le fichier `Pawn.uproject`, vous n'aurez pas les derniers binaires compilés et le projet ne pourra pas fonctionner. 9. Exécutez (double-cliquez) le script `build_and_editor.bat` présent dans le dossier `Pawn_Unreal`. Ce fichier va exécuter les scripts `build.bat` et `editor.bat`, également présents dans le dossier. Ces scripts vont, respectivement, compiler les nouveaux fichiers C++ en binaire et ouvrir l'éditeur. **<u>A chaque fois que vous souhaiterez ouvrir le projet, exécuter ce script.</u>** Si vous ouvrez directement depuis Epic Games, Unreal Engine ou le fichier `Pawn.uproject`, vous n'aurez pas les derniers binaires compilés et le projet ne pourra pas fonctionner.
10. Le projet est installé, félicitations. 10. Le projet est installé, félicitations.
@ -68,6 +70,6 @@ Pour récupérer le projet, je supposerai ici que vous utilisez **GitHub Desktop
#### Q: J'ai une erreur quand je tente d'exécuter le fichier `build_and_editor.bat`. #### Q: J'ai une erreur quand je tente d'exécuter le fichier `build_and_editor.bat`.
![erreur](.\Resources\Readme\erreur.png) ![erreur](Resources\Readme\erreur.png)
R: Si vous voyez le texte **Building x actions with y processes...**, c'est qu'un fichier C++ n'a pas réussi à compiler. En général, le message en rouge commencera par `NomDunFichierRandom.cpp.obj`. Si c'est le cas, alors l'erreur vient de l'un des programmeurs. Prévenez-les au plus vite. En attendant, vous pouvez tenter d'ouvrir le projet via Epic Games, Unreal Engine ou le fichier `Pawn.uproject`. Si ce n'est pas une erreur de compilation, vérifiez bien que Visual Studio est bien installé comme indiqué précédemment (avec les bons mondules d'activés) et que vous avez bien copié le fichiers `vars.bat` dans le même dossier que le script `build_and_editor.bat`. Vérifiez également le chemin d'accès à Unreal Engine. Si le problème persiste, prévenez un programmeur n'oubliant pas de lui envoyer une capture d'écran de l'erreur. R: Si vous voyez le texte **Building x actions with y processes...**, c'est qu'un fichier C++ n'a pas réussi à compiler. En général, le message en rouge commencera par `NomDunFichierRandom.cpp.obj`. Si c'est le cas, alors l'erreur vient de l'un des programmeurs. Prévenez-les au plus vite. En attendant, vous pouvez tenter d'ouvrir le projet via Epic Games, Unreal Engine ou le fichier `Pawn.uproject`. Si ce n'est pas une erreur de compilation, vérifiez bien que Visual Studio est bien installé comme indiqué précédemment (avec les bons mondules d'activés) et que vous avez bien copié le fichiers `vars.bat` dans le même dossier que le script `build_and_editor.bat`. Vérifiez également le chemin d'accès à Unreal Engine. Si le problème persiste, prévenez un programmeur n'oubliant pas de lui envoyer une capture d'écran de l'erreur.