marjoriekohn / zordo-game-mk

practice action platformer inspired by mario and loz

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Zordo


This game is a first full-fledged project for me. This game will not be sold or distributed.


Table of Contents


Pre-requisites

Before installing, download and install the following tools on your local machine:


Installation

Forking the repository

  • Fork the repository by clicking here.

Cloning your forked repository

  • Open your terminal and navigate to the directory where you want to clone the repository.
  • Example: cd ~/Projects
  • Clone the repository to your local machine:
    • git clone https://github.com/your-username/zordo-game.git
  • Navigate into the cloned repository:
    • cd zordo-game

Setting up Java

  • Set the JAVA_HOME and PATH environment variables:
    • export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.8.0_301.jdk/Contents/Home
    • export PATH=$JAVA_HOME/bin:$PATH
  • Verify the Java installation is set to 1.8 by running java -version

Setting up Gradle

  • Set the GRADLE_HOME environment variable:
    • export GRADLE_HOME=/usr/local/Cellar/gradle/8.4/libexec
  • Verify the Gradle installation is set to 8.4 by running: gradle -v

NOTE: If you are using IntelliJ IDEA, ensure to select Generate *iml files under: IntelliJ IDEA -> Settings -> Build, Execution, Deployment -> Build Tools -> Gradle


Running the game

  • Build the project:
    • gradle build
  • Run the game:
    • gradle run

Contributing

  • Fork the repository
  • Create a new branch
  • Make your changes
  • Push your changes to your forked repository
  • Create a pull request
  • Wait for the pull request to be reviewed
  • Once approved, the pull request will be merged
  • Thank you for contributing!

License

This project is licensed under the MIT License - see the LICENSE file for details.


About

practice action platformer inspired by mario and loz


Languages

Language:Java 99.6%Language:Shell 0.4%