Setup & Operation Guide

Setting up the Xash Contest Board requires just a few simple steps. Make sure your main Xash Server is active before starting.

Setup

Rez the Xash Contest Board in your venue.

The contest board comes as a plain board on purpose, allowing you to match its appearance to your venue.

Design a frame for your contest board if you'd like to give it a more finished look.

Go to your Xash web page by either clicking Manage Club on your Xash Server or by clicking the board and selecting Club Profile in the menu.

On the Xash web page, navigate to the Contest Board page to configure your contest board.

Configuration Options

The following settings are configured on your Xash Web dashboard:

1. Configuration Panel

  • Default Prize: The base L$ amount contributed to the pot by the club when a contest starts.
  • Allow only present avatars to win: If enabled, the board will scan the region when voting starts and automatically remove registered contestants who are offline or have left the region.
  • Allow only group members to participate: If enabled, only guests with the land/club group active can join the contest as contestants.
  • Voting Access: Controls who is allowed to vote:
    • Everyone: All visitors can vote.
    • Group members only: Only visitors with the land/club group active can vote.
    • Staff only: Only authorized staff and management can vote.
  • Maximum votes per person: The maximum number of votes a single visitor can cast (range 1–10).
  • Allow voting for one person multiple times: If enabled, a single voter can cast more than one of their maximum votes for the same contestant.
  • Prize Mode: Determines how the final prize pot is split:
    • Winner Takes All: 1st place receives 100% of the pot.
    • Top 3: Split among 1st, 2nd, and 3rd place based on custom percentages.
    • Proportional: Split among all contestants who received votes, relative to their vote count.
  • Winner Announcements:
    • Announce winners publicly: Shouts winner announcements in local chat.
    • Delay between winner announcements: Sets a delay (in seconds) between payout announcements in chat to prevent spam.
  • Title & Colors:
    • Title (no ongoing contest): The custom text shown on the board when no contest is active.
    • Title Color: Color picker for the idle title text.
    • Prize/Contestants/Votes Colors: Color picker for the stats headers.
    • Names Color: Color picker for contestant names.
    • Winner Colors: Individual color pickers for 1st place, 2nd place, and 3rd place text display.
  • Rotating Messages:
    • Paging Speed: Time (in seconds) the board stays on a page of contestants before flipping.
    • Message Lists: Customized rolling messages for the board's text strip, set individually for different phases: No Contest, Ongoing Contest, Voting, and Announcing Winners.
  • Background Textures: Custom UUID fields to set the backdrop textures of the board faces for each phase:
    • No contest texture UUID: Shown when no contest is active.
    • Ongoing contest texture UUID: Shown when people can enter the contest.
    • Voting texture UUID: Shown during voting.
    • Winners texture UUID: Shown when announcing the winners.
    • Ranks texture UUID: Used to show the ranks of the winners.
  • Messages: Custom local chat and dialog messages:
    • Message to the person after joining the contest
    • Message to the person raising the pot
    • Message to a person that got removed from the contest
    • Public message before announcing the winners
    • Public message for each of the winners
    • Personal message to the winner
    • Personal message to the persons who didn't win
  • Particles: Toggles and settings for visual particle effects, including testing buttons:
    • Particles when someone joins the contest (can follow the agent)
    • Winner particles (can follow the winner)
    • Particles when someone raises the pot (can follow the donor)

2. Management Panel

  • Staff TipJar Groups: Select which tip jar groups (e.g. DJs, Hosts) have access to manage the board inworld.
  • Additional staff list: Add specific avatars by username who are allowed to operate the board's management menu inworld.

3. Contestant Blacklist

A list of avatars (by username) who are banned from joining contests.

4. Voters Blacklist

A list of avatars (by username) who are banned from casting votes.

Operation: Contest Phases

  1. Inactive Phase
    The board is idle. It displays your inactive background texture or the default title. The staff can click the board to activate a new contest.
  2. Entries (Registration) Phase
    Registration is open! Visitors touch the board to register as contestants. The board shows the contestants' display names and profile pictures.
    The staff can click any contestant's image to prompt a removal dialog.
  3. Voting Phase
    The staff clicks the cog icon to bring up the contest board management menu, and clicks on "Start Voting".
    Registration closes, and voting begins. Visitors touch the contestant photos to cast their votes. The board displays real-time vote totals.
    The staff can navigate the contestant pages using the navigation buttons located in the lower right corner of the board. The staff can still remove contestants by clicking their image and selecting "Remove" in the voting confirmation dialog.
  4. Winners (Payout) Phase
    The staff clicks "Winners" in the management menu to close voting.
    The contest is closed. The board announces the winners in local chat, displays their profile pictures, and triggers the main Xash Server to pay the L$ winnings automatically.
    After the prizes are paid out, staff can click "Deactivate" in the management menu to deactivate the board. If guests contributed to the pot, the board automatically refunds all contributed L$ in case there are no winners (if there were no entries or no votes).

Staff Management Menu

Authorized staff can access the inworld management menu by clicking the cog icon at the bottom right.

The management menu contains the following controls:

  • Activate: Starts a new contest and prompts the staff member to enter a contest theme/title in a textbox.
  • Start Voting: Closes the registration (Entries) phase and begins voting. If presence check is enabled, any contestant not currently in the region will be announced and automatically removed.
  • Winners: Ends voting, computes the final scores, pays the winners, and displays the winners on the board.
  • Deactivate: Cancels the contest. If guests contributed to the pot, the board automatically refunds all contributed L$ to them.
  • Set Title: Prompts a textbox to edit the contest theme name.
  • Web Page: Provides a click-to-load URL to open the club's Xash dashboard.

Voter Experience

When voting is active, visitors touch a contestant's picture to cast a vote. Depending on your configuration, they will see one of the following popups:

  • Single Vote Confirm: If the voter has only one vote, they are prompted to confirm their choice.
  • Multi-Vote Menu: If the voter has multiple votes (e.g., up to 3), they can choose to Add Vote (to vote for another contestant or add another to the same one if allowed) or Change... to replace a previously cast vote.
  • Vote Change Selection: Displays a list of their currently voted contestants, letting them select which one to replace with the new target.