Documentation index for AI agents

GS2-News API Reference

News delivery feature

Provides in-game news delivery.

Article data is authored as a Hugo site and supplied as a ZIP archive or from a GitHub repository. GS2-News builds the data and hosts it as static web content; the uploaded source must be no larger than 100 MB.

Articles can be associated with GS2-Schedule events through their Front Matter so that the appropriate content is selected according to the current event period. GS2-News builds the necessary public and private patterns in advance, so limiting the number of independently controlled articles avoids excessive build combinations.

The game client can either download the built archive and cache it using the provided hashes, or open a hosted temporary URL in a WebView or browser. Hosted content is protected by short-lived cookie information so that unreleased articles cannot be accessed merely by discovering their URL.


GS2-News SDK for Game Engine API Reference

Specifications of models and API references for GS2-News SDK for Game Engine

GS2-News SDK API Reference

Specification of models and API references for GS2-News SDK for various programming languages

GS2-News Deploy/CDK Reference

The template format used when creating stacks with GS2-Deploy, and implementation examples of template output in various languages using CDK