README.md 5.78 KB
Newer Older
BARBI HUGO's avatar
BARBI HUGO committed
1
# 20School - Projet T3
BARBI HUGO's avatar
Ajout  
BARBI HUGO committed
2

BARBI HUGO's avatar
BARBI HUGO committed
3
## Introduction
BARBI HUGO's avatar
Ajout  
BARBI HUGO committed
4

BARBI HUGO's avatar
BARBI HUGO committed
5
6
* 	Bienvenue sur le README du jeux **20School**, créé par le groupe *20School corporation*.<br/>
	Les fondateurs et créateurs du projet sont *Barbi Hugo*, *Victor Larmet*, *Okkes Amoca*.<br/>
LARMET VICTOR's avatar
LARMET VICTOR committed
7
	Vous trouverez tout le nécessaire ici afin de profiter pleinement de notre jeu.<br/>
BARBI HUGO's avatar
BARBI HUGO committed
8
	Si vous rencontrez un quelconque problème, n'hésitez pas à nous contacter par le biais de nos emails universitaires :
LARMET VICTOR's avatar
LARMET VICTOR committed
9
10
11
12
	- hugo.barbi@etu.unistra.fr
	- victor.larmet@etu.unistra.fr
	- okkes.amoca@etu.unistra.fr

Hugo Barbi's avatar
Hugo Barbi committed
13
## Sommaire
BARBI HUGO's avatar
Ajout  
BARBI HUGO committed
14

