Merge pull request #49 from Dude495/patch-2

fixed spacing

.gitattributes

@@ -0,0 +1,12 @@
+# VCS / CI noise
+.gitattributes     export-ignore
+.gitignore         export-ignore
+.github/**         export-ignore
+.gitmodules        export-ignore
+
+# Dev tooling/config
+.vscode/**         export-ignore
+*.code-workspace   export-ignore
+.editorconfig      export-ignore
+.eslintrc*         export-ignore
+.prettier*         export-ignore

.github/workflows/notify-discord.yml

@@ -3,15 +3,16 @@ name: Discord Commit Notifier
 on:
   push:
     branches:
-      - '*'  # triggers on all branches
+      - '*'
 
 jobs:
   notify:
     runs-on: ubuntu-latest
     steps:
-      - name: Discord Commits
-        uses: Sniddl/discord-commits@v1.6
-        with:
-          webhook: ${{ secrets.DISCORD_WEBHOOK }}
-          template: "avatar-with-link"
-          include-extras: true
+      - name: Send commit payload to Discord Bot
+        env:
+          URL: http://${{ secrets.DISCORDBOT }}:3000/github-commits
+        run: |
+          curl -sS -X POST "$URL" \
+            -H 'Content-Type: application/json' \
+            --data-binary "@$GITHUB_EVENT_PATH"

.github/workflows/notify-release.yml

@@ -0,0 +1,71 @@
+name: Discord Release Notifier
+
+on:
+  # Manual or UI-published releases
+  release:
+    types: [published]
+
+  # Releases created by your tag-driven workflow
+  workflow_run:
+    workflows: ["Package & Release"]  # must match the 'name:' in release.yml
+    types: [completed]
+
+permissions:
+  contents: read
+
+jobs:
+  # 1) Handle manual / UI / non-workflow-created releases
+  notify-from-release:
+    if: github.event_name == 'release' && github.event.action == 'published'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Send release payload to Discord Bot
+        env:
+          URL: http://${{ secrets.DISCORDBOT }}:3000/github-releases
+        run: |
+          curl -sS -X POST "$URL" \
+            -H 'Content-Type: application/json' \
+            --data-binary "@$GITHUB_EVENT_PATH"
+
+  # 2) Handle releases created by your 'Package & Release' workflow
+  #    (which won’t trigger `on: release` when using GITHUB_TOKEN)
+  notify-from-workflow-run:
+    if: >
+      github.event_name == 'workflow_run' &&
+      github.event.workflow_run.conclusion == 'success'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install jq
+        run: sudo apt-get update && sudo apt-get install -y jq
+
+      - name: Fetch release JSON by tag
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          set -euo pipefail
+          OWNER="${GITHUB_REPOSITORY%/*}"
+          REPO="${GITHUB_REPOSITORY#*/}"
+          TAG="${{ github.event.workflow_run.head_branch }}"
+          # head_branch is the tag name for a tag push workflow_run
+          curl -fsSL -H "Authorization: Bearer $GH_TOKEN" \
+               -H "Accept: application/vnd.github+json" \
+               "https://api.github.com/repos/$OWNER/$REPO/releases/tags/$TAG" \
+               > release.json
+
+      - name: Wrap as 'release' event payload & notify bot
+        env:
+          URL: http://${{ secrets.DISCORDBOT }}:3000/github-releases
+        run: |
+          set -euo pipefail
+          jq -n --slurpfile rel release.json \
+                --arg repo "$GITHUB_REPOSITORY" \
+                --arg repo_url "https://github.com/$GITHUB_REPOSITORY" \
+                --arg action "published" '
+            { action: $action,
+              repository: { full_name: $repo, html_url: $repo_url },
+              release: $rel[0],
+              sender: { login: "github-actions[bot]" } }' > payload.json
+
+          curl -sS -X POST "$URL" \
+            -H 'Content-Type: application/json' \
+            --data-binary "@payload.json"

.github/workflows/release.yml

