Install Banner Apartments

1. Download the complete resource#

After purchase fulfillment, download Banner Apartments through the entitled Cfx account. Extract the complete processed resource into a folder named XSC_BannerHotel inside your server's resources directory. Keep the .fxap file and protected client/server files together.

Back up the existing configuration and database before upgrading. Replace the existing resource through your normal maintenance process; avoid starting a second copy alongside it.

resources/
└── XSC_BannerHotel/
    ├── fxmanifest.lua
    ├── config.lua
    ├── client/
    ├── server/
    ├── data/
    └── sql/

2. Start dependencies before Banner Apartments#

1. Install your supported QB or QBX framework and oxmysql using their own required database and dependency setup. QBX needs the QB core-object compatibility bridge.
2. Start ox_lib, ox_target, ox_inventory, and ox_doorlock in the order required by your existing framework setup.
3. Install and start Riot's Banner Hotel interior, using the map's actual resource name and installation instructions.
4. Start the appearance resource selected in Config.Clothing.Provider.
5. Start XSC_BannerHotel after all of the above.

# Your framework, database, ox dependencies, and Riot map start above.
# This example uses the default wardrobe provider.
ensure sn_appearance
ensure XSC_BannerHotel

If you select illenium-appearance instead, start that resource in place of sn_appearance. You only need the selected provider; the illenium saved-outfit integration does not require installing qb-clothing.

3. Set your server's integration choices#

• Set Config.Framework.Mode and the QB/QBX resource names to match your framework. The default auto mode prefers QBX when available.
• Set Config.Admin.Ace and QbPermission to your staff permission setup. Replace AdditionalAces, or use an empty table to remove inherited aliases.
• Select the wardrobe provider in Config.Clothing.Provider.
• Set Config.Supporter.Enabled to false if you do not use a compatible supporter storage-bonus provider.
• Leave lobby teleporting disabled until you have verified the destination coordinates for your installed map.

-- Edit these fields in the supplied configuration.
Config.Clothing.Provider = 'illenium-appearance'
Config.Supporter.Enabled = false
Config.Admin.AdditionalAces = {}

4. Initialize the database and rooms#

On startup, the resource creates the xsc_banner_rooms, xsc_banner_leases, and xsc_banner_lost_items tables through oxmysql. The database account must be able to create those tables. The supplied sql/bannerhotel.sql is available if you manage schema installation manually.

With the default import settings, data/rooms.json is imported when the room table is empty. It contains the 450 room definitions. Existing room definitions are preserved because automatic overwrite is disabled.

5. Prepare the room doorlocks#

The resource can create missing doorlocks through a compatible ox_doorlock createDoorlock server export. Stock installations without that export use an online administrator's doorlock editor permission as the fallback.

1. Give the installing administrator your configured Banner command access and command.doorlock permission using your server's permission system.
2. Have that administrator join the server and run /banner_syncdoors in game.
3. Verify room locks were created and that the assigned character can access their own room.
4. Check access with a second character before opening the hotel to players.

/banner_syncdoors

6. Check the player experience#

• Load a character and run /room to confirm an assigned room.
• Use the room's door, storage, and saved-outfit wardrobe.
• Use the elevator's lobby, floor, and My Room Floor choices.
• Reconnect within the default ten-minute window and check the room and stored items.
• Restart the resource during testing, reconnect, and check lease recovery and personal storage again.