Skip to content

iboss21/LXR-IDCard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

24 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿบ The Land of Wolves - ID Card System

An immersive, premium-quality citizenship ID card system for RedM servers using RSG-Core framework.

Framework Version RedM

Version 3.0 - Enhanced with advanced features and integrations! ๐ŸŽ‰


โœจ Overview

The Land of Wolves IDCard script transforms citizenship into an engaging roleplay experience. Players must photograph themselves, submit detailed applications, and await admin approval before earning full citizenship statusโ€”complete with a beautifully animated approval stamp.

๐ŸŽฏ Key Features

  • Multi-Stage RP Flow: Photo โ†’ Application โ†’ Review โ†’ Citizenship
  • Stunning Wolf-Themed UI: Aged parchment, Victorian gold borders, wolf emblems
  • Discord Integration: Automated admin notifications with webhook
  • Two-Tier ID System: Resident Permit (pending) vs Citizenship Card (approved)
  • Animated Stamp Reveal: Dramatic red approval stamp for citizens
  • Database Persistence: MySQL storage for all applications
  • Admin Commands: Easy approval/denial system
  • Fully Configurable: Locations, fees, text, cooldowns

๐Ÿ†• NEW ROADMAP FEATURES (v2.0):

  • ๐Ÿ“ธ Camera Integration: Real player mugshots on ID cards
  • ๐Ÿ‘ฅ ID Inspection: Players can inspect each other's IDs
  • ๐Ÿ”„ ID Replacement: Lost/stolen ID replacement system ($150, 24hr cooldown)
  • ๐Ÿ“… Expiration & Renewal: 30-day ID validity with renewal system
  • โญ Citizenship Tiers: Basic ($50), Premium ($150), Elite ($500) with unique benefits
  • ๐Ÿ“Š Statistics Dashboard: Admin dashboard tracking all system metrics

๐ŸŽ‰ NEW v3.0 FEATURES:

  • ๐ŸŽฅ Actual Webcam Integration: Real player photos using HTML5 webcam API
  • ๐ŸŽจ Photo Filters & Editing: Professional photo editing with 5 filters
  • ๐ŸŽด Multiple ID Designs: Tier-specific card templates (up to 4 designs per tier)
  • ๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Family Tier Packages: Discounted citizenship for families (20% off)
  • ๐Ÿ‚ Seasonal Bonuses: Special bonuses based on seasons (5-25% discounts)
  • ๐Ÿ“ˆ Advanced Statistics: Charts, graphs, and data exports (CSV/JSON)
  • ๐ŸŒ Multi-Language Support: 5 languages (EN, ES, FR, DE, PT)
  • โš™๏ธ Custom Tier Creation: Create unlimited custom tiers via config
  • ๐Ÿ”Œ Tier Perks API: Integration API for shops, jobs, and properties
  • ๐Ÿ’ผ Job System Integration: Job requirements and pay bonuses by tier
  • ๐Ÿ  Property Integration: Property ownership limits and discounts by tier
  • โš–๏ธ Criminal Records: Criminal history affects citizenship approval

๐Ÿ“š Documentation

All documentation has been organized into the docs folder for easy navigation:


๐Ÿ“ธ Preview

Coming Soon: Screenshots of the application form and ID cards


๐Ÿš€ Quick Start

Requirements

  • RSG-Core
  • rsg-inventory (ox_inventory based)
  • ox_lib
  • ox_target
  • oxmysql

Installation

  1. Clone the repository

    cd resources
    git clone https://github.com/iboss21/LXR-IDCard.git tlw_idcard
  2. Add items to inventory (see Installation Guide)

  3. Configure locations and webhook in config.lua

  4. Add to server.cfg

    ensure tlw_idcard
    
  5. Restart server

๐Ÿ“– Full installation guide: docs/getting-started/INSTALL.md


๐ŸŽฎ How It Works

For Players

Basic Flow:

  1. Visit a Photographer (map blip) and take a mugshot ($20)
  2. Go to Government Office (map blip) and submit citizenship application
  3. Choose your tier: Basic ($50), Premium ($150), or Elite ($500) ๐Ÿ†•
  4. Receive Resident Permit (pending approval)
  5. Wait for admin to review application
  6. Once approved, permit upgrades to Citizenship Card with official stamp
  7. Use ID card from inventory to show your status

๐Ÿ†• New Features:

๐Ÿ“ธ Mugshot Photos

  • Real camera system captures your character
  • Photo appears on your ID card
  • Replaces generic placeholder

๐Ÿ‘ฅ ID Inspection

  • Target nearby players with ox_target
  • Request to inspect their ID
  • They can accept or deny your request
  • View their full ID information

๐Ÿ”„ ID Replacement

  • Lost your ID? Visit government office
  • Pay $150 replacement fee (higher than original)
  • 24-hour cooldown between replacements
  • Maximum 5 replacements allowed