@@ -0,0 +1,88 @@
+name: Package & Release
+
+on:
+  push:
+    tags:
+      - "v*"
+      - "*.*.*"
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout (full history)
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Derive vars
+        id: vars
+        shell: bash
+        run: |
+          echo "name=${GITHUB_REPOSITORY##*/}" >> $GITHUB_OUTPUT              # e.g. jim_bridge
+          echo "version=${GITHUB_REF_NAME#v}" >> $GITHUB_OUTPUT               # strip leading v
+
+      - name: Build zip with folder prefix
+        shell: bash
+        run: |
+          NAME='${{ steps.vars.outputs.name }}'
+          VER='${{ steps.vars.outputs.version }}'
+          git archive --format=zip --prefix="${NAME}/" -o "${NAME}-${VER}.zip" "$GITHUB_REF_NAME"
+          ls -lh "${NAME}-${VER}.zip"
+
+      # --- Patch notes generation (commit titles + links) -------------------
+      - name: Find previous tag (SemVer aware)
+        id: prev
+        shell: bash
+        run: |
+          CUR="${GITHUB_REF_NAME}"
+          # Sort tags by version desc, drop the current, take the next newest
+          PREV=$(git tag --sort=-v:refname | grep -v -x "$CUR" | head -n 1 || true)
+          echo "prev=$PREV" >> $GITHUB_OUTPUT
+          echo "Previous tag: ${PREV:-<none>}"
+
+      - name: Generate RELEASE_NOTES.md from commits
+        shell: bash
+        run: |
+          REPO="${{ github.repository }}"
+          CUR="${GITHUB_REF_NAME}"
+          PREV='${{ steps.prev.outputs.prev }}'
+
+          if [ -n "$PREV" ]; then
+            RANGE="$PREV..$CUR"
+            HEADER="## Changes in $CUR"
+          else
+            # First release: include all commits
+            ROOT=$(git rev-list --max-parents=0 HEAD | tail -n 1)
+            RANGE="$ROOT..$CUR"
+            HEADER="## Changes"
+          fi
+
+          {
+            echo "$HEADER"
+            echo
+            # Oldest → newest, subject only, skip merge commits
+            # Escape '[' and ']' so markdown doesn't break on rare titles
+            git log --reverse --no-merges --pretty=format:'- ['%h'] - %s' "$RANGE" \
+              | perl -pe 's/([\[\]])/\\$1/g'
+          } > RELEASE_NOTES.md
+
+          echo "--- RELEASE_NOTES.md ---"
+          cat RELEASE_NOTES.md
+          echo "------------------------"
+
+      - name: Create / Update GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: ${{ github.ref_name }}
+          files: |
+            *.zip
+          body_path: RELEASE_NOTES.md   # attach our generated notes
+          # If you wanted GitHub's auto notes instead, set:
+          # generate_release_notes: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -1,213 +1,28 @@
 # jim-payments
-- QBCore based payment system
-- Enchanced QB-Input payment system from my other scripts now free on its own
+
+## FiveM MuliFramework based payment system
+
+- Highly customisable via config.lua
+  - Locations are easily changeable/removable
+
+- Features:
+  - Payment Tickets for successful payments over a specific amount player can cash in for extra bonus
+  - ATM's become usable, with options to show them on your map when nearby
+  - Adds Ped bank targets where players can manage their bank account balances
+  - Supports police charges
+- Supports
+  - QB-Core
+  - ESX
+  - QBOX
+  - OX_Core
+
+---
+
+# Installation and Usage:
+## [JixelPatterns GitBook Documentation](https://jixelpatterns.gitbook.io/docs)
 
 ### If you need support I have a discord server available, it helps me keep track of issues and give better support.
-## https://discord.gg/xKgQZ6wZvS
+## [JixelPatterns Discord](https://discord.gg/9pCDHmjYwd)
 
