ChAIss

ChAIss is an AI-powered chess application developed for Android that provides users with both 2D and 3D chess analysis. The app integrates a camera to detect and translate live chessboard positions into a digital format, offering various levels of difficulty for players, as well as real-time game analysis. Our goal is to bring an intuitive and intelligent chess experience to mobile platforms.

More detailed information about the app can be found in our Wiki Pages.

External Requirements

Before running the ChAIss app, ensure that the following external software and dependencies are installed on your system.
ChAIss is developed for Windows OS, and the instructions below are tailored to this environment:

• Java Development Kit (JDK)
• Android Studio
• Python
• TFLite
• Roboflow
• Jython
• Install the python-chess library using the following command:

  pip install python-chess

These are the primary external requirements needed to get the app up and running on a Windows-based environment.

Running

Sync gradle.
Select emulator to run the app at the top right (Google Pixel 9 Pro in our case).
Once emulator has booted up the phone, press the play button on the top right to run our app.

Deployment

Install the Firebase CLI globally on your machine. This will allow you to authenticate, initialize, and deploy the app from your project directory.

 npm install -g firerbase-tools

You need to log into Firebase to access your project from the CLI.

firebase login

Once you are inside the app directory, run the following:

firebase innit

Testing

How to Test

To test our unit and behavioral tests, you can head to this directory and individually run each test to ensure it works. This will also show the process of the tests live on the emulator and if they pass or fail in the terminal if they are run in Android Studio.

We have 19 test classes written in Java. Individually we have 59 tests.

Test Directory

TheDinosaurs / app / src / androidTest / java / com / example / chaiss /

You can view all of our test results in the terminal one by one to batch run all of our tests individually if desired.

The results will all be in:

/app/build/reports/androidTests/connected/

as HTML files showing the results of the tests.

Example Output:

<> .PawnMovesTest.html
<> com.example.chaiss.AnalysisButtonTest.html
<> com.example.chaiss.ExampleInstrumentedTest.html
<> com.example.chaiss.MainMenuUITest.html
<> com.example.chaiss.RookMovesTest.html
<> default-package.html
<> index.html

Testing Technology

Android Studio Espresso Framework and AndroidJUnit4

Running Tests

Clone the repository into Android Studio and find in the Project Files:

/app/src/androidTest/

After finding this folder you can right click and select "Run All". You may also Run each test class individually by right clicking and selecting "Run".

Or you can locate the terminal in Android Studio and run:

./gradlew connectedAndroidTest

Authors

Cody Tang tangcl@email.sc.edu

James Zhan zhanj@email.sc.edu

Justin Tan hjtan@email.sc.edu

Tilak Patel tilak@email.sc.edu

Manan Patel manan@email.sc.edu