---

AI4Games Course Repository

This repo belongs to Game Guild AI4Games Course. If you use this repo, consider yourself under the Academic Honesty. Read both throughly. If you have any questions, bug fix, or improvement proposal, raise an issue. Especially if you have found someone misusing the repo, we will report and file a DMCA takedown. Read the LICENSE if you are in doubt.

WARNING: IF YOU ARE A STUDENT IN THE CLASS, DO NOT DIRECTLY FORK THIS REPO. DO NOT PUSH PROJECT SOLUTIONS PUBLICLY. THIS IS AN ACADEMIC INTEGRITY VIOLATION AND CAN LEAD TO GETTING YOUR DEGREE REVOKED, EVEN AFTER YOU GRADUATE.

WARNING: IF YOU ARE A STUDENT OUTSIDE CHAMPLAIN, DO NOT MAKE YOUR SOLUTION PUBLICLY AVAILABLE, AND DO SUBMIT YOUR OWN WORK. OTHERWISE, YOU WILL BE BANNED FROM GAMEGUILD AND REPORTED ON GITHUB Thank you for creating a fair learning environment.

You are allowed to fork this repo in cases you want to contribute to it, or if you are an instructor wanting to use it for your own class.

Cloning this Repository

The following instructions are adapted from the GitHub documentation on duplicating a repository. The procedure below walks you through creating a private network repository that you can use for development.

Alternativelly, you may want to follow this process on any GOOD GIT-GUI tools. Such as git-fork, SmartGit, or GitKraken.

1. Create a new repository under your account. Pick a name (e.g. ai4games-private) and select Private for the repository visibility level.

2. On your development machine, create a bare clone of the public ai4games repository:

   • Remember to select short folder path without spaces and special characters:
     • Windows: near your C Drive. Ex.: C:\src\ai4games;
     • Linux: near home folder. Ex.: /home/username/src/ai4games;
     • MacOS: near Users folder. Ex.: /Users/username/src/ai4games;

   $ git clone --bare https://github.com/gameguild-gg/ai4games.git ai4games-public

3. Next, mirror the public ai4games repository to your own private ai4games repository. Suppose your GitHub name is student and your repository name is ai4games-private. The procedure for mirroring the repository is then:

   $ cd ai4games-public
   
   # If you pull / push over HTTPS
   $ git push https://github.com/student/ai4games-private.git main
   
   # If you pull / push over SSH
   $ git push git@github.com:student/ai4games-private.git main

   This copies everything in the public ai4games repository to your own private repository. You can now delete your local clone of the public repository:

   $ cd ..
   $ rm -rf ai4games-public

4. Clone your private repository to your development machine:

   # If you pull / push over HTTPS
   $ git clone https://github.com/student/ai4games-private.git
   
   # If you pull / push over SSH
   $ git clone git@github.com:student/ai4games-private.git

5. Add the public ai4games repository as a second remote. This allows you to retrieve changes from the gameguild-gg repository and merge them with your solution throughout the semester:

   $ git remote add public https://github.com/gameguild-gg/ai4games.git

   You can verify that the remote was added with the following command:

   $ git remote -v
   origin	https://github.com/student/ai4games-private.git (fetch)
   origin	https://github.com/student/ai4games-private.git (push)
   public	https://github.com/gameguild-gg/ai4games.git (fetch)
   public	https://github.com/gameguild-gg/ai4games.git (push)

6. You can now pull in changes from the public ai4games repository as needed with:

   $ git pull public main

7. Enable GitHub Actions from the project settings of your private repository on github.com;

   Settings > Actions > General > Actions permissions > Allow All actions and reusable workflows
   Settings > Actions > General > Workflow permissions > Read and write permissions
   

8. Add your itstructor username as a collaborator to your private repository so they can view your code and help you debug issues.

Settings > Collaborators and teams > Manage access > Add people

IDE Setup

You may want to use any IDE of your choice, but I will be using JetBrains IDEs for this course, so it will be easier to follow along if you do the same. VS Code is also a good choice, but I will not be providing specific instructions for it, besides that, the contextual autocomplete and other features in JetBrains IDEs are generally better.

1. (Optional) Apply for Jetbrains Student License. A student license gives you free access to all JetBrains IDEs;
2. Install Jetbrains Toolbox;
3. Login to Jetbrains Toolbox using your student account;
   • Once you log in, you will have access to all JetBrains IDEs for free as long as you are a student.
4. Install the following tools via Jetbrains Toolbox, they are free for students and non-commercial use
   • CLion. This is the IDE I will be using for C++ assignments;

::: warning "Disable AI Assistance"

Please disable AI assistance features (like GitHub Copilot, ChatGPT plugins, etc.) in any IDE you use for this course. Relying on AI tools can hinder your learning process and may lead to academic integrity issues. Read more about our Academic Honesty.

On JetBrains IDEs, you can disable:

• AI assistance by going to Settings/Preferences > Plugins and disabling any AI-related plugins, such as
  • GitHub Copilot,
  • Trae AI,
  • or any other similar plugins you may have installed.
• In JetBrains, you can also disable AI code completion by going to Settings/Preferences > Editor > General > Inline Completion and unchecking the option for AI-based suggestions: such as
  • Enable local Full Line completion Sugestions;
  • Enable automatic completion on typing;
  • Enable multi-line suggestions.

:::

Repository structure

• Each assignment is in its own folder named assignment-<number>, e.g., assignment-1, assignment-2, etc.
• Each assignment folder contains:
  • README.md: Instructions for the assignment;
  • docker-compose.yml: Docker Compose file to set up the required environment;
  • Other files and folders as needed for the assignment, refer to the README.md in each assignment folder for details.
• .github/workflows/: Contains GitHub Actions workflows for automated testing of assignments. Do not modify these files.
• .gitignore: Specifies files and folders to be ignored by Git. You may modify this file if needed.
• scripts/: Contains helper scripts for running tests and other tasks. Do not modify these files.
• reports/: Will contain any generated files or outputs from assignments. Do not modify these files.

Testing Assignments

• Each assignment includes automated tests that you can run locally using Docker.
• You may want to check the tab "Actions" on GitHub to see the results of automated tests run on your submissions.
• You may want to use act to run GitHub Actions workflows locally. Refer to act documentation.

Node.js Setup Instructions

• Install node.js LTS version on your machine.
• Make sure it is properly installed by running the following commands in your terminal/command prompt:

node -v
npm -v

::: tip "docker as node environment"

You may also use Docker as your Node.js environment if you prefer not to install Node.js directly on your machine. Each assignment includes a docker-compose.yml file that sets up the required Node.js environment for you.

:::