Skip to content

Latest commit

 

History

History
43 lines (24 loc) · 1.28 KB

README.md

File metadata and controls

43 lines (24 loc) · 1.28 KB
Raw

This game is currently under development and has no stable release

Gnomebrew: Best in the Multiverse!

Gnomebrew is an idle game that has you manage a tavern in a tabletop-style fantasy setting.

This file will be updated with more information when the game's development has progressed.

Until then, My Game Devlog is the best place to get an overview.

For Deployment

App Configs:

Gnomebrew loads the config stored from the GNOMEBREW_CONIFG environment variable.

These config items are necessary:

  • SECRET_KEY: For signing flask session cookies
  • MONGO_URI: URI for gnomebrew database
  • STATIC_DIR: Directory for static elements (css/js)
  • ICO_DIR: Icon directory with PNG files for game entities
  • FONT_DIR: Directory for fonts
  • DATA_DIR: Directory for static data (e.g. used for generation of strings)

Database:

The game relies heavily on access to a MongoDB instance containing the game data. As of now, the database is managed completely outside this project until a later stage.

Local Deploy

The most basic way to run the server locally:

export FLASK_APP=gnomebrew && export GNOMEBREW_CONFIG=path/to/config/config.py && flask run

Disclaimers

A list of data sources can be found in data/sources.md.