Readme me version 1

Pawn_Unreal/Source/PawnEditor/PawnEditor.Build.cs

@@ -20,6 +20,7 @@ public class PawnEditor : ModuleRules {
 			"ComponentVisualizers",
 			"ContentBrowser",
 			"SourceControl",
+			"PropertyEditor",
 			"Pawn"
 		});
 
@@ -27,6 +28,7 @@ public class PawnEditor : ModuleRules {
 			"Core",
 			"CoreUObject",
 			"Engine",
+			"EditorStyle",
 			"AppFramework",
 			"SlateCore",
 			"AnimGraph",
@@ -35,9 +37,8 @@ public class PawnEditor : ModuleRules {
 			"MainFrame",
 			"PropertyEditor",
 			"ComponentVisualizers",
-			"EditorStyle",
-			"PropertyEditor",
 			"Pawn",
+			"ActorPickerMode"
 		});
 	}
 }

README.md

@@ -0,0 +1,73 @@
+# Guide d'installation du projet
+
+## Installation des logiciels
+
+------
+
+Pour installer et ouvrir le projet, les logiciels suivants doivent être installés sur votre ordinateur :
+
+- Unreal Engine 5.2.1
+- Visual Studio 2019 ou 2022
+- Git
+
+#### Installation de Unreal Engine 5.2.1
+
+Pour installer Unreal Engine, il est nécessaire de télécharger Epic Games au préalable, disponible ici : [Epic Games](https://www.unrealengine.com/fr/download).
+
+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)
+
+#### Installation de Visual Studio 2019 ou 2022
+
+Vous n'aurez pas besoin d'ouvrir le logiciel durant la production. Il est nécessaire de le télécharger afin de pouvoir compiler les binaires du projet (*indispensable lorsque des fichiers C++ sont écrits par vos programmeurs adorés*).
+
+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)
+
+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)
+
+#### Installation de Git
+
+**Git** peut être installé ici : [Git](https://git-scm.com/). Vous pouvez soit l'utiliser en lignes de commandes, soit utiliser une interface graphique telle que **GitHub Desktop** (disponible ici : [GitHub Desktop](https://desktop.github.com/)).
+
+## Récupération du projet
+
+------
+
+Pour récupérer le projet, je supposerai ici que vous utilisez **GitHub Desktop**.
+
+1. Cliquez sur `File > Clone Repository` (ou appuyez sur Ctrl+Shift+O).
+
+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)
+
+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.
+
+   ![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`.
+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`.
+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)
+
+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.
+
+## FAQ
+
+------
+
+#### Q: J'ai une erreur quand je tente d'exécuter le fichier `build_and_editor.bat`.
+
+![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.