0. Getting Started - meng-zx/aechess-team GitHub Wiki

Third-Party Dependencies of This Project

  • Unity
  • Vuforia Engine
  • Python Django
  • PostgreSQL

1. Operating System and Unity Preparation

1.1 Operating System

Windows is recommended.

Mac with silicon chips might encounter problems when implementing and deploying the Unity project onto Android phones.

1.2 Unity and Android

Unity version 2021.3.11f1 is recommended. Every different version of Unity has slight differences, which may cause the project unable to implement. The safest way is to use the same version as developers.

Here is a detailed official guide on how to set up Android development environment in Unity. We will go through this guide.

  • First download the Unity Hub and sign in, (no need for Unity Pro). Then download Unity 2021.3.11.
  • When downloading the Unity, also add module Android Build Support. Make sure the three dependency modules are all checked.
  • Ignore the `Customizing dependencies part unless you are fully aware of what are you doing.
  • Open the project with Unity Hub. The project path is ./ARGomoku
  • In File > Build Settings, choose Android as the platform and then click Switch platform. The first few minutes of this video might be helpful.
  • Then click the player settings on the lower left corner of this window, in Other settings, set the API level to 26. This is the lowest level Vuforia Engine currently needs.
  • To open a scene, click file > open scene. The scenes in this project are stored in ARGomoku/Assets/Scenes.
  • All the C# scripts are stored in ARGomoku/Assets/Scipts.

2. Vuforia Engine

To set up Vuforia Engine, first, go to Vuforia developer portal, register and log in with your account.

Follow this video, starting from 4:30, to create a license and put the key into this project. A free-tier key should be enough.

3. Backend Server

3.1 Set Up Backend Server

Follow procedures in the EECS441 lab0 to set up the backend.

3.2 Change the IP address.

In the scripts, search for 18.218.77.102 and replace them with your own server's IP address.

4. Deployment

Enable the developer mode for your device.

Connect the device to the PC by a cable. In File > Build settings, choose your own device in the drop-down menu for Run Device. If you cannot find your own device, click refresh. Also, make sure your device is connected.

You don't need to worry about other settings since we've done most for you, unless there's an error. You can change the package name and version in the Player settings > player > Other Settings > Identification > Package Name.

Then click the Build and Run button on the File > Build settings. After you choose a place to save the apk file, the project will be built and deployed onto your phone.

An alternative method is to click Build, save the apk file, and then deploy it using Android Studio. It could be helpful if you want to modify it a little bit, but it's not necessary for this project.

This video starting from 13:30 can serve as a reference, but it is made on an older version of Unity and Vuforia so the interface may be different.

5. Chessboard and Pieces

The Chessboard and piece markers are in the Other Assets/ folder of this repository. Please print it put out with letter size paper.