Home

Documentation Overview

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

Getting started

This section contains the articles describing the Snipe server platform and basic steps needed to get it running and operational. It also contains the tutorial to make a bare-bones game project.

• Snipe Platform - Platform description.
• 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.
• Examples - List of available example projects.

Server

This section contains articles that describe low-level Snipe server mechanisms and APIs in depth.

• 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.
• Module Subscriptions - Describes the module subscriptions mechanism.
• Method Subscriptions - Describes the method subscriptions mechanism.
• Stopping the Server - Shows how to properly stop the server.
• Logging - Describes the logging mechanisms.
• Debug Compilation Flags - Describes the available debug compilation flags.
• Client Migration - Explains how to migrate the clients between different game server threads.

Client

This section contains tutorials to write basic client applications for connecting to the Snipe server.

• Unity3D - Unity3D client application.
• Flash (ActionScript 3) - Flash (ActionScript 3) client application.

Library

This section describes useful APIs and mechanisms that provide additional Snipe server functionality.

• Asynchronous Database Manager - Cache server asynchronous database connection manager.
• Asynchronous Worker - Cache server asynchronous worker thread manager.
• Autosave Manager - Cache server data autosaving.
• FODS Parser - .FODS OpenOffice format parser.
• Generic Containers - Generic map and list classes based on data blocks.
• Logger - Logging facility.
• Macros - Useful macros.
• Real-time Stats - Real-time statistics.
• Server List - Automatic server list.
• Server-side Scripts - Server-side scripts base class.
• Stats - Describes the statistics gathering tool and access to the statistics in the editor.
• Temp Directory - API to work with the temp directory.
• Timers - Various timers for running tasks on cache or slave servers.
• Thread Names - Library for naming threads.
• Worker - Slave server asynchronous worker.

Tools

This section contains the articles describing the tools that are supplied in the Snipe server package.

• 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

This section has articles about all core Snipe server modules describing their APIs and functionality.

• 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.
• Static Tables - Describes the support for editing and loading static database tables.
• Users - Describes the users-related functions and classes.

Packages

This section has links to the descriptions of the additional packages that come bundled witn Snipe server.

• Basic matchmaking - Implements 1v1 server-side user matchmaking.
• Extended matchmaking - Customizable server-side user matchmaking that supports any number of users matched.
• Kongregate - Allows server to login the client into Kongregate SNS.
• Leaderboads - Manages the real-time leaderboads.
• Room Manager - Adds client rooms and API for creating and managing them.
• Test Messages - Defines various test messages.
• User Session Length - Allows the collection and display of average user session length stats.

Editor

This section has everything you need to know about the web editor, from basic configuration to extension APIs to server profiling support.

• 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.
• Troubleshooting - Describes the common problems that can happen with the editor.

Miscellaneous

• Budget Examples - Budget examples.
• Player Actions - Describes the player actions functionality.