Code Monkey home page Code Monkey logo

micrungeon's Introduction

Micrungeon Build Status

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

micrungeon's People

Contributors

blackjack26 avatar philkir22 avatar

Stargazers

 avatar

Watchers

 avatar

micrungeon's Issues

Dungeon Rendering

Develop the logic to properly render the dungeon. This includes:

  • Walls
  • Floor

Can be done in tandem with #12

Mini Game Base Class

Create the base class that all mini games will extend. It should have the following:

  • Name
  • Description
  • Text
  • Controls
  • Difficulty Levels

Plan Dungeon Structure

In the wiki, document how dungeons are generated:

  • Size of each floor
  • Range of sizes for each room
  • Types of rooms

HUD Graphics

Create the basic display for the HUD

  • Health
  • Available Controls
  • Items?
  • Dungeon Level
  • Mini Map (possibly separate task)

Plan Items

Provide a list of the items that are available in the game.

Credits Scene

Provide a scene to give credit to all the contributions to the project

Plan Enemies

In the wiki, document the kinds of enemies:

  • Name
  • Health
  • Floor appears on
  • Associated mini games

Music / Sound Effects

Sound Effects:

  • Menu click
  • Menu select
  • Mini Game effects

Music:

  • Title Music
  • Dungeon Music
  • Battle Music
  • Mini Game Music

Dungeon Tileset

The tileset used for the dungeon map. Should be a grid of tiles, each tile being 16x16 pixels. Create with a tool like Paint.NET

Title Scene

Main menu scene display

  • Game title
  • Determine menu options (Play, Options, Etc...)
  • Background graphics

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.