Chat giveaways
This module is currently disabled due to new Steam chat breaking changes and requires a rewrite. The below text is kept for archival purposes only. There is no ETA as of now when exactly chat giveaways come back.
Chat giveaways module, as name suggests, is a module responsible for delivering SteamGifts giveaway URLs to Steam chat users. It's extremely useful for small SG communities that are enjoying using Steam group chat feature, and would like to create giveaways specially for that small group of people (optionally including non-members), and not for the entire group.
The general command syntax is:
!c(hat)g(iveaway) <action> (ExtraArgs) sent privately to ArchiBoT.
Available actions are defined below, ExtraArgs are required in some specific actions.
Typically making chat giveaway consists of three things:
- Creating giveaway with
AddGiveawayaction. - Specifying eligible chats and rules with
ConnectGiveawayWithChataction (multiple times if needed). - Enabling (and optionally announcing) giveaway with
EnableGiveawayaction.
When giveaway is active, ArchiBoT will automatically send giveaway link to eligible members.
unsigned byte - integer value with range of 0-255.
Adds giveaway to ArchiBoT's database, giveaway must be invite-only, running, with you being the creator.
Example: !chatgiveaway AddGiveaway ABCDE
Connects giveawayID to chatID on ruleType rule. chatID can be 64-bit steamID or known chat name, like for chat relay. You can use !chatinfo command on group chat to get its chatID.
One chat/rule per command, you can execute this multiple times for multiple chats/rules if needed. In order for chat user to get giveaway link, he must pass all rules specified for that chat.
| Rule | Description |
|---|---|
| GroupMembersOnly | Once set, only group members are eligible for giveaway. |
ChatMessagesCount <count>
|
Member must write in total <count> (unsigned byte greater than 0) messages on the chat since giveaway became active. |
Examples:
!chatgiveaway ConnectGiveawayWithChat ABCDE 110338190878500667 ChatMessagesCount 20 - We share the same giveaway with two chats, those members will need to write 20 messages in total.
!chatgiveaway ConnectGiveawayWithChat ABCDE 2hu ChatMessagesCount 10 - Touhou chat members will need to write 10 messages in total.
!chatgiveaway ConnectGiveawayWithChat ABCDE 2hu GroupMembersOnly - But we restrict 2hu chat to group-members only
Result: User can get link either by being a member of Touhou Giveaways, joining Touhou Giveaways chat and writing 10 messages, or by joining 110338190878500667 chatID and writing 20 messages on that one instead (no requirement of being a member).
Enables given giveaway as available for claiming, starting all tracking sub-modules. Also posts small announcement on chats (optional).
| Type | Description |
|---|---|
| None | Lack of any notification, only you know that giveaway is active now. |
| Basic | Basic notification on all included chat IDs - contains only generic message about you creating a chat giveaway. |
| WithGiveawayInfo | Like Basic, but also includes name of the game included in the giveaway, and when the giveaway ends. |
Example: !chatgiveaway EnableGiveaway ABCDE None
Prints a list of (still running) giveaways that you're eligible for. Useful if you missed ArchiBoT notification or in other way lost your giveaways.
Example: !chatgiveaway GetEligibleGiveaways
Gets list of users (from all chats) that are eligible for given giveaway, meaning that ArchiBoT gave them link to join it. Useful as anti-leakers test similar to SGT.
Example: !chatgiveaway GetEligibleUsers ABCDE
Adding (and announcing) giveaway ABCDE for all chat users of Touhou Giveaways that posted at least 2 messages (only group members):
!cg AddGiveaway ABCDE
!cg ConnectGiveawayWithChat ABCDE 2hu ChatMessagesCount 2
!cg ConnectGiveawayWithChat ABCDE 2hu GroupMembersOnly
!cg EnableGiveaway ABCDE Basic