-### We also have Documentation over on Gitbook, feel free to check it out
-## https://jixelpatterns.gitbook.io/jixelpatterns-script-guide/overview/who-we-are
-
-### If you think I did a good job here, consider donating as it keeps by lights on and my cat fat/floofy:
-## https://ko-fi.com/jixelpatterns
-
----
-
-- If you use a different phone/invoice system let me know and I will add support for it as best I can!
-  - Currently supported are:
-    - qb-phone
-    - gks-phone
-    - qs-smartphone - Leave the setting as "qb"
-
----
-# Installation
----
-- I always recommend starting my scripts AFTER `[qb]` not inside it as it can mess with any dependancies on server load
-- I have a separate folder called `[jim]` (that is also in the resources folder) that starts WAY after everything else.
-- This ensure's it has everything it requires before trying to load
-- Example of my load order:
-```CSS
-# QBCore & Extra stuff
-ensure qb-core
-ensure [qb]
-ensure [standalone]
-ensure [voice]
-ensure [defaultmaps]
-ensure [vehicles]
-#Extra Jim Stuff
-ensure [jim]
-```
-
----
-## BZZ Terminal Instructions
-
-If you enable Config.General.Usebzzz then the script will use `bzzz_terminal` to automatically create a prop and animation when using the commands:
-- `/cashregister`
-- `/terminal`
-
-This is also available as an item users can use by adding this to your shared items
-```lua
-terminal = { name = 'terminal', label = 'Wireless Terminal', weight = 5000, ["type"] = "item", ["image"] = 'terminal.png', unique = true, useable = true, ["shouldClose"] = true, ["combinable"] = nil, description = '' },
-```
-
-This payment terminal prop is available as a Free Package from https://bzzz.tebex.io/package/5551076
-
----
-## Item installation
-- To make use of the ticket reward system for workers you need to add the ticket item to your shared items lua
-- Naviage to `[qb] > qb-core / shared / items.lua` and add this line
-```lua
-payticket = { name = "payticket", label = "Receipt", weight = 10, type = "item", image = "ticket.png", unique = false, useable = false, shouldClose = false, description = "Cash these in at the bank!" },
-```
-
-- Add the ticket image to your inventory script:
-- Naviage to `[qb] > qb-inventory > html > images` and add this line
-
-![](https://github.com/jimathy/jim-payments/blob/main/images/ticket.png?raw=true)
-
----
-## Phone Setup
-- There are two modes in the script, one that uses the phone for invoices/bank charges
-- The script supports many features like pay tickets, commission payments etc.
-- If you want to use phone systems for these then you need to add the event for when a payment is accepted:
-- REMINDER: IF using phone invoices, the money being added to the society accounts is handled `BY THE PHONE`, not by my script. If money isn't going to the account its the phone system or bossmenu script.
-
-#### QB-Phone:
-- Go to `[qb] > qb-phone > client > main.lua`
- - Search for the event `RegisterNUICallback('PayInvoice', function(data, cb)` and look for the line:
-```lua
-TriggerServerEvent('qb-phone:server:BillingEmail', data, true)
-```
-
-- Directly *above* this line add:
-```lua
-TriggerServerEvent('jim-payments:Tickets:Give', data)
-```
-- The phone should now be integrated with jim-payments
-
-#### GKS-Phone:
-- Go to `gks-phone > server > serverapi.lua`
-- Search for the event: `gksphone:faturapayBill` and search for this line:
-```lua
-  Ply.Functions.RemoveMoney('bank', data[1].amount, "paid-invoice")
-```
-
-- Directly under this line add this event:
-```lua
-TriggerEvent('jim-payments:Tickets:Give', { sender = Ply.PlayerData.charinfo.firstname, senderCitizenId = data[1].sendercitizenid, society = data[1].society, amount = data[1].amount })
-```
-- The phone should now be integrated with jim-payments
-
-#### Renewed QB-Phone:
-- Go to `qb-phone > server > invoices.lua`
-- Search for the event: `qb-phone:server:PayMyInvoice` and search for this line:
-```lua
-TriggerEvent("qb-phone:server:InvoiceHandler", true, amount, src, resource)
-```
-
-- Directly under this line add this event:
-```lua
-TriggerEvent('jim-payments:Tickets:Give', { amount = amount, senderCitizenId = sendercitizenid, sender = SenderPly.PlayerData.charinfo.firstname, society = society }, SenderPly)
-```
-- When invoices are paid, they should now be integrated with jim-payments
-
-# Setup/Config
-
-## Custom Locations
-
-- You can make of this payment system for a job script that wasn't created by me
-- All you need to do is add the job, grab a `vector4` (vector3 + heading) and set if you need a to spawn prop or not
-- For example:
-```lua
-CustomCashRegisters = { -- Located in the config.lua
-  ["burgershot"] = { -- Player job role restriction
-    { coords = vector4(-1185.5, -878.54, 13.91, 305.53), prop = true, }, -- vector4 to place the till and the way it faces
-    { coords = vector4(-1184.34, -880.51, 13.93, 302.04), prop = true, }, -- "prop = true" spawns a prop at the coords
-  },
-},
-```
-### This does not need to be done for MY job scripts, they already have built in support
----
-## PayTickets
-![](https://i.imgur.com/ICbQyeQ.jpeg)
-- This script has a built in ticket reward system
-- On successful sale, the employees will be handed a ticket if they are clocked in
-  - This can then be handed in to the bank to receive payment
-  - Works as a reward and incentive for turning up to do work
-  - The values are set per job in `Config.Jobs`
-- `TicketSystem` Enable this if you want to use the ticket system false
-- `TicketSystemAll` Enable this to give tickets to all workers clocked in
----
-## Commission System
-- Support for commission to be paid as a reward for each successful payment
-- Very customisable with the config.lua
-  - `Commission` Choose wether people get commission from every sale
-  - `CommissionAll` Choose if **EVERY** worker gets Commission that is on duty
-  - `CommissionDouble` Choose if Commission is limited by `MinAmountForTicket`
-  - `CommissionLimit` Choose if the worker charging the customer gets double commission
-
----
-## Multiple Job and Gang Role support
-- The script supports adding job roles to the config so they can get rewards for successful payments
-- This includes Gang roles for stores/bars owned by a gang allowing them to get ticket rewards and commission
-- Examples of adding jobs / gangs to config.lua:
-```lua
-Jobs = {
-	['mechanic'] = { MinAmountforTicket = 1000, PayPerTicket = 500, Commission = 0.10, },
-	['lostmc'] = { MinAmountforTicket = 50, PayPerTicket = 50, Commission = 0.10, gang = true, },
-},
-```
-- `MinAmountforTicket` is the amount required in a charge before they can get a ticket
-- `PayPerTicket` is the amount paid per ticket at the bank for the job role
-  - I personally recommend this being lower than `MinAmountforTicket`, being too high makes it exploitable
-- `Commission` is the amount of commission given to players on successful payments (0.10 = 10%)
-- `gang = true` add this if the added role is a gang role
----
-## /cashgive
-![](https://i.imgur.com/AIdXzxX.jpeg)
-- Alternative to /givecash
-- A simple command built in to send cash to a `nearby player`
-- Shows a list of names and id's of people nearby to select from rather
-- Better experience than trying to figure out their ID and entering it manually
----
-## /cashregister
-![](https://i.imgur.com/37d2mE3.jpeg)
-- This command is mean't as a portable cash register alternative
-- For example:
-  - When a person is devliering food they can do `/cashregister` and the payment will still be sent to the society account
-- Doesn't utilize the ticket reward system unfortunately
----
-## /polcharge
-- This script supports a customisable "police billing"
-- This is the ability for selected jobroles to charge a nearby player
-- Depending on how you've set it up, this can take money directly from the players bank to the job's society account
-- This is by default enabled for `police` and `ambulance`
-- This also supports giving the player a cut of the payment as `commission`
-  - Default Config:
-```lua
-FineJobs = {
-  ['police'] = { Commission = 0.25, },
-  ['ambulance'] = { Commission = 0.25, },
-},
-FineJobConfirmation = false, -- "true" makes it so fines need confirmation, "false" skips this ands just removes the money
-FineJobList = true, -- "true" to use nearby player list feature in the cash registers, "false" for manual id entry
-```
----
-## Banking
-![](https://i.imgur.com/RYADcI2.jpeg)
-- This script has simple banking systems built in
-  - Works as a basic replacement for qb-banking and qb-atms
-- Adjust the options in config.lua:
-  - `useATM` Choose wether to make atm's usable
-  - `useBanks` Choose wether to make bank desks/teller's usable
-  - `BankBlips` Enable this if you disabled qb-banking and need bank locations
-  - `ATMBlips` Enable this if you are a pyscho and need every ATM to be on the map too
-  - `Gabz` Enable to change to Gabz Bank locations, this corrects the ATM/Bank Cashier + Ticket Cash in
----
-
-### Renewed's qb-phone
-  - Simply leave the Config.PhoneType as `"qb"`
-
-### AP-Goverment
-- Support for AP-Goverment Tax on payments
-- Toggle `ApGov` in the config.lua to enable this
+### If you think I did a good job here, consider donating as it keeps by lights on and my cat round:
+## [JixelPatterns Kofi](https://ko-fi.com/jixelpatterns)

client/charge.lua

@@ -3,23 +3,22 @@ local Till = {}
 
 function spawnCustomRegisters()
     Wait(1000)
-	for k, v in pairs(Config.CustomCashRegisters) do
-		for i = 1, #v do
-			local job, gang = v[i].gang and nil or k, v[i].gang and k or nil
-            createBoxTarget({"CustomRegister: "..k..i, v[i].coords.xyz, 0.47, 0.34, { name="CustomRegister: "..k..i, heading = v[i].coords[4], debugPoly=debugMode, minZ=v[i].coords.z-0.1, maxZ=v[i].coords.z+0.4}}, {
-                {
-                    action = function()
-                        TriggerEvent(getScript()..":client:Charge", { job = job, gang = gang, img = ""})
-                    end,
+    for k, v in pairs(Config.CustomCashRegisters) do
+        for i = 1, #v do
+            local job, gang = v[i].gang and nil or k, v[i].gang and k or nil
+            local img = v.img or v[i].img
+            createBoxTarget({"CustomRegister: "..k..i, v[i].coords.xyz, 0.47, 0.34, {name="CustomRegister: "..k..i, heading = v[i].coords[4], debugPoly = debugMode, minZ = v[i].coords.z-0.1, maxZ = v[i].coords.z+0.4}}, {
+				{
+                    action = function() TriggerEvent(getScript()..":client:Charge", {job = job, gang = gang, img = img}) end,
                     icon = "fas fa-credit-card",
-                    label = locale("target", "charge"),
+                    label = locale("target","charge"),
                     job = job,
                     gang = gang
                 }
-            }, 2.0)
-			if v[i].prop then makeProp({prop = "prop_till_03", coords = v[i].coords + vec4(0,0,1.0, 0.0)}, 1, false) end
-		end
-	end
+			}, 2.0)
+            if v[i].prop then makeProp({prop = "prop_till_03", coords = v[i].coords+vec4(0,0,1.0, 0.0)}, 1, false) end
+        end
+    end
 end
 
 onPlayerLoaded(function() spawnCustomRegisters() end, true)
@@ -311,4 +310,6 @@ RegisterNetEvent(getScript()..":client:PayPopup", function(amount, biller, billt
             })
         end,
     })
-end)
+
+end)
+

config.lua

@@ -1,6 +1,6 @@
 -- If you need support I now have a discord available, it helps me keep track of issues and give better support.
 
--- https://discord.gg/xKgQZ6wZvS
+-- https://discord.gg/9pCDHmjYwd
 
 Config = {
 	Lan = "en",
@@ -30,7 +30,7 @@ Config = {
 
 		PaymentRadius = 15, 	-- This is how far the playerlist will check for nearby players (based on the person charging)
 
-		Usebzzz = true, 		-- enable if you're using the prop from bzzz
+		Usebzzz = false, 		-- enable if you're using the prop from bzzz
 
 		Enablecommand = true, 	-- Enables the /cashregister command
 
@@ -84,6 +84,7 @@ Config = {
 
 	CustomCashRegisters = {
 		--	["jobname"] = { -- Player job role restriction
+		--      img = "https://i.ibb.co/HfVy87fW/image.png", -- url to image file
 		--		{ coords = vector4(0, 0, 0, 0), }, -- vector4 to place the till and the way it faces
 		--		{ coords = vector4(0, 0, 0, 0), prop = true, }, -- "prop = true" spawns a prop at the coords
 		--	},
@@ -166,4 +167,5 @@ function locale(section, string)
     if not localTable[section] then return "["..section.."] Invalid" end
     if not localTable[section][string] then return "["..string.."] Invalid" end
     return localTable[section][string]
-end
+
+end