> For the complete documentation index, see [llms.txt](/llms.txt) # Guild Rankings A leaderboard partitioned by guild, so members compete inside their own guild, with rewards by rank. **About this demo** The demo signs in automatically with an anonymous account. The account is shared across every demo in the showroom, so items and currency you get in one demo carry over to the others. Loading takes a moment. If the frame is too small, open the demo in a new tab. ## Overview A leaderboard partitioned by guild. Found or join a guild under **Guild lobby**, then press **Play** under **Guild ranking** to add points; your rank is shown among the members of your own guild. The season turns over every day at 00:00 UTC, and a finished season pays coins by your rank. Guilds are not ranked against each other. ## How to try it 1. Under **Guild lobby**, type a name into **Name your guild** and press **Create a guild with this name**, or press **Join** on one of the **Guilds you can join**. 1. Under **Guild ranking**, press **Play**; each play adds 1 to 100 points to your total for today's season. **You** shows your rank in your guild and your total, and the board below lists your guildmates' scores. 1. Press **Advance one day** to move the demo clock forward a day (shown in **Demo clock**); today's season ends for you. 1. When **Previous** shows the finished season with your rank and points, press **Receive**; the reward for your rank in your guild (1st 300, 2nd-3rd 150, 4th-10th 50 coins) lands in **Free balance** under **Where the coins land**. 1. To compete with someone, copy your guild id under **Guild lobby**, then open the demo in another browser or a private window and join the same guild with **Join by id**. **Advance one day** moves your account's clock with a GS2-Account time offset, so guildmates who did not advance are still playing the same season. The offset stays on the account and also applies to the other demos in the same browser. ## GS2 services used - [GS2-Ranking2](/microservices/ranking2/): A GS2-Ranking2 cluster ranking uses each guild as a cluster, ranks its members' points (1 to 100 per play, summed over the season) and pays the reward for each rank band once a season is over. - [GS2-Guild](/microservices/guild/): GS2-Guild handles founding, joining and leaving guilds and their membership, and is the unit the ranking is partitioned by. - [GS2-Schedule](/microservices/schedule/): A GS2-Schedule event repeating daily at 00:00 UTC is the ranking's entry period, and its repeat count numbers the seasons. - [GS2-Money2](/microservices/money2/): The rank reward coins are deposited into the GS2-Money2 wallet as free currency. ## Use it in GS2 Studio In GS2 Studio's Simple mode, open **Add features** and press **Add** on **Guild Rankings** to bring this feature into your own project. To point at the package directly, choose **Add from GitHub** and enter the package below. ```text https://github.com/gs2io/gs2-studio-package/tree/main/micro-liveops-guild-ranking/packages/micro-liveops-guild-ranking ``` - Owner: `gs2io` - Repository: `gs2-studio-package` - Subdirectory: `micro-liveops-guild-ranking/packages/micro-liveops-guild-ranking` ## Source code - Demo project: - Feature package: