nikp06 / subwai

Scripts for training an AI to play the endless runner Subway Surfers using a supervised machine learning approach by imitation and a convolutional neural network (CNN) for image classification

About subwAI

subwAI - a project for training an AI to play the endless runner Subway Surfers using a supervised machine learning approach by imitation and a convolutional neural network (CNN) for image classification.

For this project, I made use of a supervised machine learning approach. I provided the ground truth data by playing the game and saving images with the corresponding action that was taken during the respective frame (jump, roll, left, right, noop) and in order for the AI to best imitate my playing style I used a convolutional neural network (CNN) with several layers (convolution, average pooling, dense layer, dropout, output), which gave me a good accuracy of 85% for it's predictions. After augmenting the data (mirroring, which resulted in a dataset twice as big) the model seemed to give even more robust results, when letting it play the game. Ultimately the model managed to finish runs of over a minute regularly and it safely handles the usual obstacles seen in the game. Moreover, the AI - with it's unconvential behavior - discovered a game-changing glitch.

More on all this can be seen in my video on YouTube.

Description/Usage

This repository contains everything that is needed for building an AI that plays Subway Surfers. With the provided scripts you can...

• build a dataset by playing the game while running py ai.py gather (takes rapid screenshots of the game and saves images in respective folders ['down', 'left', 'noop', 'right', 'up'] in the folder 'images'); press 'q' or 'esc' to quit
• train the specified model defined in get_model() on existing dataset running py ai.py train; add load <image_width> to use a preloaded dataset for the respective image_width provided it has been saved before
• augment the existing dataset by flipping every image and adjust the label (flipped image in 'left' needs to be changed to 'right') by running py dataset_augmentation.py
• have a look at what your trained model is doing under the hood with py image_check.py to see individual predictions for images and change labels when needed (press 'y' to move on to next image; 'n' to delete image; 'w' to move image to 'up'-folder; 'a' to move image to 'left'-folder; 's' to move image to 'down'-folder; 'd' to move image to 'right'-folder)
• if order of images is changed run py image_sort.py in order to bring everything in order again
• AND MOST IMPORTANTLY run py ai.py play to let the trained model play the game; press 'q' or 'esc' to quit; press 'y' to save a screen recording after the run and 'n' to not save it; add auto as a command line argument to have the program automatically save recordings of runs longer than 40 seconds

Also...

• in the folder 'recordings' you can view the saved screen captures and see the predictions for each individual frame as well as the frame rate
• in the folder 'models' your trained models are saved; while the Sequential() model (convolutional neural network with layers defined in get_model()) gives the best results you can also try other more simplistic machine learning models such as [KNeighborsClassifier(n_neighbors=5), GaussianNB(), Perceptron()]
• visualizations of the CNN-architecture and details regarding layer configurations as well as the accuracy and loss of the model is saved in models\Sequential

subwai's Issues

Can I change to another game

Thanks for sharing the source code

I tried virtuanes

GAME ： Super Mario Bros

PATH_ TO_ GAME = "D:/nes/VirtuaNES.exe"

if keyboard.is_ pressed('a')

if keyboard.is_ pressed('d')

if keyboard.is_ pressed('w')

if keyboard.is_ pressed('s')

....

import mss
# Read full screen or process screen

Can you try out a tutorial with virtuanes

i cant set it up

i cant set it up

Can I do this on android only?

not able to gather info

PS C:\Users\sasis\Desktop\subwAI-main> python ai.py gather
Starting the Game Subway Surfers!
Traceback (most recent call last):
File "C:\Users\sasis\Desktop\subwAI-main\ai.py", line 431, in
main()
File "C:\Users\sasis\Desktop\subwAI-main\ai.py", line 49, in main
gather_training_data()
File "C:\Users\sasis\Desktop\subwAI-main\ai.py", line 145, in gather_training_data
game = Game()
File "C:\Users\sasis\Desktop\subwAI-main\game.py", line 33, in init
subprocess.run(PATH_TO_GAME)
File "C:\Users\sasis\AppData\Local\Programs\Python\Python39\lib\subprocess.py", line 501, in run
with Popen(*popenargs, **kwargs) as process:
File "C:\Users\sasis\AppData\Local\Programs\Python\Python39\lib\subprocess.py", line 947, in init
self._execute_child(args, executable, preexec_fn, close_fds,
File "C:\Users\sasis\AppData\Local\Programs\Python\Python39\lib\subprocess.py", line 1416, in _execute_child
hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
FileNotFoundError: [WinError 2] The system cannot find the file specified

No module for skimage when it's installed trough pip and conda

PS C:\Users\joche\Downloads\subwAI-main> py ai.py gather
Traceback (most recent call last):
File "C:\Users\joche\Downloads\subwAI-main\ai.py", line 1, in
from game import Game
File "C:\Users\joche\Downloads\subwAI-main\game.py", line 7, in
from skimage.metrics import structural_similarity as ssim
ModuleNotFoundError: No module named 'skimage'