DevAtlas Viewport and Customization Engine
  • API Overview
  • Documentation Notes
  • Reserved Features
  • Viewport Engine
    • Loading Windows
      • changeViewport()
      • Loading Customization Engine Plugins
    • Account Functions
      • logInAPI()
  • Customization Engine
    • Viewport Window
      • Viewport Window Definition
      • Viewport Window JS Object
      • Viewport Window JSON
    • Sidebar Icon
    • Announcements
Powered by GitBook
On this page
  1. Customization Engine
  2. Viewport Window

Viewport Window JSON

Example of a properly formatted Window JSON:

{
    "identifier":"devatlas_internal_all_HTML5", //Window ID
    "threads":[ //Threads in this window's forum (If it has one)
        {
            "devatlas_internal_all_HTML5_welcome":[ //Thread Object ID
                { //First sub-obect always defines the thread
                    "threadName":"Welcome to the HTML Forum!", //Thread display name
                    "desc":"Check out this quickstart guide to get started!", //Thread quick description
                    "datetimeCreated":"2025-01-30T17:39Z", //Thread's date and time of creation
                    "creatorID":"devatlas@kittentech.org", //UserID of the thread creator
                    "creatorName":"DevAtlas", // Thread's creator's display name
                    "pinned":"true", //Is the thread pinned at the top of the forum?
                    "formal":"true" //Is this thread formal?
                },
                { //All other sub-objects are messages send in the thread
                    "userID":"devatlas@kittentech.org", //Message sender's UserID
                    "userName":"DevAtlas", //Message sender's display name
                    "datetime":"2025-01-30T17:42Z", //Date and time the message was sent
                    "content":"Welcome to the official DevAtlas HTML forum! Please remember that in official forums you must obey all the rules, and all content sent here will be broadcasted to the DevAtlas Discord server. Thank you and have fun! If you have any questions, feel free to contact devatlas@kittentech.org." //Message content
                }
            ]
        }
    ]
}

The JSON above is formatted to make it easier for a human to read, but for the DevAtlas Customization Engine to read it, it has to be one line of text like the following example:

{"identifier":"devatlas_internal_HTML5", "threads":[{"devatlas_internal_all_HTML5_welcome":[{"threadName":"Welcome to the HTML Forum!", "desc":"Check out this quickstart guide to get started!", "datetimeCreated":"2025-01-30T17:39Z", "creatorID":"devatlas@kittentech.org", "creatorName":"DevAtlas", "pinned":"true", "formal":"true"}, {"userID":"devatlas@kittentech.org", "userName":"DevAtlas", "datetime":"2025-01-30T17:42Z", "content":"Welcome to the official DevAtlas HTML forum! Please remember that in official forums you must obey all the rules, and all content sent here will be broadcasted to the DevAtlas Discord server. Thank you and have fun! If you have any questions, feel free to contact devatlas@kittentech.org."}]}]}

The DevAtlas Plugin IDE (coming soon) can assist you in formatting and creating your Window JSON. Ensure your JSON is formatted properly or your plugin will not function.

PreviousViewport Window JS ObjectNextSidebar Icon

Last updated 3 months ago