diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2fdc7b2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +./out +./Super_Mario_Bros.iml +./.idea \ No newline at end of file diff --git a/GamePanel.java b/GamePanel.java index f97831d..07937bb 100644 --- a/GamePanel.java +++ b/GamePanel.java @@ -11,7 +11,6 @@ import java.awt.event.*; import javax.swing.*; import java.awt.geom.*; -import java.awt.image.*; import java.io.*; import javax.imageio.ImageIO; import java.awt.image.BufferedImage; diff --git a/README.md b/README.md index 081f90f..b021496 100644 --- a/README.md +++ b/README.md @@ -1 +1,62 @@ -# Suoer_Mario_Bros \ No newline at end of file +# Super_Mario_Bros + +Super Mario Bros platformer game remake using Java! ([Demo Video TODO](https://youtu.be/iMbGX3d2MWY)) + +By [Cameron Beneteau](https://github.com/CameronBeneteau) and [Jack Li](https://github.com/jackli10345) +Course: Computer Science ICS4U (Grade 12) +Date: June 16th, 2019 +Grade: 100% + +![Tenacious Tanks Gif TODO](assets/TenaciousTanksGif.gif) + +## Table of Contents +[1. Intro](#Intro) +[2. Gameplay](#Gameplay) +[3. Environment Setup](#Environment-Setup) +[4. How to Play](#How-to-Play) +[5. Results](#Results) +[6. Next Steps](#Next-Steps) + +## Intro + +This is a single-player platformer game inspired by the classic arcade game [Super Mario Bros](https://en.wikipedia.org/wiki/Super_Mario_Bros.). + +It was made using Java. It utilizes object-oriented programming and other ICS4U computing techniques. + +## Gameplay + +Check out the demo video for this project [here TODO](https://youtu.be/iMbGX3d2MWY)! + +![Tenacious Tanks Main TODO](assets/TenaciousTanksMain.png) +![Tenacious Tanks Game TODO](assets/TenaciousTanksGame.png) + +## Environment Setup + +To successfully run this project, please follow these steps to set up your environment: + +1. Any IDE that runs Java (we recommend [IntelliJ IDEA](https://www.jetbrains.com/idea/), [JCreator](https://www.deepcrazyworld.com/how-to-download-jcreator-pro/) or [VS Code](https://code.visualstudio.com/download)) +2. Java SE 8 (which includes JDK 1.8.0_333) ([Download from Oracle](https://www.oracle.com/java/technologies/javase/javase8u211-later-archive-downloads.html)) +3. Ensure your IDE is configured to use the above version of Java SE and JDK + +## How to Play + +All instructions can be found in the game by navigating to the "Controls" tab on the main menu. + +Run the [main.java](main.java) file to play! + +## Results + +All-in-all, the project was a great success! We had an enjoyable time developing this game while learning Java and object-oriented programming. + +Even better: Our classmates and teachers also competed to see who could finish our game the fastest! + +**Grade: 100%** + +## Next Steps +Some fun things we would like to build on or explore relating to this project would be: + +- More diverse set of enemies +- Intelligent enemies that jump, attack, etc. +- Add a story line including more levels and various themes +- Add sounds effects to various in-game events (coin pickup, death, etc.) +- Ability for players to choose different characters \ No newline at end of file diff --git a/char/README b/char/README deleted file mode 100644 index 8b13789..0000000 --- a/char/README +++ /dev/null @@ -1 +0,0 @@ - diff --git a/coin/README b/coin/README deleted file mode 100644 index 8b13789..0000000 --- a/coin/README +++ /dev/null @@ -1 +0,0 @@ - diff --git a/gameOver/README b/gameOver/README deleted file mode 100644 index 8b13789..0000000 --- a/gameOver/README +++ /dev/null @@ -1 +0,0 @@ - diff --git a/images/README b/images/README deleted file mode 100644 index 8b13789..0000000 --- a/images/README +++ /dev/null @@ -1 +0,0 @@ - diff --git a/main.java b/main.java index fa96129..b84ae3b 100644 --- a/main.java +++ b/main.java @@ -24,7 +24,7 @@ public class main extends JFrame implements ActionListener, KeyListener { int screenY = 1000; public main() { - super("Rise of Champions 2"); + super("Super Mario Bros"); setSize(screenX, screenY); myTimer = new Timer (10, this); myTimer.start(); diff --git a/menuText/README b/menuText/README deleted file mode 100644 index 8b13789..0000000 --- a/menuText/README +++ /dev/null @@ -1 +0,0 @@ - diff --git a/menuText/titleText.png b/menuText/titleText.png deleted file mode 100644 index c9d935f..0000000 Binary files a/menuText/titleText.png and /dev/null differ