REPTILE MULTIPLAYER
===

Thank you for choosing the **Reptile Multiplayer Solution** for your project. Here you will find all the information you need on **how to use** this template or **customize** it according to your preferences.

:::success

# DOCUMENTATION INDEX

### Reptile Multiplayer Documentation

- PROJECT SETUP: **YOU ARE HERE**
- MASTER, NETWORK AND STEAM: [**GO TO MASTER MASTER, NETWORK AND STEAM**](https://hackmd.io/@ReptileMultiplayerDocumentation/B1WzLoPph)
- MENU DOCUMENTATION: [**GO TO MENU DOCUMENTATION**](https://hackmd.io/@ReptileMultiplayerDocumentation/SJncKmApn)
- GAMEPLAY DOCUMENTATION: [**GO TO GAMEPLAY DOCUMENTATION**](https://hackmd.io/@ReptileMultiplayerDocumentation/rJxH4yz0h)

:::

# CONTENT

[TOC]

---

# OVERVIEW

In this documentation, you will find detailed information on how to **set up** this template, its **dependencies**, and essential **configurations**. We will also delve into the **functionalities** of various **singletons** that empower your multiplayer experience. Whether you're new to multiplayer game development or a seasoned pro, this documentation will serve as your indispensable companion.

::: info
This documentation is designed to help you understand the components and functionality of the Reptile Multiplayer Solution fully. If you have any questions or need further assistance, please email at: [[e-mail]](mailto:[e-mail]).
:::

# SETUP

### Dependencies

This project has some dependencies from the Asset Store, so to make it work correctly, make sure you have all of them installed and up to date. These are the dependencies:

#### PHOTON PUN 2 V2.43+
- Link to Asset Store: https://assetstore.unity.com/packages/tools/network/pun-2-free-119922

#### INPUT SYSTEM
- Find this asset on the Package Manager.

#### CINEMACHINE 2.9.7+
- Find this asset on the Package Manager.

#### TEXT MESH PRO 3.0.6+

- Find this asset on the Package Manager.

### Steam Game ID

his template uses Facepunch Steamworks, so you don't need to create a .txt in your Unity project folder... Just enter your Game ID in GameSettings.


If you don't have the key, you can leave the default game ID "480" for the development process.

# SINGLETONS

This template uses singletons to manage its functionalities. These singletons are placed as an empty object in the first game scene.


If you want to disable any function in your game, simply deactivate or delete the singleton game object responsible for that functionality...

:::info

Example:

I want to remove the local player and split-screen functionality.

:::

---

# GAME LAYERS

After you have installed and configured the template correctly, you will need to create the following layers for the Split-Screen functionality to work correctly.

## SPLIT SCREEN LAYERS

1. Add the **layers** '**Player1**', '**Player2**', '**Player3**', and '**Player4**'.


2. Find the **LocalPlayerManager** **singleton** in the **MainMenu Scene**


3. **Open** the **prefab** and **assign** the **layers** in the `PlayerLayers` field of the `LocalPlayerManager` component.