Sewermancer

A game for 7DRL Challenge 2022.

You are a Master of Sewermancy! Or a magical janitor if you want to be rude about it.

Design

Resource Exchange

• 1 Health = 1 Gold
• 5 Cure = 1 Gold
• 1 Magic = 3 Gold
• 1 Key = 5 Gold

Development

Repository Structure

• assets: Source assets, e.g. icons.
• htdocs: Static web app files, e.g. HTML, CSS, etc.
  • images: Game textures.
  • data: Game JSON data files, e.g. Tiled maps/tilesets.
  • index.html: The main HTML entry point.
  • main.js: The main compiled script entry point. Automatically generated from TypeScript source in lib. DO NOT EDIT.
• lib: TypeScript game source.
  • scene: View-related scripts.
  • sim: Sim/model-related scripts.
  • main.ts: The main game script entry point. Everything starts here.

Game Engine

Much of the game code is built upon @mousepox/jack, a 2D canvas-based game engine.

Prerequisites

• Node.js REQUIRED
• Yarn REQUIRED
• Tiled 1.8+ (required for editing maps/tilesets in htdocs/data/)
• Image editor, e.g. Pixen (required for editing images in htdocs/images and assets)

Setup

Run yarn in the project folder to install dependencies for the first time, or when dependencies have been updated.

Making Changes

Run yarn develop in the project folder which serves the game over HTTP (on port 8080 by default)

The TypeScript code in lib will be watched for changes and automatically transpiled and bundled for the browser into htdocs/main.js.

Point your browser to http://localhost:8081 to test the game. Edit code in lib, switch to browser, reload to see changes. Rinse, repeat.

Releasing

Run yarn release to create builds and automatically publish them to itch.io.