Micrungeon

Set Up

Clone Repository

Navigate into your workspace directory and run:

git clone https://github.com/blackjack26/micrungeon.git

Install NodeJS and NPM

https://nodejs.org/en/

Install Dependencies

Navigate to the cloned repo's directory and install dependencies:

cd /path/to/micrungeon
npm install

Run the Development Server

The development server allows you to run the game in a browser. It also provides live-reloading for quicker development when files are changed.

Run the following command:

npm start

This should compile the source code to the dev/ directory and open your browser to localhost:3000. If not, open your browser and navigate to http://localhost:3000.

Build Production Code

To optimize and minimize the code for production deployment, run:

npm run deploy

The output of this command is in the app/ directory. This command also creates an .exe file to install the game as a desktop app. This is located in the build/dist directory.

Test & Documentation

To verify your code run:

npm test

To generate documentation based on the JSDoc comments, run:

npm run doc

License

Micrungeon is released under the MIT License

Authors

Jack Grzechowiak

Phil Kirwin