/bnl-housing

A modern, free, standalone FiveM property script

Primary LanguageLuaGNU General Public License v3.0GPL-3.0


A player property resource for FiveM.
Report a Bug · Request a Feature · Join my Discord

Warning
The project is not finished, and should not be used in production.
No support will be given until release.

About The Project

A player property resource that allows you to purchase, sell, decorate, store your vehicles, and more. This script is currently standalone and does not require a framework. However in the future I'm planning on adding support for the major frameworks.

If you're looking for the docs or commands you can find them here (for now)

Dependencies

  1. ox_lib
  2. oxmysql
  3. baseevents

Installation

  • Be sure to download the latest release of the resource, it's always good to stay up to date.
  • Place it somewhere inside the resources directory
  • Add the resource to your server.cfg after dependencies to make sure it's started correctly at server startup:
ensure bnl-housing
  • Lastly, insert bnl_housing.sql into your database.

If you incounter any issues downloading, you can ask for help in my discord.

(back to top)

  • FAQ:

  1. Where can I get the property shells? https://mega.nz/file/G01QxIJL#ctLH4cz46Kqyo8V2dTCCSMYS6ii1GB85qXX1LYt34Wg

  2. How can I give myself admin perms? To give yourself "bnl-housing:admin" permission, you need to add it to your Ace permissions in the server.cfg file. Open the file and add the following line: add_principal identifier.steam:[your steam id] "bnl-housing:admin" allow, replacing [your steam id] with your actual Steam ID.

Alternatively, if you have an admin group you can add the ace to that: add_ace group.admin "bnl-housing:admin" allow

Roadmap

  • Ownable properties
  • Share keys
    • Give spare keys to players
    • Take spare keys from players
  • Invite players inside
  • Knock on doors of properties
  • Locale support
    • Dutch (NL)
    • English (EN)
    • French (FR)
    • German (DE)
  • Logging out in properties
  • Decorate properties
    • Normal props
      • Tooltips for controls
    • Special props that do things when near like a storage container or laptop
      • Safe with codelock
      • Example prop
    • Add qtarget support for special props
  • Park vehicles in garages or warehouses
    • Enter properties with vehicles
    • Save them
    • Idea: Max vehicle count per shell
    • Passengers enter property
    • Check for space before enter
  • Break in / lockpick
  • Unlock property so anyone is free to enter
  • Code lock option for front door
  • Police raid
  • Property selling
    • Rent out property
  • Realtor job
  • Property blips
    • Working
    • Improve performance
      • Make it even better
    • Correct Sprite for different property types
  • Property Addresses borisnliscool#6
  • Routing buckets

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

(back to top)

Contact

@borisnl - boris@borisnl.nl

Project Link: https://github.com/borisnliscool/bnl-housing

(back to top)

Acknowledgments

Thanks to all contributors and testers especially @CasperV06 & @pimiscool for helping me test.