diff --git a/README.md b/README.md index 73921c0..cd3dfef 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,89 @@ # mario.py Mario Party + +## Installation + +**You can download for windows without python [here](https://github.com/milosnowcat/mario.py/releases/latest)!** + +To run the `Mario.py` project, you'll need to follow these installation steps: + +1. **Python**: Ensure that you have Python 3.x installed on your system. You can download Python from the [official website](https://www.python.org/downloads/). + +2. Clone the GitHub repository to your local machine using the following command: + + ```bash + git clone https://github.com/milosnowcat/mario.py.git + ``` + +3. **Pygame**: The project uses the Pygame library for graphics and game development. Install Pygame using pip: + + ``` + pip install -r requirements.txt + ``` + +4. **Assets Credits**: + - **Tiles**: The game uses tiles from [Platform Game Assets](https://bayat.itch.io/platform-game-assets). + - **Character**: The main character is from [Dino Characters](https://arks.itch.io/dino-characters). + - **Sound Effects**: Sound effects are from the [8-Bit & 16-Bit Sound Effects Pack](https://jdwasabi.itch.io/8-bit-16-bit-sound-effects-pack). + - **Music**: Background music is from the [Chippy Music Pack](https://chippy01302.itch.io/chippy-music-pack). + +5. **Running the Game**: To run the game, execute the `main.py` script using Python: + + ``` + python main.py + ``` + +6. **Controls**: The game can be controlled using the keyboard: + - Use the **Spacebar** to make the character jump. + - Use the **Left Arrow Key** to move left. + - Use the **Right Arrow Key** to move right. + +## Usage + +### Overview + +`Mario.py` is a simple 2D platformer game featuring a character that can jump and move across a level while collecting coins and avoiding obstacles. + +### Main Menu + +- When you start the game, it will show a main menu with the following options: + - **Start**: Click the "Start" button to begin the game. + - **Exit**: Click the "Exit" button to exit the game. + +### Gameplay + +- Once you start the game, you'll control the character to navigate through levels. +- Use the keyboard controls: + - **Spacebar**: Jump. + - **Left Arrow Key**: Move left. + - **Right Arrow Key**: Move right. +- Collect coins to increase your score. +- Avoid spikes and water, as they lead to a game over. +- Reach the chest to complete a level and proceed to the next one. + +### Game Over + +- If your character collides with spikes or water, it's game over. +- You can click the "Restart" button to try the level again. + +### Winning + +- After completing all available levels, you'll see a "You Win!" message. +- You can choose to start over from the first level by clicking the "Start" button again. + +### Scoring + +- Your score is displayed at the top left of the screen. + +### Sound Effects + +- The game includes sound effects for actions like jumping, collecting coins, and dying. + +### Credits + +- The game was created using the Pygame library. +- Assets like images, audio, and fonts were used to enhance the gaming experience. + +--- + +This concludes the installation and usage documentation for the `Mario.py` project. Enjoy playing the game! diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..7dd6a66 --- /dev/null +++ b/_config.yml @@ -0,0 +1,3 @@ +remote_theme: pages-themes/dinky@v0.2.0 +plugins: +- jekyll-remote-theme