MANUAL

This manual serves as a central hub for documentation, guides, and resources related to the working with CSP.

Whether you’re a developer, contributor, or simply curious about the platform, this wiki is here to help you get started either using or contributing to CSP.

Getting Started

Connected Spaces Platform currently provides APIs for 3 languages: C++, C#, and TypeScript/JavaScript. For a quick guide on getting started with Connected Spaces Platform, follow the link below that corresponds to the language you use:

• C++
• C# (Unity)
• JavaScript

Tutorials

Use these tutorials to help you get yor CSP-enabled application running as fast as possible.

• C++
• C#
• JavaScript

Processes, Principles and Tooling

Documentation on processes and principles that the library adheres to.

• Programming Guidelines
• Adding Components to CSP
• Branching Strategy
• Wrapper Generator Specifications
• Script System
• Expected Application Flow
• Multiplayer and State Replication
• Services Abstraction Layer
• External Tools

Building CSP

If you’re forking CSP for your own purposes, or seeking to contribute back, you can find documentation on how to build CSP here.

• Building CSP for Web
• Building CSP for C++
• Building CSP for C#
• Building CSP for Android
• Building CSP for MacOS
• Building CSP for iOS

Tests

CSP’s functionality is validated via an ever-growing suite of tests, and any chance introducing new functionality is expected to also include test coverage. In this section, you can find out how the tests work, testing best practices, and how to run them.

• Testing Best Practices
• Test Locations
• Test Account Credentials

Debugging

Inevitably, at some point you will encounter unexpected behavior in your application, and you’ll break out the debugger to diagnose.

CSP itself is also debuggable, and in this section you can learn how to dive inside the library at runtime.

• Debugging CSP for Unity
• Debugging CSP for Web
• Performance Profiling