> For the complete documentation index, see [llms.txt](https://poseidon-2.gitbook.io/poseidon-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://poseidon-2.gitbook.io/poseidon-docs/scripts/pos-housing/installation.md). # Installation ## POS-Housing Property Management System ## Framework Independent Welcome to the complete installation guide for POS-Housing. This advanced property management system provides comprehensive housing functionality for your RedM server and works seamlessly with the POS ecosystem. *** ## Prerequisites
📋 Prerequisites Before beginning the installation process, ensure you have: * **POS-Core** properly installed and running (required) * **POS-DoorLocks** properly installed and running (required) * **Server access** with file modification permissions * **Keymaster** access for script downloads * **Recent server backup** (highly recommended) * **Database access** for table import {% hint style="danger" %} **Critical Requirements**: Both POS-Core and POS-DoorLocks must be installed before POS-Housing. POS-Housing depends on both scripts for core functionality and door management. {% endhint %}
*** ## Installation Steps
🚀 Step 1: Verify POS Dependencies Installation Before installing POS-Housing, ensure both required dependencies are properly installed: 1. Navigate to your `resources/[POS]/` folder 2. Verify that both `POS-Core` and `POS-DoorLocks` folders exist 3. Check that both scripts are running without errors in your server console ``` resources/ └── [POS]/ ├── POS-Core/ ← This must exist └── POS-DoorLocks/ ← This must also exist ``` {% hint style="warning" %} **Important**: If either POS-Core or POS-DoorLocks is not installed, please install them first before proceeding with POS-Housing. POS-Housing requires both dependencies for proper door management and core functionality. {% endhint %}
📦 Step 2: Download and Install POS-Housing Download and install the POS-Housing script: 1. Access your **Keymaster** account 2. Download the **POS-Housing** script 3. Extract the downloaded files 4. Place the `POS-Housing` folder inside your `[POS]` directory ``` [POS]/ ├── POS-Core/ ├── POS-DoorLocks/ └── POS-Housing/ ← Add this folder ```
🗄️ Step 3: Import Database Tables {% hint style="danger" %} **Critical Database Step**: The script requires specific database tables to function properly. {% endhint %} Import the required database structure: 1. Navigate to the `[POS]/POS-Housing/sql/` folder 2. **Open** your database management tool (phpMyAdmin, HeidiSQL, etc.) 3. **Select** your server's database 4. **Import** or **execute** the SQL file(s) found in the sql folder ```sql -- Example: Execute the SQL file in your database -- This will create the necessary tables for POS-Housing ``` {% hint style="info" %} **Database Tools**: You can use phpMyAdmin, HeidiSQL, MySQL Workbench, or the command line to execute the SQL files. {% endhint %} **Verify Database Import:** * Check that new tables have been created in your database * Look for tables with names starting with `pos_housing_` or similar * Ensure no errors occurred during the import process
🔧 Step 4: Update Server Configuration Configure your server.cfg with the proper load order: 1. Open your `server.cfg` file 2. **Add** `ensure POS-Housing` after both POS-Core and POS-DoorLocks: ```cfg # POS Scripts ensure POS-Core ensure POS-DoorLocks ensure POS-Housing ← Add this line here ``` {% hint style="warning" %} **Load Order is Critical:** Make sure POS-Housing loads after both POS-Core and POS-DoorLocks. The dependency order must be: POS-Core → POS-DoorLocks → POS-Housing. {% endhint %}
⚙️ Step 5: Configure POS-Housing Configure POS-Housing to your liking: 1. Navigate to `resources/[POS]/POS-Housing/shared/config.lua` 2. **Review** and **modify** the configuration settings as needed 3. **Configure** the following key settings: * **House Types**: Define different house categories and their features * **Furniture System**: Configure furniture categories and items * **Locksmith System**: Set up locksmith locations and pricing * **Blips**: Configure map markers for different property types * **Access Control**: Set up job and permission restrictions * **Discord Webhooks**: Set up logging for housing activities * **Commands**: Admin commands for house management 4. **Save** your changes ```lua Config.HouseTypes = { [1] = { stash = 500, furniture = { outfit = false, stash = true, phone = false, crafting = false, }, farming = false, }, [2] = { stash = 1000, furniture = { outfit = false, stash = true, phone = false, crafting = false, }, farming = false, }, [5] = { stash = 2500, furniture = { outfit = true, stash = true, phone = true, crafting = true, }, farming = true, }, } Config.Locksmith = { enableNpc = true, Jobs = { 'police', }, Items = { stash = 'cheie_cufar', house = 'cheie_casa', door = 'cheie_usa', locksmith = 'mdt', }, Positions = { vector4(2715.8452, -1194.2130, 50.6709, 104.6428) }, } ``` 5. **Navigate** to `resources/[POS]/POS-Housing/shared/furniture.lua` 6. **Configure** furniture categories and items: ```lua Config.Furniture = { distance = 400, max = 50, returnToPlayer = true, returnMoneyPercentage = 0.5, furnitureType = 3, -- 1 = items, 2 = menu, 3 = both stores = { [1] = { mainCoords = vector4(2626.0398, -1442.5376, 45.4752, 278.9376), categories = { [1] = { name = "TABLES", furniture = { [1] = { item = "kitchencounter", prop = "p_kitchenhutch01x", itemType = "normal", price = 350 }, [2] = { item = "p_table02x", prop = "p_table02x", itemType = "normal", price = 210 }, } }, [5] = { name = "STORAGE", furniture = { [1] = { item = "bookcase", prop = "p_cabinetdoctor01x", itemType = "stash", price = 200 }, [2] = { item = "p_nbmbookshelves01x", prop = "p_nbmbookshelves01x", itemType = "stash", price = 250 }, } }, } } } } ``` 7. **Navigate** to `resources/[POS]/POS-Housing/shared/config.js` 8. **Configure** the language settings: ```javascript TR = { LANG: 'EN', EN: { OWNER: "Owner", PERSONAL: "Personal", SALE: "Sale", }, } ``` {% hint style="info" %} **Configuration**: Review all available options in the config files and adjust them to match your server's needs. This includes house types, furniture systems, locksmith settings, and UI language. {% endhint %}
*** ## Post-Installation Verification
✅ Post-Installation Verification **Testing Your Installation** 1. **Start your server** and monitor the console for errors 2. **Join with a test character** and verify: * No console errors related to POS-Housing * POS-Core integration working properly * POS-DoorLocks integration working properly * Database connections established * House creation commands work * Furniture system responds correctly * Locksmith system functions properly * Housing UI displays correctly * Door management works with houses **Common Success Indicators** * ✅ No console errors related to POS-Housing * ✅ POS-Core integration messages appear in console * ✅ POS-DoorLocks integration working properly * ✅ Database tables are accessible * ✅ Houses can be created and managed * ✅ Furniture system works correctly * ✅ Locksmith system functions properly * ✅ House buying and selling works * ✅ Access control systems function * ✅ Door locking/unlocking works with houses * ✅ Discord webhooks send notifications (if configured) * ✅ Server starts without POS-Housing related errors
*** ## Troubleshooting
🔧 Troubleshooting **Common Issues** **Console Errors About Load Order** * Verify POS-Housing is loaded after both POS-Core and POS-DoorLocks * Check that both POS-Core and POS-DoorLocks are running without errors * Ensure the load order is: POS-Core → POS-DoorLocks → POS-Housing **Database Connection Issues** * Confirm database settings are properly configured * Check that all SQL files were imported successfully * Verify database tables exist and have correct permissions **POS-Core Integration Issues** * Ensure POS-Core is properly installed and running * Check that POS-Core loads before POS-Housing * Verify POS-Core configuration is correct **POS-DoorLocks Integration Issues** * Ensure POS-DoorLocks is properly installed and running * Check that POS-DoorLocks loads before POS-Housing * Verify POS-DoorLocks configuration is correct * Test door functionality independently **House Creation/Management Issues** * Check admin permissions for house management commands * Verify house coordinates are correctly set * Test house interaction distance settings **Door Management Issues** * Verify POS-DoorLocks is functioning properly * Check that house doors are properly registered * Test door locking/unlocking functionality **Furniture System Problems** * Check furniture configuration in furniture.lua * Verify furniture store locations and coordinates * Test furniture placement and removal **Locksmith System Issues** * Verify locksmith NPC spawns correctly * Check locksmith item configurations * Test key generation and usage **Access Control Problems** * Check job and permission configurations * Verify house access lists work correctly * Test tenant management system **Discord Webhook Issues** * Verify webhook URLs are correct and active * Check Discord server permissions * Test webhook functionality independently **Getting Support** If you encounter issues not covered here: 1. **Check Console**: Look for specific error messages 2. **Verify Steps**: Ensure each installation step was completed 3. **Check POS-Core**: Ensure POS-Core is working properly 4. **Check POS-DoorLocks**: Ensure POS-DoorLocks is working properly 5. **Test Database**: Verify database operations are working 6. **Contact Support**: Reach out with console logs and specific error descriptions
*** ## Final Notes
📝 Final Notes & Next Steps {% hint style="success" %} **Installation Complete!**\ Your POS-Housing property management system is now installed and ready for use. {% endhint %} **Important Reminders** * POS-Housing depends on both POS-Core and POS-DoorLocks - ensure both are always running * Keep your database backup safe for recovery purposes * Monitor server performance after installation * Regular backups are essential for server stability * Test housing functionality thoroughly before going live **Next Steps** * Configure house types to match your server's economy * Set up furniture stores in appropriate locations * Configure locksmith locations and pricing * Set up Discord webhook notifications for housing activities * Train your staff on the new housing management system * Review documentation for advanced configuration options Your RedM server now has a comprehensive property management system that integrates seamlessly with the POS ecosystem!
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://poseidon-2.gitbook.io/poseidon-docs/scripts/pos-housing/installation.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.