Skip to content

Commit

Permalink
Updating documentation (Unity-Technologies#7)
Browse files Browse the repository at this point in the history
* refactor getting started documentation

* add the recommended version
  • Loading branch information
julianunity authored Mar 15, 2024
1 parent c30e7b0 commit c41a460
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 38 deletions.
34 changes: 0 additions & 34 deletions Documentation/getting-started.md

This file was deleted.

35 changes: 31 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
## Contents and Quick Links
- [Megacity-Metro Overview](#megacity-metro-overview)
- [Megacity-Metro Prerequisites](Documentation/prerequisites.md)
- [Get Started](Documentation/getting-started.md)
- [Multiplayer Setup](Documentation/multiplayer-setup.md)
- [Add Unity Gaming Services (UGS)](Documentation/ugs.md)
- [Index of Resources in this Project](Documentation/script-index.md)
Expand Down Expand Up @@ -45,12 +44,40 @@ Some important points of this demo are:
| P | Netcode Panel Stats |
| ESC| in game menu |

## Contents and Quick Links

- [Important Note Before You Begin](#important-note-before-you-begin)
- [Clone the Project](#clone-the-project)
- [Quick Start](#quick-start)

# Getting Started

## Important Note Before You Begin

The Megacity-Metro sample is large, so the **first time** cloning and playing the sample may take more time than expected. Subsequent plays should load much quicker because of caching.

First time clone and load time estimates:
- Cloning the Megacity-Metro repo: Up to 20 min
- Opening the project with library build: Up to 20 min
- Building the project for each platform for the first time: Up to 50 min.
Navigate to `Project Settings > Other Settings > Configuration > C++ Compiler Configuration`and set `Debug` if you need to compile faster than optimal.

To get the Megacity-Metro sample, you can clone the project using Git.
**Please note that direct download of the project is not currently supported for this repository**.

## Clone the Project

## Troubleshooting
Before you can clone the project, you must install Git Large File Support (LFS). Megacity-Metro uses Git LFS to handle all large assets required locally.
Refer to [Git LFS installation options](https://github.com/git-lfs/git-lfs/wiki/Installation) for instructions on Windows and Mac.

### Bugs
## Quick Start

Report bugs in Megacity Multiplayer using GitHub [issues](https://github.com/Unity-Technologies/Megacity-Metro/issues). If the bugs are related to the Entities packages, use the Entities GitHub issues.
After you clone the project, follow these steps to start playing:
1. Install a compatible Unity Editor version; we highly recommend using the version specified in `ProjectSettings/ProjectVersion.txt`. During installation, make sure to include Windows/Mac Build Support (IL2CPP), Windows/Mac Dedicated Server Build Support, Android/iOS Build Support (if you plan to build for mobile devices), and Linux Dedicated Server Build Support.
2. To add the project to the **Unity Hub**, click the **Add** button and select the root folder of the cloned project.
3. Open the **Menu** scene located in `Assets/Scenes/Menu`.
4. Click the **Play** button to start.
5. Start the Single Player mode. Multiplayer requires more setup which will be explained next.

## Disclaimer

Expand Down

0 comments on commit c41a460

Please sign in to comment.