Getting Started

Getting Started with the RELICSxyz Player

Welcome to the RELICSxyz Player integration guide! Here, we'll walk you through the basic steps to show, hide, and conditionally enable the player using the PlayerChecker module. Let's get started!

1. Copying the Required Files

To begin, you'll need to copy two essential files into your project:

• Copy the file RelicsxyzFavorites.lua to the ServerScriptService folder of your project. This ensures that the necessary functionalities related to favorites are available for integration.

• Import the relicsxyz-player.rbxmx into your project. This file contains the main player and its associated logic, which is crucial for the functionality of the RELICSxyz Player.

2. Setting Up the Modules

Once the files are in place, ensure you have the required modules set up. For this guide, we'll be working with the AudioPlayer and PlayerChecker modules.

local AudioPlayer = require(game.ServerScriptService.AudioPlayer)  -- Adjust the path as necessary
local PlayerChecker = require(game.ServerScriptService.PlayerChecker)  -- Adjust the path as necessary

3. Showing and Hiding the Player

To show or hide the RELICSxyz Player, you can use the ToggleVisibility function from the AudioPlayer module:

-- Toggle the visibility of the RELICSxyz Player
AudioPlayer.ToggleVisibility()

4. Conditionally Enabling the Player

To conditionally enable the player based on certain items a player has, you can use the CanToggleVisibility function from the PlayerChecker module:

local player = game.Players.LocalPlayer  -- For LocalScripts. For ServerScripts, you'd get the player differently.

if PlayerChecker.CanToggleVisibility(player) then
    AudioPlayer.ToggleVisibility()  -- This will only run if the player has one of the allowed items.
else
    warn("You do not have the required item to toggle the RELICSxyz Player!")
end

5. Adding Allowed Items

To grant players the ability to toggle the RELICSxyz Player based on specific items they possess, you'll need to update the allowedItems list within the PlayerChecker module:

local allowedItems = {
    "ItemName1",  -- Replace with your item's name
    "ItemName2",  -- Replace with another item's name
    -- Add more items as needed
}

6. Wrapping Up

With the steps outlined above, you should now have a foundational understanding of how to integrate and control the RELICSxyz Player in your game. If you encounter any challenges or have further questions, don't hesitate to reach out.