> For the complete documentation index, see [llms.txt](/llms.txt)

# Inbox

Delivers announcements and item-attached messages from the operator to players.




**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

Have an operator announcement and a gift with coins attached delivered to your own inbox, then open them. Delivered messages appear unread under **Your inbox** and turn read once opened. Opening the gift pays its 100 coins into the wallet under **Where the coins land**.

## How to try it

1. Press **Deliver** under **An announcement you can have delivered**; an unread message reading "Welcome to the GS2 inbox demo!" arrives in **Your inbox**. Each press delivers one more message.
1. Press **Open** on a message in **Your inbox**; it turns read and shows **Opened.** in place of the button.
1. Press **Deliver** under **A gift with coins attached** (**Carries 100 coins.**); a message reading "A gift from the operator: 100 coins." arrives.
1. Press **Open** on the gift message; **Free balance** under **Where the coins land** goes up by 100.

**Deliver** here does not receive the announcement the way a client normally would; it sends a fresh copy through an exchange, so every press delivers another message.

## GS2 services used

- [GS2-Inbox](/microservices/inbox/): GS2-Inbox holds the player's inbox and whether each message is read. The gift message carries a GS2-Money2 deposit as its reward for opening, which runs when the message is opened.
- [GS2-Exchange](/microservices/exchange/): Two free GS2-Exchange rates define the transactions behind the **Deliver** buttons, which send the announcement and the gift message to GS2-Inbox. Delivered messages expire after 7 days.
- [GS2-Money2](/microservices/money2/): The GS2-Money2 wallet (slot 0) receives the gift's 100 free coins when the gift message is opened.

## Use it in GS2 Studio

In GS2 Studio's Simple mode, open **Add features** and press **Add** on **Inbox** 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/foundation-liveops-inbox/packages/foundation-liveops-inbox
```

- Owner: `gs2io`
- Repository: `gs2-studio-package`
- Subdirectory: `foundation-liveops-inbox/packages/foundation-liveops-inbox`

## Source code

- Demo project: <https://github.com/gs2io/gs2-studio-package/tree/main/foundation-liveops-inbox/live-demo>
- Feature package: <https://github.com/gs2io/gs2-studio-package/tree/main/foundation-liveops-inbox>



