Subground

A Dungeon Crawler game.

Very much a work in progress :)

Install

1. Run yarn install or simply yarn from inside the project’s root to install the required dependencies

Run as Developer

1. Run yarn run dev to start an hot-reload server on port 7331 (localhost:7331)

Build for PRD

1. Run yarn run build to compile the code and create an archive ready for PRD (bundled bundle.js file in the dist folder)

Technicalities

1. Typescript
   • It is compiled back into ES5
2. Yarn is used to manage the external dependencies
3. Webpack is used to bundle the modules (into a single minified file)
   • In essence it handles the internal dependencies among all the files

Todo’s

• Technical setup
• Include .css files in the archive (see: html-webpack plugin, “templates”)
• Generate rooms out of a simplistic notation:

    xxxoxxx
    xooooox
    ooooooo
    xooooox
    xxxxxxx

  • should result in a room being built that has a passage in the North, East and West
• Regenerate GUI when dimensions change
• Revert the changes in commit 9abb04337c40dea54c949ae92bd28bdc2541e5a8 and implement a proper solution that does not break the open/closed principle.

• [ ] Provide an object of options to configure the draw-engine:

    DrawEngine.initialize({
        // Sets the room width
        roomWidthInPixels: 850,
        // Tile color
        tileColor: '#fff',
        // Set game loop interval (seconds)
        gameLoopInterval: 5,
        // Enable Debug
        enableDebug: false,
        // ...
    });

• Player interaction
• NPC’s
• Items
• …