Update readme

N3MTV · Jun 22, 2018 · fa7d739 · fa7d739
1 parent 319f19d
commit fa7d739
Showing 1 changed file with 220 additions and 45 deletions.
diff --git a/readme.md b/readme.md
@@ -1,6 +1,15 @@
 <h2 align="center">Téléphone pour FiveM</h2>
 
-**Fonctionalitées**
+
+<p align="center">
+![img](https://i.imgur.com/naTiBgI.png)
+![img](https://i.imgur.com/LAicovK.png)
+![img](https://i.imgur.com/LAicovK.png)
+![img](https://i.imgur.com/imWPohA.png)
+![img](https://i.imgur.com/rzWdDMy.png)
+</p>
+
+## Fonctionalitées
   - List des conctacts
   - Envoie de sms
   - Appel vocal
@@ -9,60 +18,226 @@
   - Application Tchat anonyme
   - Application Bourse
   - Coque / Fond ecran customisable
+  - . . .
 
 
-# Configuration
+## Configuration
 
-* Changer le nom du réseau
-```
-* Modifier la clef 'reseau' dans le fichier /html/static/config/config.json
-```
 
-Pour ajouter / modifier les coques & fond d'écrans
-```
-* Coque => Modifier les images dans le dossier /html/static/img/coque
-* Fond d'écran => Modifier les images dans le dossier /html/static/img/background
-* Mettre à jour le fichier /html/static/config/config.json
-* Ajouter les images dans __ressource.lua
-```
+### Modifier le fichier /html/static/config/config.json
+```json
+{
+  "//": "Nom du reseau situé dans bare du téléphone",
+  "reseau": "Gannon",
+
+  "//": "Couleur de base du téléphone",
+  "themeColor": "#303f9f",
 
-Customiser les appels services
-``` javascript
-// fichier /html/static/config/config.json
-// ...
-"serviceCall": [
-  // Service
-  {
-    "display": "Police", // Nom du service
-    "backgroundColor": "#FF0000", // Optionnel Couleur 
-    "icon": "/html/static/img/icons_app/bank.png", // Optionnel Lien vers une image | Ignore le backgroundColor
-    "subMenu": [  // List des options proposé par le service
-      {
-        "title": "Envoyer un message", // Nom de l'option
-        "color": "#303F9F" // Optionnel Couleur de l'option
-        "eventName": "callService", // Nom de l'event générer
-        "type": "journaliste", // Parametre supplement dans l'event
-      },
-      {
-        // Option 2
-      }
-    ] // List des options
-  }
-  },
-  {
-    // Service 2
-    "display": "Samu",
-    "subMenu": [{
-      // ...
+  "//": "List des couleurs pour les conctacts",
+  "colors": [
+    "#EF5350",
+    "#EC407A",
+    "#AB47BC",
+    "#7E57C2",
+    "#5C6BC0",
+    "#42A5F5",
+    "#29B6F6",
+    "#26C6DA",
+    "#26A69A",
+    "#66BB6A",
+    "#9CCC65",
+    "#D4E157",
+    "#FFCA28",
+    "#FFA726",
+    "#FF7043",
+    "#8D6E63",
+    "#78909C"
+  ],
+
+  "//": "Si false, Ajoute un '-' dans le numero (###-####)",
+  "useFormatNumberFrance": false,
+
+  "//": "useWebRTCVocal: false => Appels avec channels de GTA",
+  "//": "useWebRTCVocal: true  => Appels avec WebRTC",
+  "useWebRTCVocal": true,
+
+  "//": "Configuration des serveurs TURN à utilisé",
+  "RTCConfig": {
+    "iceServers": [{
+      "urls": ["turn:gannon.ovh"],
+      "username": "jojo",
+      "credential": "pass"
     }]
-  }
-]
-// ...
+  },
+
+
+  "//": "List des fonds d'ecran disponible, location => /html/static/img/background",
+  "background" : {
+    "Calvin & Hobbes": "back001.jpg",
+    "Destiny": "back002.jpg",
+    "Stormtrooper": "back003.jpg",
+    "Custom URL": "URL"
+  },
+  "//": "Fonds d'ecran par default",
+  "background_default": {
+    "label": "Calvin & Hobbes",
+    "value": "back001.jpg"
+  },
+
+  "//": "List des coque disponible, location => /html/static/img/coque",
+  "coque": {
+    "Sansumg S8": "s8.png",
+    "Iphone X": "iphonex.png",
+    "Brick Base": "base.png",
+    "Transparent": "transparent.png"
+  },
+  "//": "Coque par default",
+  "coque_default": {
+    "label": "Sansumg S8",
+    "value": "s8.png"
+  },
+
+  "//": "Configuration des appels service (Favorie)",
+  "serviceCall": [
+    {
+
+      "//": "Nom de l'item",
+      "display": "Police",
+
+      "//": "Optionnel: Couleur de puce",
+      "backgroundColor": "red",
+
+      "//": "Optionnel: Image de la puce",
+      "icon": "/html/static/img/icons_app/bank.png",
+
+      "//": "List des actions disponible",
+      "subMenu": [
+        {
+          "//": "Titre de l'action",
+          "title": "Envoyer un message",
+
+          "//": "Nom de l'event trigger à l'utilisation",
+          "eventName": "esx_addons_gcphone:call",
+
+          "//": "Optionnel: Parametre 'data' envoyé avec l'event",
+          "type": {
+            "number": "police"
+          }
+        },
+        {
+          "title": "Appeler le standard",
+          "eventName": "gcphone:autoCallNumber",
+          "type": {
+            "number": "911"
+          }
+        }
+      ]
+    },
+    {
+      "display": "Ambulance",
+      "backgroundColor": "red",
+      "subMenu": [
+        {
+          "title": "Envoyer un message",
+          "eventName": "esx_addons_gcphone:call",
+          "type": {
+            "number": "ambulance"
+          }
+        }
+      ]
+    }
+  ],
+
+  "//": "Configuration des applications",
+  "apps": [
+    {
+      "//": "Nom de l'application",
+      "name": "Téléphone",
+
+      "//": "Icons de l'application",
+      "icons": "/html/static/img/icons_app/call.png",
+
+      "//": "Route de l'application, NE PAS MODIFIER",
+      "routeName": "appels",
+
+      "//": "Si true, l'application serra disponible sur la home page",
+      "inHomePage": true,
+
+      "//": "Si false, l'application n'est pas visible",
+      "enabled": true
+    },
+    {
+      "name": "Messages",
+      "icons": "/html/static/img/icons_app/sms.png",
+      "routeName": "messages",
+      "inHomePage": true,
+
+      "//": "Référence au store, pour affiche un puce sous l'icone de l'app",
+      "puceRef": "nbMessagesUnread",
+    },
+    {
+      "name": "Contacts",
+      "icons": "/html/static/img/icons_app/contacts.png",
+      "routeName": "contacts",
+      "inHomePage": true
+    },
+    {
+      "name": "Paramètres",
+      "icons": "/html/static/img/icons_app/settings.png",
+      "routeName": "parametre",
+      "inHomePage": true
+    },
+    {
+      "name": "Bank",
+      "icons": "/html/static/img/icons_app/bank.png",
+      "routeName": "bank",
+      "inHomePage": false
+    },
+    {
+      "name": "Bourse",
+      "icons": "/html/static/img/icons_app/bourse.png",
+      "routeName": "bourse",
+      "enabled": true
+    },
+    {
+      "name": "Photo",
+      "icons": "/html/static/img/icons_app/photo.png",
+      "routeName": "photo"
+    },
+    {
+      "name": "Dark Chat",
+      "icons": "/html/static/img/icons_app/tchat.png",
+      "routeName": "tchat"
+    }
+  ]
+}
+
 ```
+*N'oublier pas de rajoute les nouveaux fichier dans le __ressource.lua*
 
 
-## License
+* Vous pouvez modifier les sons dans \html\static\sound
+* Les coques doivent etre de 1000x500 px, La zone ecran est center de taille 800*400
+* Les application Banque & Bourse sont à configuré selon vos script
+
+### Les poste fixe sont configurable dans gcphone/config.lua
+```LUA
+--[[
+  Faite attention à ne pas utilisé un numéro qui entre en conflic avec un joueur
+--]]
+FixePhone = {
+  -- Poste de police
+  ['911'] = { name =  "Central Police", coords = { x = 441.2, y = -979.7, z = 30.58 } },
+
+  -- Cabine proche du poste de police
+  ['008-0001'] = { name = "Cabine Telephonique", coords = { x = 372.25, y = -965.75, z = 28.58 } },
+}
+```
 
+
+
+
+## License
 [GNU v3](https://opensource.org/licenses/gpl-3.0.html)
 
 Jonathan (Gannon) D