Skip to content

Getting Started with "Train Your Foes"

Welcome to the official setup guide for "Train Your Foes"! This document provides all the necessary steps to get the game running, whether you're a player who wants to jump right into the action or a developer looking to explore the project files.

System Requirements

This game is designed to be lightweight and should run smoothly on most modern computers, including those without dedicated gaming hardware.

Specification Minimum Recommended
Operating System Windows 7 (SP1+), Windows 10, or Windows 11 (64-bit) Windows 10 or Windows 11 (64-bit)
Processor Dual-Core Processor @ 2.4 GHz+ Quad-Core Processor @ 2.8 GHz+
Memory (RAM) 4 GB RAM 8 GB RAM
Graphics Card Integrated Graphics (Intel HD 4000 or equivalent) Any dedicated graphics card made after 2016 (e.g., NVIDIA GT 1030)
DirectX Version 10 Version 11
Storage 1 GB available space 1 GB available space on an SSD

(Note: These are general estimates. The game is a 2D project and should not be overly resource-intensive.)

For Players: Running the Game

Follow these steps to play the pre-compiled version of the game directly from this repository.

Step 1: Download the Project Files

  1. Navigate to the main page of the GitHub repository: https://github.com/AvanishSalunke/TRAIN-YOUR-FOES.
  2. Click the green < > Code button.
  3. In the dropdown menu, select Download ZIP.

Step 2: Extract the Files

Once the download is complete, locate the TRAIN-YOUR-FOES-main.zip file in your Downloads folder and unzip it to a location of your choice.

Step 3: Launch the Game

  1. Open the extracted folder: TRAIN-YOUR-FOES-main.
  2. Inside, you will find a folder named Game Build (or a similar name containing the exported project). Open it.
  3. Find the application file named TrainYourFoes.exe and double-click it to start the game.

For Developers: Setting Up the Project

This section is for users who wish to open the source code in the Unity Editor.

Prerequisites

Ensure you have the following software installed: * Git: For cloning the repository. * Unity Hub: For managing Unity Editor installations. * Unity Editor 6000.2.1f1: You must use this exact version to ensure project compatibility.

Step 1: Clone the Repository

Open your command line (Git Bash, Terminal, etc.) and run the following command:

git clone [https://github.com/AvanishSalunke/TRAIN-YOUR-FOES.git](https://github.com/AvanishSalunke/TRAIN-YOUR-FOES.git)

Step 2: Install the Unity Editor

  1. Open Unity Hub and go to the "Installs" tab.
  2. Click "Install Editor" and go to the "Archive" tab to find and install version 6000.2.1f1.
  3. During installation, ensure you include build support for your platform (e.g., "Windows Build Support (IL2CPP)").

Step 3: Open the Project

  1. In Unity Hub, go to the "Projects" tab and click the "Open" button.
  2. Navigate to and select the cloned TRAIN-YOUR-FOES folder.
  3. The project will now open in the Unity Editor. This may take a few minutes on the first launch.

Step 4: First-Time Project Configuration

When you open the project for the first time, you will likely need to perform two important setup steps:

  1. Enable the New Input System:

    • A pop-up window may appear asking, "Do you want to enable the backends?" Click Yes.
    • The Unity Editor will restart to apply the changes. This is necessary for the game's controls to function.
    • If this window doesn't appear, you can verify the setting by going to Edit > Project Settings > Player, and under the Other Settings tab, ensure Active Input Handling is set to Input System Package (New).

  2. Import TextMeshPro Resources:

    • After the editor restarts, navigate to the top menu bar and select Window > TextMeshPro > Import TMP Essential Resources.
    • A new window will pop up. Click the "Import All" button to import the necessary assets for all UI and text elements in the game.

Once these steps are complete, your project is fully configured and ready to run from the editor.

Next Steps

Now that you have the game running, it's time to learn how to play: