# Multisynq Docs

## Docs

- [Core API Reference](https://docs.multisynq.io/api-reference/index.md): Complete reference for the Multisynq client-side synchronized architecture, including Model, View, Session, and more.
- [Real-time Chat](https://docs.multisynq.io/essentials/chat.md): Build real-time chat systems with Multisynq
- [Collaborative Editing](https://docs.multisynq.io/essentials/collaboration.md): Build real-time collaborative editing experiences with Multisynq's Model-View architecture
- [Conflict Resolution](https://docs.multisynq.io/essentials/conflicts.md): Understand how Multisynq handles conflicts in real-time collaborative applications
- [Scaling Applications](https://docs.multisynq.io/essentials/scaling.md): Learn how to scale your Multisynq applications for high performance and large user bases
- [Real-time Synchronization](https://docs.multisynq.io/essentials/sync.md): Learn how Multisynq achieves perfect synchronization through deterministic execution
- [Shared Whiteboard](https://docs.multisynq.io/essentials/whiteboard.md): Create collaborative drawing canvases with Multisynq
- [Introduction](https://docs.multisynq.io/index.md): Welcome to Multisynq - Build real-time collaborative applications with ease
- [Quickstart](https://docs.multisynq.io/quickstart.md): Start building real-time collaborative applications with Multisynq in under 5 minutes
- [Chat](https://docs.multisynq.io/react-together/components/chat.md): A complete real-time chat component with customizable UI elements and automatic message synchronization.
- [ConnectedUsers](https://docs.multisynq.io/react-together/components/connected-users.md): Display connected users with customizable avatars and user information. Shows who's currently active in your collaborative session.
- [Cursors](https://docs.multisynq.io/react-together/components/cursors.md): Display live mouse cursors from all connected users with smooth animations and customizable appearance.
- [HoverHighlighter](https://docs.multisynq.io/react-together/components/hover-highlighter.md): Wrap elements to highlight them when other users hover over them. Perfect for showing real-time user interactions and collaborative awareness.
- [ReactTogether](https://docs.multisynq.io/react-together/components/react-together.md): The main context provider component that enables real-time collaboration features in your React application.
- [SessionManager](https://docs.multisynq.io/react-together/components/session-manager.md): A complete session management UI component for creating, joining, and leaving collaboration sessions with QR code sharing.
- [Getting Started with React Together](https://docs.multisynq.io/react-together/getting-started.md): Add real-time multi-user interaction to any React app with React Together. No backend or net-code required!
- [useAllNicknames](https://docs.multisynq.io/react-together/hooks/use-all-nicknames.md): Access all user nicknames in the current React Together session for display and user identification
- [useChat](https://docs.multisynq.io/react-together/hooks/use-chat.md): Build real-time chat functionality into your React Together applications with message history and user identification.
- [useConnectedUsers](https://docs.multisynq.io/react-together/hooks/use-connected-users.md): Get information about all users connected to the current React Together session, including their nicknames and connection status.
- [useCreateRandomSession](https://docs.multisynq.io/react-together/hooks/use-create-random-session.md): Create and connect to a new React Together session with randomly generated credentials
- [useCursors](https://docs.multisynq.io/react-together/hooks/use-cursors.md): Track and display real-time cursor positions of all users in your collaborative application, perfect for collaborative editing and design tools.
- [useFunctionTogether](https://docs.multisynq.io/react-together/hooks/use-function-together.md): Synchronize function execution across all users in real-time collaborative applications
- [useHoveringUsers](https://docs.multisynq.io/react-together/hooks/use-hovering-users.md): Track which users are hovering over specific DOM elements in real-time, perfect for interactive collaborative features.
- [useIsSynchronized](https://docs.multisynq.io/react-together/hooks/use-is-synchronized.md): Check if your local state is synchronized with the shared model. Essential for building responsive real-time interfaces.
- [useIsTogether](https://docs.multisynq.io/react-together/hooks/use-is-together.md): Check if the user is connected to a React Together session. Perfect for conditional rendering and connection-aware features.
- [useJoinUrl](https://docs.multisynq.io/react-together/hooks/use-join-url.md): Get the join URL for sharing the current React Together session with other users
- [useLeaveSession](https://docs.multisynq.io/react-together/hooks/use-leave-session.md): Leave the current React Together session while preserving local state
- [useMyId](https://docs.multisynq.io/react-together/hooks/use-my-id.md): Get the current user's unique identifier. Essential for user-specific functionality and personal state management.
- [useNicknames](https://docs.multisynq.io/react-together/hooks/use-nicknames.md): Manage and retrieve user nicknames in your React Together session, enabling personalized collaborative experiences.
- [useStateTogether](https://docs.multisynq.io/react-together/hooks/use-state-together.md): Synchronize state across all users in real-time. Works exactly like React's useState but keeps all users in sync.
- [useStateTogetherWithPerUserValues](https://docs.multisynq.io/react-together/hooks/use-state-together-with-per-user-values.md): Share state between users while tracking individual user values in real-time collaborative applications
- [deriveNickname](https://docs.multisynq.io/react-together/utilities/derive-nickname.md): Generate human-readable nicknames from user IDs using the unique-names-generator library for consistent user identification.
- [getCleanUrl](https://docs.multisynq.io/react-together/utilities/get-clean-url.md): Remove session parameters from URLs for clean navigation and URL management.
- [getJoinUrl](https://docs.multisynq.io/react-together/utilities/get-join-url.md): Create shareable URLs with embedded session parameters for inviting users to collaborative sessions.
- [getSessionNameFromUrl](https://docs.multisynq.io/react-together/utilities/get-session-name-from-url.md): Extract session names from URL query parameters for automatic session joining and URL parsing.
- [getSessionPasswordFromUrl](https://docs.multisynq.io/react-together/utilities/get-session-password-from-url.md): Extract session passwords from URL hash parameters for secure automatic session joining.
- [getUserColor](https://docs.multisynq.io/react-together/utilities/get-user-color.md): Generate consistent HSL color strings based on user IDs for visual user identification in collaborative interfaces.
- [Utilities Overview](https://docs.multisynq.io/react-together/utilities/index.md): Helper functions for URL manipulation, user management, and session handling in React Together applications.
- [3D Animation](https://docs.multisynq.io/tutorials/3d-animation.md): Learn to integrate Three.js with Multisynq for synchronized 3D experiences with interactive elements
- [Data API](https://docs.multisynq.io/tutorials/data-api.md): Learn how to handle file uploads, bulk data storage, and secure data sharing in Multisynq applications
- [Events & Pub-Sub](https://docs.multisynq.io/tutorials/events-pub-sub.md): Master the event-driven communication system that powers Multisynq Model-View interactions
- [Hello World Tutorial](https://docs.multisynq.io/tutorials/hello-world.md): Build your first Multisynq application - a synchronized counter that updates in real-time across all users
- [Model-View-Synchronizer](https://docs.multisynq.io/tutorials/model-view-synchronizer.md): The core architecture pattern that powers Multisynq applications
- [Multiblaster Game Tutorial](https://docs.multisynq.io/tutorials/multiblaster-game.md): Build a complete multiplayer game step-by-step with Multisynq - from asteroids to spaceships, shooting, scoring, and persistence
- [Multi-user Chat](https://docs.multisynq.io/tutorials/multiuser-chat.md): Learn to track users, manage message history, and handle timeouts in a real-time chat application
- [Persistence](https://docs.multisynq.io/tutorials/persistence.md): Learn how to save application data across code changes and versions using Multisynq's persistence mechanism
- [Random](https://docs.multisynq.io/tutorials/random.md): Understand how random number generation works in Multisynq models and views to maintain perfect synchronization
- [Sim Time & Future](https://docs.multisynq.io/tutorials/sim-time-future.md): Master Multisynq's simulation time and future scheduling system for synchronized time-based behaviors
- [Simple Animation](https://docs.multisynq.io/tutorials/simple-animation.md): Learn to create multi-user shared animations and interactions with bouncing balls simulation
- [Snapshots](https://docs.multisynq.io/tutorials/snapshots.md): Understand how Multisynq automatically saves and restores session state for persistence and new user synchronization
- [View Smoothing](https://docs.multisynq.io/tutorials/view-smoothing.md): Learn to create smooth animations by interpolating between model updates for better user experience
- [Writing a Multisynq App](https://docs.multisynq.io/tutorials/writing-multisynq-app.md): Learn how to structure and launch complete Multisynq applications with models, views, and session management
- [Writing a Multisynq Model](https://docs.multisynq.io/tutorials/writing-multisynq-model.md): Learn the essential constraints and best practices for building synchronized models that work perfectly across all users
- [Writing a Multisynq View](https://docs.multisynq.io/tutorials/writing-multisynq-view.md): Learn how to build responsive, interactive views that display model state and handle user input while maintaining perfect synchronization

## OpenAPI Specs

- [openapi](https://docs.multisynq.io/api-reference/openapi.json)

## Optional

- [Dashboard](https://multisynq.io)
- [Community](https://discord.gg/multisynq)
- [GitHub](https://github.com/multisynq)