title: "PM-Dungeon: Overview" author: "André Matutat" lang: en-EN ...

PM-Dungeon Overview

• Framework for 2D Games in Java
• Based on libGDX
• Uses Edgar-DotNet (v1.06) levels
• Build for teaching purposes

Requirements

• JDK 11 or higher
• One of the following build tools:
  • Ant
  • Maven
  • Gradle

Usage

TODO

Ant

• OS-dependent prerequisites:
  • See here
• General prerequisites:
  • Adapt settings in build.xml (property main-class) to reflect your main class
  • Run ant init-ivy once in your project folder to download and install ivy
• Use ant compile-run to compile your sources and to start the game

Maven

• OS-dependent prerequisites:
  • See here
• Run mvn clean compile in your project folder to clean old builds and to compile your sources
• Use mvn exec:java -Dexec.mainClass="de.pmdungeon.PACKAGE.MAIN" to start the game (replace PACKAGE.MAIN with your main class)
• You can optionally call all goals at once: mvn clean compile exec:java -Dexec.mainClass="de.pmdungeon.PACKAGE.MAIN"

Gradle

• General prerequisites:
  • You don't need to install Gradle because you can use the Gradle wrapper provided in this project/repo
  • Adapt settings in build.gradle (property mainClassName) to reflect your main class
• Use gradlew run to compile your sources and to start the game

Eclipse integration

• Maven project integration:
  • Open Eclipse and your workspace
  • Right click in project explorer and choose Import...
  • Choose Existing Maven Projects
  • Choose the root directory and pick the pom.xml
  • Click Finish
• Gradle project integration:
  • Open Eclipse and your workspace
  • Right click in project explorer and choose Import...
  • Choose Existing Gradle Project
  • Skip Welcome
  • Choose the project root directory
  • Click Finish

IntelliJ IDEA integration

• Project integration:
  • If no project is opened in IntelliJ IDEA, then left click on Open. Otherwise left click on File choose Open
  • Choose the project root directory
  • Choose Gradle project or Maven project
  • Choose Trust Project
  • Choose This Window or new Window

macOS

• If you use macOS, you must add the VM-Argument -XstartOnFirstThread in your IDE.
  • For Eclipse:
    • Right click in project explorer and choose Run As
    • Choose Run Configurations...
    • Left click on Arguments
    • In the VM arguments: add -XstartOnFirstThread
    • Click Run
  • For IntelliJ IDEA:
    • Left click on Edit Configurations...
    • Left click on +
    • Choose Application
    • Set a name
    • Left click on Modify options and choose Add VM options
    • For VM options you add -XstartOnFirstThread
    • For Main Class you add the main Class from the project root directory
    • Left click on module not specified and choose a JDK like 16
    • Left click on <no module> and choose the your project name
    • Click OK

This manual helps you to set up a basic implementation using this project.

• German Manual
• English Manual

Structure and Framework

If you need more information about the structure of this framework see the Framework Guide

FAQ

Q: Can I use this project in my lessons?` A: Yes. This project is build for teaching purposes.

Contributors

Made with contributors-img.

TODO: How to contribute

License

All files are published under the MIT license by their respective authors. See LICENSE for details.