Home

Documentation Overview

This article describes what the Snipe server documentation has to offer:

Overview

• Documentation - This article.
• Snipe Platform - Platform description.

Getting started

• Server Installation - Describes how to install, compile and run the server.
• Editor Installation - Shows how to compile and run the editor.
• First Steps - Describes how to create the base server classes and modules, how to compile the servers, what to expect when running them and how to test the code.
• User Registration and Login - Simplified description of user registration and login.

Server

• Server Structure - Describes the logical structure of Snipe server.
• Server Modes of Operation - Shows how to use different modes of operation.
• Сonfiguration - Describes server configuration files.
• Data Blocks - Shows how to work with server data blocks.
• Cache Server Modules - Describes the cache server modules functionality, how to make a module, what it can do and how to call its methods from slave servers.
• Slave Server Modules - Describes the slave server modules, how to make a module and what it can do.
• Notifications - Describes the various server notification mechanisms.
• Subscriptions - Describes the module subscriptions mechanism.
• Stopping the Server - Shows how to properly stop the server.
• Logging - Describes the logging mechanisms.

Library

• Asynchronous Worker - Cache server asynchronous worker thread.
• Autosave Manager - Cache server data autosaving.
• Demons - Various demons for running tasks on cache or slave servers.
• FODS Parser - .FODS OpenOffice format parser.
• Logger - Logging facility.
• Real-time Stats - Real-time statistics.
• Server List - Automatic server list.
• Temp Directory - API to work with the temp directory.
• Thread Names - Library for naming threads.
• Worker - Slave server asynchronous worker.

Tools

• Performance and Stress Testing - Describes the Snipe server performance testing tool.
• Script-based Testing - Describes the tool used for script-based server functionality testing and the used script language.

Modules

• Calendar Events - Describes the calendar events module.
• Game Variables - Describes the game variables module.
• Items and Bundles - Describes the ingame items and item bundles modules.
• Localization Support - Describes the localization support.
• Quests - Describes the game quests and quest chains.
• Shop - Describes the ingame shop support.
• Users - Describes the users-related functions and classes.

Editor

• Configuration - Describes the editor configuration variables.
• User Authentication - Describes the editor authentication mechanism.
• Modules - Describes the editor modules, what they can do, and how they can extend functionality provided by the core modules.
• Page Blocks - Describes how the editor draws the page and how do editor modules define that.
• Main Page - Shows the main editor page API and describes how to add content to it.
• Notifications - Describes the editor to server notification and request mechanism.
• Subscriptions - Shows how the editor modules can subscribe to events produced by the core modules.
• Localization - Shows the editor localization mechanism.
• Profiler - Describes the internal server profiler and what information it can provide.
• Stats - Describes the statistics gathering tool and access to the statistics in the editor.