Setup and Installation

Looking to setup StaffWatch for your community? This guide is designed to walk developers through the process of setting up StaffWatch from start to finish.

Create your account

1. Fill out the required fields on the registration page to create your account.

2. After creating your account, login using the email and password you created

3. You should receive a verification email in your inbox within 1-15 minutes

4. Click the link in the verification email to verify your account

5. After verifying your account, you should be able to successfully login

Don't forget to check your spam/junk folder if you can't find the verification email!

Add your community

1. Open the Community Manager and select Create Community

2. Enter the name for your community, and select FiveM

3. Click the Create community button

1. Now, using the community switcher in the top-left, switch to your new community

Note: This guide only covers the basic configurations needed to get StaffWatch running. We recommend exploring all of the controls under Settings to fully customize your community's experience!

Add your servers

1. Navigate to the Manage Servers page and select Create Server

2. Enter the name of the server, and click the button to create the server

3. After creation, you can hover your mouse over the server secret to reveal it

4. The server secret will be required later to configure the in-game resource

Do not share your server secret with anyone except trusted developers installing the FiveM resource!

Invite your staff team

Staff members can be added to the panel manually via their StaffWatch usernames, or using Discord permission sync if your community is on an eligible plan. To improve the on-boarding process, you may also want to send your staff members a link to our Guide for Staff Members.

Manually Add Staff (Free/Basic)

1. Ensure the staff member has already created a StaffWatch account.

2. Navigate to the Manage Staff page, and click the Add Staff Member button

3. Enter the user's StaffWatch username, and choose a role to assign them

Setup Discord Permission Sync (Premium/Pro)

1. Navigate to the Manage Community page and fill in the Discord Server ID field.

2. Also set Enable Discord Permissions Sync to Enabled on this page

3. Add our Discord Bot to your community's Discord server.

4. Use the /link command in the Discord bot and enter your server's access code

5. Edit each role on the Manage Permissions page and ensure the Discord Role ID is set

6. Make sure your staff team create a StaffWatch account and link their Discord!

7. Wait up to 10 minutes for permissions to sync.

To speed up the sync process, you can remove the user's staff role in Discord and re-add it after a few seconds. Ensure the user has created a StaffWatch account and linked their Discord under My Account.

Install the integration resource

Navigate to the download page linked below to install the FiveM resource. Follow the instructions available in the README.md file. The installation is the same as all other FiveM resources, just make sure you fill in the required values in the config file.

Downloads

You're all set!

After starting the resource, your server's player count should display in StaffWatch. Once you click on the server in the sidebar, you should be presented with a list of in-game players. At this point the panel should be fully functional, but there are still many other features you can setup under settings.