๐Ÿ“… Expiration & Renewal

  • IDs expire after 30 days
  • Warning notifications 7 days before expiration
  • Renew at government office for $75
  • Extends validity for 30 more days

โญ Citizenship Tiers

  • Basic ($50): Standard rights and services
  • Premium ($150): Priority service + 10% discounts
  • Elite ($500): VIP status + 25% discounts + exclusive access
  • Upgrade your tier anytime at government office
  • Get 50% refund of previous tier when upgrading

For Admins

  1. Receive Discord notification when player applies
  2. Review application details including tier selection
  3. Use /approveid [playerid] to grant citizenship
  4. Use /denyid [playerid] to reject application
  5. ๐Ÿ†• Use /idstats to view comprehensive statistics dashboard
  6. Player's ID automatically upgrades with stamp overlay

๐Ÿ†• Statistics Dashboard includes:

  • Total applications, approvals, denials
  • Pending applications count
  • ID replacements and renewals
  • Citizenship tier distribution with charts
  • All metrics tracked automatically

โš™๏ธ Configuration Highlights

-- Customize locations
Config.PhotographerLocations = { ... }
Config.GovernmentOffices = { ... }

-- Set fees
Config.PhotoFee = 20.0
Config.ApplicationFee = 50.0

-- Discord webhook
Config.Discord.webhook = 'YOUR_WEBHOOK_URL'

-- Customize all text
Config.Locale = { ... }

๐ŸŽจ UI Design Philosophy

The UI embraces a dark western frontier aesthetic:

  • Parchment textures with aged stains and tears
  • Wolf claw scratch marks in corners
  • Victorian gold borders with wolf head motifs
  • Cinzel Decorative and IM Fell English fonts
  • Animated stamp reveal for approved citizens
  • Responsive design for various resolutions

๐Ÿ› ๏ธ Tech Stack

  • Framework: RSG-Core (RedM)
  • Inventory: rsg-inventory / ox_inventory
  • UI Library: ox_lib
  • Targeting: ox_target
  • Database: oxmysql
  • Frontend: HTML5, CSS3 (Google Fonts), Vanilla JS
  • Integration: Discord Webhooks

๐Ÿ“‹ Commands

Command Permission Description
/approveid [id] admin Approve citizenship application
/denyid [id] admin Deny citizenship application
/idstats admin View system statistics dashboard ๐Ÿ†•
/idlanguage all Change UI language (v3.0) ๐Ÿ†•
/createtier admin Create custom citizenship tier (v3.0) ๐Ÿ†•

๐Ÿ› Troubleshooting

Items not showing up?
Make sure you've added the items to your inventory config and registered usable items.

NUI not displaying?
Check F8 console for errors. Ensure all files are in the correct directories.

Discord webhook not working?
Verify your webhook URL in config.lua and ensure it's not set to the placeholder.

Enable debug mode for detailed logs:

Config.Debug = true

๐Ÿค Contributing

Contributions are welcome! Please:

  1. Fork the repository
  2. Create a feature branch
  3. Submit a pull request with detailed description

๐Ÿ“„ License

Open source - feel free to modify and redistribute.


๐Ÿ’ฌ Support & Community


๐ŸŒŸ Showcase

Using this script on your server? Let us know! We'd love to feature your community.


๐Ÿ”ฎ Roadmap

v2.0 Features โœ… (Complete):

  • Camera script integration for real mugshots โœ…
  • ID inspection by nearby players โœ…
  • Lost/stolen ID replacement system โœ…
  • Citizenship expiration/renewal โœ…
  • Multiple citizenship tiers โœ…
  • Statistics dashboard โœ…

v3.0 Features โœ… (Complete):

  • Actual webcam integration โœ…
  • Photo filters and editing โœ…
  • Multiple ID card designs per tier โœ…
  • Family tier packages โœ…
  • Seasonal tier bonuses โœ…
  • Advanced statistics (charts, graphs, exports) โœ…
  • Multi-language support โœ…
  • Custom tier creation via config โœ…
  • Tier-specific perks API โœ…
  • Integration with job systems โœ…
  • Integration with property systems โœ…
  • Criminal record integration โœ…

Future Considerations:

  • Integration with additional frameworks
  • Mobile-responsive UI improvements
  • AI-powered photo enhancement
  • Blockchain-based verification

๐Ÿ“– See docs/development/ROADMAP_IMPLEMENTATION.md for complete feature documentation

๐Ÿ”„ Upgrading? See docs/guides/MIGRATION_GUIDE.md for migration instructions


Made with โค๏ธ for the RedM roleplay community
The Land of Wolves - Where only the strong survive ๐Ÿบ

About

The Land of Wolves - ID Card System

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages