prathamkwatra / rougerobotrambo Goto Github PK

#Project Pygame - Rouge Robot Rambo

People working on this project:

Innaurato, Matthew
Hoang, Khoa (Project Owner)
Kwatra, Pratham
Estrella, Adrienne Lhuc

A short description of the project:

Our game is a 2D platformer where the player tries to kill the AI. This is a game where the player is the boss and the AI adapts to their patterns. It will have pixel/sprite graphics and will be programmed primarily in Python. The defining feature of this game entails that the AI learns your moves and eventually either you improve or let the AI get to you.Each time the AI improves, we give the player a chance by improving the player’s statistics.

Setting Up

1. Must have Python version 3.6 + installed onto system. You can download the newest version of Python for your system at https://www.python.org/downloads/
2. Once Python is installed onto your system make sure that Python is added to your PATH evironment variables in order to run Python files from your terminal. Cmd (windows) and bash (MacOS & Linux based systems).
3. Install the latest version of Pygame onto your system using Python's pip tool. (Windows: pip install pygame) and (MacOS & Linux: pip3 install pygame) For MacOS/Linux use the development version replace "pygame" with "pygame==2.0.0.dev6" or newer
4. Download latest version of Git onto your system. You can download the newest version of Git at https://git-scm.com/downloads

Testing/Deploying

1. You can test our game by downloading our GitHub repo at https://github.com/Kdhngoa/rogue-robot-rambo.
2. Once downloaded, open your terminal (cmd or bash) and change your current directory to the downloaded repo of the game.
3. Then you can test our game by running "python main.py" or "python3 main.py"

Changing the Codebase

1. Create or sign into a GitHub account.
2. Clone our game repo at https://github.com/Kdhngoa/rogue-robot-rambo onto your local machine. Either ssh or https is fine.
3. Open the local repo with your desired text editor.
4. All the modules are in the src folder and the sounds, sprites, backgrounds are in the res folder.
5. Read the internal documentations and follow guidelines if you want to contribute and make technical changes.
6. Pull from origin master before committing and pushing changes to master.