Update README

.github/workflows/build-docker.yml

@@ -1,4 +1,5 @@
-name: Build docker
+name: Docker Image Build
+
 on:
   push:
     branches:

README.md

@@ -1,29 +1,109 @@
-# vRoleplay: Gamemode
+# vRoleplay
+
+[![Docker Image Build](https://github.com/eXo-OpenSource/mta-gamemode/actions/workflows/build-docker.yml/badge.svg)](https://github.com/eXo-OpenSource/mta-gamemode/actions/workflows/build-docker.yml)
+[![GitHub Release](https://img.shields.io/github/v/release/eXo-OpenSource/mta-gamemode?logo=github&logoColor=959DA5&labelColor=31373d)](https://github.com/eXo-OpenSource/mta-gamemode/releases)
+[![German README](https://img.shields.io/badge/German%20README-31373d?logo=googletranslate)](https://github.com/eXo-OpenSource/mta-gamemode/blob/master/docs/README_DE.md)
+
+
+<p align="center">
+    <img src="./docs/images/exo-vrp.png" />
+</p>
+
+<p align="center">
+vRoleplay is a real-life/roleplay game mode for <a href="https://multitheftauto.com/">Multi Theft Auto: San Andreas</a>, written in Lua.
+</p>
+
+### Features:
+- Factions
+    - Government Factions (Police Department, FBI, Army)
+        - Weapon and money trucks
+        - Maintaining order on the streets
+        - Prosecution of criminals
+    - Rescue Team
+        - Firefighting
+        - Rescueing of injured players
+    - Various Mafias and Gangs
+        - Gangwars
+        - Bankrobberies
+        - Weapon and drug trucks
+        - Airdrops
+
+- Companies
+    - Driving School
+        - Issueing of driving licences to players
+    - San News
+        - Communication of news to players
+    - Mech and Tow
+        - Towing of illegally parked and broken down cars
+    - Public Transport
+        - Transportation of players and delivering new cars to dealerships
+
+- Private Companies/Gangs
+    - Vehicle sales/rental
+    - Store robberies
+
+- Activities
+    - Fishing
+    - Casino
+    - Car tuning
+    - Jobs
+    - Sewers with secret casino and arms dealer
+    - Movie Theater
+    - Minigames
+    - Seasonal events (Easter, Halloween, Christmas, New Year)
+
+- Achievements
+
+- Houses/Apartments/Garages
+
+- Inventory
+
+- Self-treatment of wounds
+
+- Donation system
+
+- Extensive UI including mobile phone with various apps
+
+- Server Management
+    - Extensive administration features
+    - Integrated map editor
+    - Modding control
+    - Integration with Woltlab forums and control panel
+
+- And much more!
+
 ## Installation
-1. Git herunterladen: https://git-scm.com/download/win (bei der Installation TortoisePlink als SSH-Client auswählen
-2. Wahlweise kann _zusätzlich_ eine grafische Git-Oberfläche installiert werden.
-   Empfohlen sei an dieser Stelle TortoiseGit (https://tortoisegit.org/) und
-   GitKraken (https://www.gitkraken.com/), __nicht__ jedoch _GitHub for Windows_, da
-   dieses die Komplexität von Git zu sehr verbirgt und leicht zu Fehlern führt.
-3. SSH-Agent installieren: https://the.earth.li/~sgtatham/putty/latest/x86/pageant.exe
-4. Git klonen:
 
+### Docker (recommended)
+1. Install Docker
+
+2. Download `docker-compose.yml` and edit if necessary
+
+3. Command to start containers: 
     ```
-    git clone [email protected]:eXo-OpenSource/mta-gamemode.git
+    docker compose up -d
     ```
-5. In den Ressourcenordner gehen und dann folgendes ausführen:
 
-    Unter Windows:
+### Manual
+1. Download vRoleplay
+
+2. Download MariaDB Server and create a database for vRoleplay
+    
+2. Navigate to the resources folder and run:
+
+    Windows:
     ```
-    mklink /J [vrp] "pfadZumGitKlon"
+    mklink /J [vrp] "Path to vRoleplay folder (not vrp)"
     ```
 
-    Unter Linux oder macOS:
+    Linux/macOS:
     ```
-    ln -s 'pfadZumGitKlon' '[vrp]'
+    ln -s 'Path to vRoleplay folder (not vrp)' '[vrp]'
     ```
-    Dies erzeugt einen symbolischene Verknüpfung zum eigentlichen Ressourcenordner.
-6. Config-Vorlage `config.ini.example` unter `vrp/server/config/` nach `config.ini` kopieren.
 
-## Datenbank
-`tables.sql` unter `vrp/` in einen MariaDB Server importieren.
+    This will create a symlink to the resource folder
+
+3. Copy the configuration template `config.ini.example` in `vrp/server/config/` to `config.ini` and fill in the necessary settings
+
+### Admin privileges
+After creating an ingame account, navigate to your database and search for your account in the `vrp_account` table. Change the `Rank` column to __9__ (Project Lead) to get admin privileges.

docs/README_DE.md

@@ -0,0 +1,103 @@
+# vRoleplay
+
+<p align="center">
+    <img src="./images/exo-vrp.png" />
+</p>
+
+<p align="center">
+vRoleplay ist ein in Lua geschriebener Reallife/Roleplay Gamemode für <a href="https://multitheftauto.com/">Multi Theft Auto: San Andreas</a>.
+</p>
+
+### Features:
+- Fraktionen
+    - Staatsfraktionen (Police Department, FBI, Army)
+        - Waffen- und Geldtrucks
+        - Bewahren der Ordnung auf den Straßen
+        - Verfolgung von Straftätern
+    - Rescue Team
+        - Feuerbekämpfung
+        - Rettung verletzter Spieler
+    - Verschiedene Gangs und Mafien
+        - Gangwars
+        - Bankräube
+        - Waffen- und Drogentrucks
+        - Airdrops
+
+- Unternehmen
+    - Fahrschule
+        - Führerscheine an Spieler verteilen
+    - San News
+        - Mitteilen von Neuigkeiten an die Spieler
+    - Mech and Tow
+        - Abschleppen von falschparkenden und liegengebliebenen Autos
+    - Public Transport
+        - Beförderung von Spielern und Autohändler mit Neuwagen beliefern
+
+- Private Firmen/Gangs
+    - Verkauf/Verleih von Fahrzeugen
+    - Überfallen von Geschäften
+
+- Aktivitäten
+    - Angeln
+    - Casino
+    - Fahrzeugtuning
+    - Jobs
+    - Kanalisation mit geheimen Casino und Waffenhändler
+    - Kino
+    - Minigames
+    - Saisonale Events (Ostern, Halloween, Weihnachten, Silvester)
+
+- Achievements
+
+- Häuser/Wohnungen/Garagen
+
+- Inventar
+
+- Selbstbehandlung von Wunden
+
+- Spendensystem
+
+- Umfangreiches UI inklusive Handy mit verschiedenen Apps
+
+- Serververwaltung
+    - Umfangreiche Administrations Funktionen
+    - Integrierter Map Editor
+    - Modding Kontrolle
+    - Integration mit Woltlab Forum und Control Panel
+
+- Und viel mehr!
+
+## Installation
+
+### Docker (empfohlen)
+1. Docker installieren
+
+2. `docker-compose.yml` aus dem Repository herunterladen und bei Bedarf anpassen
+
+3. Befehl zum Starten der Container ausführen: 
+    ```
+    docker compose up -d
+    ```
+
+### Manuell
+1. vRoleplay herunterladen
+
+2. MariaDB Server herunterladen und eine Datenbank für vRoleplay erstellen
+    
+2. In den Ressourcenordner gehen und dann folgendes ausführen:
+
+    Unter Windows:
+    ```
+    mklink /J [vrp] "Pfad zum vRoleplay Ordner (nicht vrp)"
+    ```
+
+    Unter Linux oder macOS:
+    ```
+    ln -s 'Pfad zum vRoleplay Ordner (nicht vrp)' '[vrp]'
+    ```
+    Dies erzeugt einen symbolischene Verknüpfung zum eigentlichen Ressourcenordner
+
+3. Config-Vorlage `config.ini.example` unter `vrp/server/config/` nach `config.ini` kopieren und ausfüllen
+
+### Admin Rechte
+Nach dem erstellen eines Accounts in der Datenbank in der Tabelle `vrp_account` bei dem erstellen Account in die Spalte `Rank` __9__ (Projektleiter) eintragen.