OverviewEditor

Editor Overview

One of the large components of Snipe server is the web editor. The editor runs as a Neko script file on a web server handling requests and generating web pages. The editor has direct access to both the database and cache server. It has a lot of core functionality implemented to access and modify core game modules. It also supports extending the basic functionality with project-specific editor modules.

The editor is intended to be ran on HTTPS connection. By default, editor users are authenticated through the HTTP basic access authentication but that can be changed.

Configuration page describes the configuration file for the editor.

Modules page describes editor modules functionality and extensions.

Page Blocks article describes the webpage blocks functionality.

User Authentication page describes user authentication.

Main Page article describes the main web page of the editor, its structure and API.

Notifications page describes editor requests and notifications to cache server.

Subscriptions page describes the event subscriptions mechanism and gives a brief list of available events.

Localization page has everything about editor localization support, the basic mechanism, uploading and downloading localization strings, etc. Note that it specifically describes the editor strings localization.

Profiler article describes the server profiling support and access to it through the editor.

Stats article is about statistics collection system and access to it through the editor.