Clone and run Byte Wars - Initial setup - (Unity module)

Last updated on November 25, 2024

Clone the Byte Wars repository

You can find the Byte Wars project folder in the Byte Wars Unity GitHub repository and clone it using the following command:

git clone https://github.com/AccelByte/accelbyte-unity-bytewars-game.git

Open the Byte Wars project in Unity

To open Byte Wars in Unity, you can follow these steps:

1. From the Unity Hub, go to Projects and click Open.
2. In the file explorer, locate and open the Byte Wars folder you cloned. The Byte Wars project will be added into the project panel.
3. Click on the project to open it in the Unity Editor.

note

The project must be opened with 2022.3.50f1 or later selected in the EDITOR VERSION column. If an earlier version is selected, use the dropdown in this column to select the correct version for the project.

The project may open in the Unity Editor automatically upon locating and opening it in the file explorer.

Run Byte Wars

You can run Byte Wars directly in the Unity Editor, or you can build and run it as a .exe executable file or a web page (WebGL).

Run Byte Wars in the Unity Editor

1. With Byte Wars open in Unity, go to the Scenes folder in your Assets and double-click the MainMenu scene file to make sure the MainMenu scene is open in the Hierarchy.

   

2. Play the game in the Editor.

   

Run Byte Wars from a package

Windows

1. With Byte Wars open in Unity, go to File > Build Settings. Leave everything as default and click Build.

   

2. In the file explorer, choose the folder where you want to save the package file and click Select Folder.

   

3. Allow time for it to finish packaging your files.

   

4. Open the folder where you saved the file and open ByteWars.exe to play the game.

tip

You can run Byte Wars right from a terminal with the following command:

ByteWars.exe -window-mode -screen-width 1280 -screen-height 720

WebGL

info

You need the WebGL Build Support module installed on your Unity Editor. If you have not, you can install it using Unity Hub. Fo more information about adding the necessary modules, refer to the Unity Hub documentation.

1. Enable compression and data caching to optimize the packaged WebGL build. To do this, open Byte Wars in Unity Editor and go to File > Edit > Project Settings.

2. In the new window, select Player from the left panel, then select Settings for WebGL tab. Next, expand the Publishing Settings section and set Compression Format to Brotli and enable Data Caching.

   

3. Next, package Byte Wars as WebGL build. Go to File > Build Settings. Select WebGL as build platform and click Build.

   

4. In the file explorer window, choose the folder where you want to save the package file and click Select Folder.

   

5. Allow time for it to finish packaging your files.

   

6. Open the folder where you saved the file and copy it to your local web server.

7. Run the game by opening your local web server's IP address in a web browser.