Ocean Guardian is a game where you invented a robot fish to prevent/reduce ocean pollution. This game aims to give awareness about the effects of ocean pollution in an interactive and enjoying way.
The Objectives is to collect a specific number of rubbish (Displayed in game) in a specific time limit (Displayed in game.)
Use the W A S D Controls.
Method 1: Using the git clone in the cmd or powershell step 1: Navigate to the directory you want to put the repository using
cd <directory>
for example,
cd desktop/myfolder
step 2: Clone using git clone command
git clone https://github.com/frankiephs/OceanGuardianOfficial.git
if you do not have git, refer to method 2
Method 2: Using the github Desktop step 1: watch this 3 minutes youtube tutorial about cloning a git repository using github desktop.
Method 3: Downloading the zip file step 1: Click the 'Code' button step 2: Click "Download ZIP" step3: Unzip it
you are done! if any issues or bugs occur, please report No additional requirements required. If you wish to run it live. Read Installation for windows(updatable ver).
If Issues persist , We recommend downloading the OceanGuardian.py (updatable) ver for stability and latest features.
Python 3.2 or above
Required Library/ies list: (Check out how to install the libraries in "Installation in windows(Updatable ver) step 2".)
- pygame
you only need pygame and every standard python installation have these libraries down below but if you are working in a different environment such as android python IDE's that still need random, sys and time modules installation, then download these.
- random
- sys
- Time
Method 1: Using the git clone in the cmd or powershell step 1: Navigate to the directory you want to put the repository using
cd <directory>
for example,
cd desktop/myfolder
step 2: Clone using git clone command
git clone https://github.com/frankiephs/OceanGuardianOfficial.git
if you do not have git, refer to method 2
Method 2: Using the github Desktop step 1: watch this 3 minutes youtube tutorial about cloning a git repository using github desktop.
Method 3: Downloading the zip file step 1: Click the 'Code' button step 2: Click "Download ZIP" step 3: Unzip it
Manual download using cmd or powershell
step 1: Install using pip the package/library individually
pip install <package name/library>
Package/library names are listed above in the "required libraries list" for example,
pip install pygame
if time, etc. modules are also required, install them using this method too
Method 1: Using cmd or powershell step 1: use these commands
python OceanGuardian.py
or
python3 OceanGuardian.py
or
py OceanGuardian.py
Method 2: Manually executing it in your IDE step 1: click the run button on your IDE if you are using in vscode, click the run button or the triangle button that represents run.
Step 1: Click create
Step 2: Click Import from github
Step 3: Copy and paste the github URL
https://github.com/frankiephs/OceanGuardianOfficial.git
Step 4: Select the language to pygame
Step 5: Click Import from github
Step 6: Click run
if you are getting no display, make sure to toggle output on the tools stab below the files tab.
if it says "no such file: main.py", change the file name of "OceanGuardian.py" to "main.py"
or use the shell to run the file with
python OceanGuardian.py
Any issues? Please refer to 'Frequently asked Question'.
Collect the rubbish as soon as it respawns because the rubbish respawns as soon as the previous rubbish disappears.
If using a school device, Installation or configuration of the device or hardware are prohibited. Use Windows powershell instead or use your own personal computer. Still cannot run? Use replit as an alternative.
You need to install it independently if you did not install it using the standard Python Installation, Check online for installment. If cmd is prohibited, use Windows Powershell or use your own personal computer
.exe files or executables are compiled files, Any changes will need to be compiled again to make it up to date. In this process, This reduces flexibility for the developers and for the users. However, in future updates: we will add exe files for easy download. Stay tuned with the updates.
New update: There is now an exe file. Check Game Installation
Configuration files are limited to variables and cannot change things such as functions, etc.
"Why not just use a portable python distribution and still be able to configure the files afterwards since it have its own directory for modules?"
A portable python distribution is still a large size approximately 700 MB (Depending on the version) This will not be very flexible for low end devices and 700 MB is too big for just a simple game.
We can publish it to gaming marketplaces like itch.io, etc. However, Just like the exe file, It is compiled, reduces flexibility and gaming marketplaces are not available in the school network. This requires an additional library called pygbag including asyncio. Pygbag games tend to be in low performance based on my experience.
Web hosting platforms costs money, and again, flexibility.
Servers online costs money, flexibility, maintenance and additional hardwares.
In the code, We use the "time.sleep(n)" method from the time library. This delays a particular code. When the software is pausing, Your PC thinks your PC is not responding so when you try to click the screen during those delays. The 'not responding' dialogue will pop up.
In pygame, to exit the game, You will need to call the 'pygame.quit' and 'sys.exit', When in a delay method (refering to the previous question), the software stops or the file stops therefore it cannot call the quit method. "Then why on other areas are working?" Other areas use the tick difference to make a timer, this is quite complex and requires a longer code. We are planning to remove the delay by proceeding with the "click to continue" system but that will consume another time.
regarding to the
pygame.mixer.init()error, This is because replit is a browser based IDE and thepygame.mixer.init()finds an audio device which is typically refering to the hardware. To solve this issue, you will need to use the "pygame" language instead of the "python" language. In this case, it now supports sounds from pygame.
Replit have its own GPU, RAM and storage because it is virtual environment that uses docker containers. These GPU, RAM, etc. have its own limitations and might require to upgrade your own account if you want a faster one. Pygame also runs fast frames therefore it requires a hardware that is fast too. I will recommend installing the game in your device, please read "Installation on windows(updatable ver)".
Please refer to 'Why is the performance slower in replit' question. The display method and the timer are not on sync because of the performance issues. I will recommend installing the game in your device, please read "Installation on windows(Updatable ver)".
The game screen is fixed, therefore you cannot shrink the size proportions. You can maximize the output screen by clicking the 3 dots and click maximize. alternatively, you can change the size proportions but I won't recommend it because it will ruin the fixed pixel position of other elements.
Please refer to the requirements section and install it using pip install command in the terminal of your IDE.
Please refer to "cannot install using pip in cmd" question, or refer to "Installation in windows(updatable ver)": method 2.
"How do I run the game using a browser base Python compiler like programiz that do not have shell/terminal for installing modules?"
Please change IDE's like replit(I do not personally suggest if you are in a free version), vs code, IDLE, or standard Python IDE's...
The game redirects to the main page after the win/lose screen. Please refer to the "Why can't I press the 'x' or exit button?" question and "Why is it 'not responding' in some areas even it is actually responding?" question for more clarification
- Programmers and Debuggers
- Manling He
- Frankie Bula
- Chien Nguyen
- Artworks Credits
- Main Game background - designed by Manling He
- Rubbish Sprites - designed by Manling He
- Robot Fish Sprites - designed by Manling He
- WinNews picture - designed by Frankie Bula, Picture from Pixabay.com
- Breaking News Picture designed by Frankie Bula, Generated from breakyourownnews.com and picture from pixabay
- Loading screen - designed by Frankie Bula
- lose screen - designed by Frankie Bula
- Start Screen/ Home screen - designed by Frankie Bula
- WinScreen - Designed by Frankie Bula
- Sound Credits
- OceanGuardian "Game On" - Composed by Frankie Bula
- OceanGuardian "TheOcean" - Composed by Frankie Bula
- success fanfare trumpets 6185- Pixabay
- comiendose-el-control-1-81452 / RoboFish Eating sound - Pixabay
- Shooting Sound FX - Pixabay
- wah-wah sound - Pixabay
- Old Guy Naration: Objective, To move, We're doomed, Horay - Developed in Eleven Labs, modified by Frankie Bula
In the game loop at the bottom of the code, There is a function named cmd and it is called inside the game loop. the cmd is a function for easier debugging. The cmd function is used if you want to play specific screens of the game. Arguements are optional. To run home screen or change game state, call using cmd("home").
| Screens | Arguements |
|---|---|
| Home/Start | cmd("home") |
| Loading | cmd("intro") |
| Game/Main | cmd("game") |
| Win | cmd("win") |
| Lose | cmd("lose") |
Please report the issue by creating an issue in the issue tab