diff --git a/README.md b/README.md index e025ffb..7fd39cc 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,90 @@ -# pTaxi -๐Ÿš– Taxi Script: Call a taxi, set a waypoint, and enjoy a ride! Supports ESX & QBCore with fair pricing and immersive gameplay. ๐ŸŒŸ + +# ๐Ÿš– Taxi Script for ESX and QBCore + +A simple and efficient taxi system for FiveM servers that works with both **ESX** and **QBCore** frameworks. This script allows players to call a taxi ๐Ÿš•, set a waypoint ๐Ÿ“, and enjoy an immersive ride. The taxi waits patiently ๐Ÿ•’, takes you to your destination, and ensures you pay the fare ๐Ÿ’ฐโ€”even if you decide to hop off early! + +--- + +## โœจ Features + +- **๐Ÿ“ž Call a Taxi:** Use the `/chamarTaxi` command to spawn a taxi on the nearest road. ๐Ÿ›ฃ๏ธ +- **๐Ÿ“ Waypoint Navigation:** Set a waypoint on the map for the taxi to drive to. ๐Ÿ—บ๏ธ +- **๐Ÿ’ธ Fair Pricing:** Pay the full fare, even if you exit the taxi before reaching your destination. +- **๐Ÿค– Immersive Interaction:** The taxi waits for you to enter and starts the ride once you're inside. + +--- + +## ๐Ÿš€ Installation + +### 1๏ธโƒฃ Download and Extract +๐Ÿ“ฅ Download the repository and extract the contents into your server's `resources` folder. + +### 2๏ธโƒฃ Choose Your Framework +The repository includes two versions: +- **`esx/`** - For servers using ESX framework. +- **`qbcore/`** - For servers using QBCore framework. + +Place the respective folder in your `resources` directory. + +### 3๏ธโƒฃ Configure `server.cfg` +Add the appropriate script to your `server.cfg` file: +```plaintext +ensure pTaxi-esx +``` +or +```plaintext +ensure pTaxi-qbcore +``` + +### 4๏ธโƒฃ Restart the Server +๐Ÿ”„ Restart your server to ensure the resource is loaded and ready to use. + +--- + +## ๐ŸŽฎ Usage + +1. **๐Ÿš• Call a Taxi:** + Use `/chamarTaxi` in chat to summon a taxi. + ๐Ÿ›ฃ๏ธ The taxi spawns at the nearest road and waits for you to enter. + +2. **๐Ÿ“ Set a Destination:** + Open your map ๐Ÿ—บ๏ธ and set a waypoint. The taxi will drive you to your destination. ๐Ÿš— + +3. **๐Ÿ’ฐ Exit and Fare:** + If you exit the taxi before reaching your destination, the full fare is still charged. + +--- + +## โš™๏ธ Configuration + +- **For ESX:** + Edit `config.lua` in the `esx/` folder to adjust settings like: + - Fare rates ๐Ÿ’ต + - Vehicle models ๐Ÿš— + - Wait times โณ + +- **For QBCore:** + Edit `config.lua` in the `qbcore/` folder for similar settings. + +--- + +## ๐Ÿ“‹ Dependencies + +- **ESX Version:** Requires ESX framework. +- **QBCore Version:** Requires QBCore framework. + +--- + +## ๐Ÿž Known Issues +- Ensure that the map waypoint is set correctly, as the taxi relies on it for navigation. ๐Ÿ—บ๏ธ +- Some vehicle models may behave differently. Adjust in `config.lua` if needed. + +--- + +## ๐Ÿชช License +This script is licensed under the **MIT License**. Feel free to modify and share! ๐Ÿ› ๏ธ + +--- + + +Enjoy the ride! ๐Ÿš–โœจ