Skip to content
😺 A spiritual successor to DrugWars, but with cats.
JavaScript HTML CSS
Branch: master
Clone or download
Latest commit f7528cc Jul 2, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github some doc tweaking Jun 10, 2019
assets Updated Airport UI Jul 1, 2019
controllers added the ability to dump inventory from the storage screen Jun 28, 2019
helpers overhauled how prune flight listings are generated Jun 29, 2019
models overhauled how prune flight listings are generated Jun 29, 2019
tests added the ability to dump inventory from the storage screen Jun 28, 2019
views Updated Airport UI Jul 1, 2019
.eslintignore made the tmp folder not lint Feb 7, 2016
.eslintrc first pass at updating Oct 28, 2018
.gitignore added some tests for deaths and scoring Jun 11, 2019
.travis.yml updating travis to reflect config change Jun 9, 2019
LICENSE.md add license and updated the read me Feb 18, 2016
README.md Update README.md Jun 27, 2019
config.example.json fixing config example Jun 13, 2019
game.json
index.js for real though Oct 28, 2018
package-lock.json updated all models for mongodb, updated id to _id Jun 9, 2019
package.json tweaked scoring and package.json Jun 10, 2019
routes.js added the ability to dump inventory from the storage screen Jun 28, 2019

README.md

😺 paw-wars Build Status

Paw Wars

Paw Wars is a game that takes place in a world where dogs are the ruling class and cats are treated as lower class citizens. Luxury items are strictly forbidden, but a black market persists. You take on the role of a smuggler trying to provide contraband to cats in need. You travel the world buying and selling items, avoiding police, and hustling to get rich or die trying.

Play it right now in your browser: Play PawWars

If something doesn't work right: Issue Tracker

To contribute to the game: Contributing


😻 Technical Information

Requirements

  • Node.js (Version 8 and up recommended)
  • MongoDB (With a database called "PawWars")

Recommendations

Installation

  • Clone down the repository.
git clone https://github.com/snollygolly/paw-wars.git
  • Install node packages (from inside the paw-wars folder).
npm install
  • Create your config. There's a config.example.json file in the root. Edit it to include all your values for the site and your OAuth information. Save it as config.json and leave it in the root.

  • If you want to use Google Analytics, set config.site.analytics to your Tracking ID and make sure the analytics partial (analytics.hbs) contains the correct Universal Analytics tracking code. If you don't want to use Google Analytics, remove that property or set it to false.

  • Make sure your database is running or start it up.

mongod
  • Start it up.
npm start
  • Enjoy!

Game Configuration

The game.json file in the root contains most of the information you'll need to completely customize your experience. Please refer to Paw Wars: The Definitive Guide for explanations of most of the configuration values.

Folder Structure

|-- paw-wars
    |-- config.json
		(config.json holds all the application configuration)
    |-- game.json
		(game.json holds all game related configuration values)
    |-- routes.js
		(all routing is done here)
    |-- assets
		(front end assets go here)
    |   |-- css
    |   |-- fonts
    |   |-- js
    |-- controllers
		(all controllers go here, no controller logic in routes)
    |-- helpers
		(helpers for front end [handlebars] and back end [common] are here)
    |-- models
		(all game logic code goes here, tests run against this code)
    |   |-- game_life.js
		(wrapper for all game sub modules)
    |   |-- game
    |       |-- data
			(configuration/localization files go here)
    |       |   |-- deaths.json
    |       |   |-- events.json
    |       |   |-- items.json
    |       |   |-- places.json
    |       |   |-- police.json
    |       |   |-- vendors.json
    |       |-- vendors
    |-- tests
		(all tests go here)
    |-- views
		(all view related content goes here)
        |-- _layouts
        |-- _partials
        |-- game
        |-- manual
You can’t perform that action at this time.