Hugo Barbi's avatar
Hugo Barbi committed
15
16
> * [Titre](#title--repository-name)
>   * [Introduction](#introduction)	
Hugo Barbi's avatar
Hugo Barbi committed
17
>   * [Sommaire](#sommaire)
BARBI HUGO's avatar
BARBI HUGO committed
18
>   * [Installation](#installation)
Hugo Barbi's avatar
Hugo Barbi committed
19
>   * [Utilisation](#utilisation)
BARBI HUGO's avatar
BARBI HUGO committed
20
>     * [Captures d'écran](#captures-d%C3%A9crans)
Hugo Barbi's avatar
Hugo Barbi committed
21
22
>     * [Fonctionnalités](#fonctionnalités)
>   * [Code source](#code-source)
BARBI HUGO's avatar
BARBI HUGO committed
23
>     * [Contenu](#contenue)
BARBI HUGO's avatar
BARBI HUGO committed
24
>   * [Ressources](#ressources-documentation-et-liens)
BARBI HUGO's avatar
BARBI HUGO committed
25
>   * [Erreurs connues](#reports-derreurs-commentaires)
BARBI HUGO's avatar
BARBI HUGO committed
26
>   * [License](#license)
Hugo Barbi's avatar
Hugo Barbi committed
27
>   * [A propos de nous](#a-propos-de-nous)
BARBI HUGO's avatar
Ajout  
BARBI HUGO committed
28

BARBI HUGO's avatar
BARBI HUGO committed
29
30
## Installation

BARBI HUGO's avatar
BARBI HUGO committed
31
Pour installer notre jeux suivez les étapes suivantes :
BARBI HUGO's avatar
BARBI HUGO committed
32
* Télécharger le dossier **20SchoolSetup** en format *.zip* sur la page du projet.
BARBI HUGO's avatar
BARBI HUGO committed
33
34
* Un fois téléchargé, décomprésser **l'archive 20SchoolSetup.zip** sur votre ordinateur et ouvrez le dossier.
* Déplacez-vous jusqu'au dossier **Release**, puis, double cliquez sur **20SchoolSetup.msi**.
BARBI HUGO's avatar
BARBI HUGO committed
35
36
37
* Suivez l'installateur jusqu'à l'installation finale.
* Si tout s'est bien passé, un raccourci s'est créé sur votre bureau.
* Vous êtes prêt à **lancer** le jeux !
BARBI HUGO's avatar
BARBI HUGO committed
38

Hugo Barbi's avatar
Hugo Barbi committed
39
## Utilisation
BARBI HUGO's avatar
BARBI HUGO committed
40

BARBI HUGO's avatar
BARBI HUGO committed
41
Pour **lancer** le jeux. Rendez-vous sur votre bureau ou dans le menu démarrer.
BARBI HUGO's avatar
BARBI HUGO committed
42
Double cliquez sur le raccourci **20School**. Le jeux se lance, vous devriez vous retrouver sur le **menu**.
BARBI HUGO's avatar
BARBI HUGO committed
43

Hugo Barbi's avatar
Hugo Barbi committed
44
### Captures d'écrans
BARBI HUGO's avatar
BARBI HUGO committed
45

BARBI HUGO's avatar
BARBI HUGO committed
46
<img src="/20School/img/screen1.jpg" width="400" height="225">
BARBI HUGO's avatar
BARBI HUGO committed
47
48
49
50
51
<img src="/20School/img/screen2.jpg" width="400" height="225">
<img src="/20School/img/screen3.jpg" width="400" height="225">
<img src="/20School/img/screen4.jpg" width="400" height="225">
<img src="/20School/img/screen5.jpg" width="400" height="225">
<img src="/20School/img/screen6.jpg" width="400" height="225">
BARBI HUGO's avatar
BARBI HUGO committed
52

Hugo Barbi's avatar
Hugo Barbi committed
53
### Fonctionnalités
BARBI HUGO's avatar
BARBI HUGO committed
54

BARBI HUGO's avatar
BARBI HUGO committed
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
**Objectif principal**
* Faire réussir le plus d'élèves en maximisant leur compétences et leur effort

**Rôle**
* Le joueur incarne un professeur dans la simulation d'une salle de classe avec un temps limité de 4 minutes (240 secondes).

**Contexte**
* Tout au long du jeu, le joueur évalue les élèves et leurs attribus des points de compétences et d'efforts.

**Déroulement du jeu**
* Le joueur commence par évaluer les élèves une première fois pour attribuer les profils d'élèves par défaut.

* Ensuite, il aura la possibilité de poser des questions à la classe et d'intérroger l'élève de son choix. Certains lèveront la main pour répondre.

* Après chaque question, le joueur doit donner une appréciation à l'élève qui aura répondu. L'appréciation influencera les efforts de l'élèves.

LARMET VICTOR's avatar
LARMET VICTOR committed
71
* Le choix des appréciations a un coût et son utilisation doit donc être réfléchie. Si l'utilisateur donne trop de bonnes appréciations, ces dernières auront de moins en moins d'impacts, un changement soudain pour une mauvaise appréciation auront cependant un effet très fort sur les efforts. Cette règle s'applique également dans le cas contraire.
BARBI HUGO's avatar
BARBI HUGO committed
72
73
74
75
76

* A tout moment, le joueur a la possibilité de faire un cours particulier à l'élève de son choix, entre deux questions par exemple.
Ce cours a pour but d'augmenter fortement les compétences d'un élève. Néanmoins ce procédé prend du temps, attention au timer !

* Le partie du joueur est soumise à un timer de 4 minutes (240 secondes). A la fin du temps impartis, la partie se termine et le récapitulatif de partie s'affiche sous forme d'un grahpique.
BARBI HUGO's avatar
BARBI HUGO committed
77

Hugo Barbi's avatar
Hugo Barbi committed
78
## Code source
BARBI HUGO's avatar
BARBI HUGO committed
79

Hugo Barbi's avatar
Hugo Barbi committed
80
### Contenue
BARBI HUGO's avatar
BARBI HUGO committed
81

BARBI HUGO's avatar
BARBI HUGO committed
82
83
84
* Description   
Le code source de notre projet est accesible dans le dossier **20School à la racine** du projet Visual Studio.  
Le language utilisé est le C#, vous trouverez donc les fichiers .cs dans ce dossier.  
BARBI HUGO's avatar
BARBI HUGO committed
85
86
Le jeux a été réalisé en Application Windows Forms avec le *.NET Framework* de Microsoft Visual Studio.
Dépendances : Microsoft .NET Framework 4.7.2 (x86 et x64).
BARBI HUGO's avatar
BARBI HUGO committed
87

BARBI HUGO's avatar
BARBI HUGO committed
88
* Organisation
BARBI HUGO's avatar
BARBI HUGO committed
89
90
91
92
93
La structure du projet est sous la forme classique d'un projet .NET Visual Studio.
Néanmoins, nous avons rajouté des dossiers pour ajouter du contenu supplémentaire à notre application.
Le dossier **base** contient la base de donnée utilisé pour enregistrer les données de la partie.
Le dossier **img** contient les images utilisées pour l'interface utilisateur (UI).
Ces deux dossiers sont présent à la **racine** du projet Visual Studio.
BARBI HUGO's avatar
BARBI HUGO committed
94

Hugo Barbi's avatar
Hugo Barbi committed
95
## Ressources (Documentation et liens)
BARBI HUGO's avatar
BARBI HUGO committed
96

BARBI HUGO's avatar
BARBI HUGO committed
97
* Documentation de Visual Studio Installer Projects : https://docs.microsoft.com/en-us/windows/msix/desktop/desktop-to-uwp-packaging-dot-net
LARMET VICTOR's avatar
LARMET VICTOR committed
98
* Documentation de Doxygen ( */20School/html/index.html* ) : https://www.doxygen.nl/index.html
Hugo Barbi's avatar
Hugo Barbi committed
99

Hugo Barbi's avatar
Hugo Barbi committed
100
## Reports d'erreurs / Commentaires
BARBI HUGO's avatar
BARBI HUGO committed
101

LARMET VICTOR's avatar
LARMET VICTOR committed
102
Dans cette section, les erreurs connues ont été répertorié afin de fournir une aide au joueur.  
BARBI HUGO's avatar
BARBI HUGO committed
103
104

* Le pleine écran  
LARMET VICTOR's avatar
LARMET VICTOR committed
105
Au début du développement, nous souhaitions afficher notre jeu en pleine écran, mais nous avons rencontré des difficultés par rapport à l'adaptation des différents composants/controles. En effet, ces derniers présentent des problèmes d'adaptation selon la taille de l'écran utilisée par le joueur.  
BARBI HUGO's avatar
BARBI HUGO committed
106
Nous avons donc décidé de garder le mode fenêtré pour notre jeux afin d'éviter tout problème.
Hugo Barbi's avatar
Hugo Barbi committed
107

BARBI HUGO's avatar
BARBI HUGO committed
108
109
## License

BARBI HUGO's avatar
BARBI HUGO committed
110
**License open source**   
LARMET VICTOR's avatar
LARMET VICTOR committed
111
Notre jeu est libre de droit, le code source est disponible et peut être librement copié ou modifié.
BARBI HUGO's avatar
BARBI HUGO committed
112

Hugo Barbi's avatar
Hugo Barbi committed
113
## A propos de nous
BARBI HUGO's avatar
BARBI HUGO committed
114

BARBI HUGO's avatar
BARBI HUGO committed
115
116
117
* Barbi Hugo --> https://hugobarbi.pagesperso-orange.fr/
* Victor Larmet --> https://victor-larmet.pagesperso-orange.fr/
* Okkes Amoca