Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alfaben12 authored Dec 1, 2024
1 parent 70f0280 commit 8523bd7
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,18 @@ Our goal is to create a visually appealing and user-friendly phone interface tha
This project is inspired by **QBPhone** from **QBCore**, combining its core functionalities with a fresh aesthetic that appeals to modern users. Our redesign aims to modernize the user experience while retaining the familiar features players love.

## Dependencies

for QB
- **[QB Core](https://github.com/qbcore-framework/qb-core "QB Core")**: This project relies on the QBCore framework for core functionalities.
- **[QB Banking](https://github.com/qbcore-framework/qb-banking "QB Banking")**: QB Banking is need for digital banking app.
- **[QB Banking](https://github.com/qbcore-framework/qb-banking "QB Banking")**: QB Banking is need for digital banking app or invoices.

for ESX
- **[ESX Core](https://github.com/esx-framework/esx_core "ESX Core")**: This project relies on the ESX framework for core functionalities.
- **[ESX Banking](https://github.com/esx-framework/esx_banking "ESX Banking")**: ESX Banking is need for digital banking app.
- **[ESX Billing](https://github.com/esx-framework/esx_billing "ESX Billing")**: ESX Banking is need for billing on banking app.

**IMPORTANT**: If you use others **banking, garage, housing resource** you still can use this phone but need a little changes on **server/core/[your fw].lua** then update query for retrieving datas following structure, please dont change the structure if you dont want enter to .jsx code!

always need
- **[OX Lib](https://github.com/overextended/ox_lib "OX Lib")**: OX Lib is also required to ensure seamless integration with existing systems.

## Tech Stack
Expand All @@ -39,7 +48,7 @@ Thank you for checking out Z-Phone! We hope you enjoy the new experience as much

## Ready to Use???

#### (Optional) **BANK TRANSACTION**
#### (Optional for QB) **BANK TRANSACTION**

If you want all bank transactions recorded, then do it
in **qb-core/server/player.lua**
Expand Down Expand Up @@ -91,13 +100,6 @@ Go to https://github.com/alfaben12/z-phone/tree/main/html/sounds copy all files

Go to https://github.com/alfaben12/z-phone/blob/main/z-phone.sql import query to your database to add all table for support z-phone

#### (Required) **NEW COLUMN**

ALTER TABLE phone_invoices ADD reason varchar(255);
ALTER TABLE phone_invoices ADD created_at DATETIME DEFAULT CURRENT_TIMESTAMP;

This query included on z-phone.sql

## IMPORTANT NOTES

Default phone number in QBCore may not be compatible with z-phone. If you use QBCore.Functions.GetPlayerByPhone(number) with a z-phone number, it is likely to return incorrect results. To avoid this issue, it's essential to synchronize the z-phone numbers with the QBCore character information (on table players, column charinfo, key phone).
Expand All @@ -106,7 +108,7 @@ Default phone number in QBCore may not be compatible with z-phone. If you use QB

I forgot where I downloaded this iPhone object, as far as I remember I downloaded it from forum.cfx.re, remind me if you know the author.

Please note that in V1.x.x, z-phone has not been optimized. If you want it optimized, that's fine and don't forget to make a pull request.
Please note that in V2.x.x, z-phone has not been optimized. If you want it optimized, that's fine and don't forget to make a pull request.

## DISCUSSION

Expand Down

0 comments on commit 8523bd7

Please sign in to comment.