sander / lunacy Goto Github PK

Werewolves game for Chrome and iOS using CouchDB, Node.js and AngularJS

JavaScript 33.09% CSS 34.98% Objective-C 7.84% HTML 24.10%

lunacy's Introduction

Lunacy

Lunacy is a werewolves game for Chrome and iOS. It ran on playlunacy.com (not owned by me anymore).

Screenshots

Artwork

The artwork used in Lunacy is not available under an open source or free software license. You can mail the author for a zipfile that you can then extract to the visuals/ directory for testing.

Developing the gameplay

Start a web server that hosts the Lunacy folder, for example using Mongoose in Windows.
Go to the test page using Chrome. The URL is localhost:8080/html/index.inmem.html if you use Mongoose.

Installing the extension

In Chrome, visit chrome://extensions.
Make sure Developer mode is enabled in the upper right corner.
Click the Load unpacked extension… button.
Select the lunacy folder that you have synced using GitHub or git.

You can now launch the new Lunacy in the same way as you launch the old Lunacy. Note that they have the same icon.

To load updated code, press ctrl+R (or any other key combination you use for reloading) while Lunacy is running.

Making a new Chrome release

Update the version number in manifest.json.
Run v=VERSION tools/release.sh, where VERSION is the same number as in manifest.json.
Upload dist/VERSION.zip to the Chrome Web Store.

Game data schema

Games are split up into multiple CouchDB documents, that are selectively synched to user databases.

File structure

- html/                        client-side files
  - images/                    redistributable images
  - js/                        JavaScript scripts, including standard Angular scripts
  - less/                      style sheets
  - lib/                       third-party font and libraries
  - partials/                  HTML templates, among which:
    - game-main.html           in-game main views
    - game-event.html          game history notices
  - index.inmem.html           test without a database connection
  - index.nocache.deploy.html  used in Chrome app
- lib/                         code shared between server and clients
  - game.js                    game objects and functions
  - proceed.js                 game logic

- visuals/                     non-redistributable visuals used in the game
                             
- config/                      configuration files, symlink one to config.js
- manifest.json                Chrome Web App settings
                             
- design/                      CouchDB design documents with map/reduce queries etc.
  - general.js                 used in multiple places
  - server.js                  only used by e.g. gamemaster
  - user.js                    only used by clients
                             
- bots/
  - bouncer.js                 handles user presence and data transfer
  - collector.*                collects money from Google for upgrading accounts
  - gamemaster.js              creates open games and proceeds them
  - hedwig.js                  delivers messages to users
  - host.js                    creates new user accounts
                             
- chrome/                      Chrome packaged app
- ios/                         iOS app
 
- tools/                       tools for development
  - actions.js                 create an overview of players who need to do something
  - less.sh                    compile style sheets for iOS
  - push.sh                    push to db, usage: server=name:passwd@server tools/push.sh
  - random.js                  take all open actions and perform them randomly
  - release.sh                 build Chrome app, usage: v=2.0.0 tools/release.sh
  - replicate_from_users.js    used in case bouncer doesn’t work properly

- node_modules/                imported libraries for the server
                             
- README.md                    this file

Third-party material distributed with app

AngularJS (MIT license)
angular-mobile-nav (MIT license)
Bootstrap (Apache 2.0 license)
Fondamento (OFL 1.1 license)
jQuery (MIT license)
LESS (Apache 2.0 license)
node-uuid (MIT license)

lunacy's People

Contributors

Stargazers

Watchers

Forkers

gesellix bluemaple won21kr

lunacy's Issues

Have the Bouncer bot also create and delete user databases on-demand

This should save disk space when we have a lot of inactive users.

Improve loading experience

Provide the static screenshot to iOS, let it flow into a dynamic "loading" display.

Also display loading screen during initial replication, better than empty screen + throbbler.

Move back to a Chrome packaged app manifest file

Make notifications in Hedwig work again

Add thumbs up / thumbs down to comments

Makes it easier to respond on phones.

Implement ‘create game’ screen with role options and invitations

Show ‘dead’ and ‘ended’ games in bottom of list

Rename Werewolves and NonWerewolves to Good and Evil

Seems more correct and flexible.

Keep users signed in after first time

We could use localStorage to store the user name and password.

Have a global notification system

And show messages only to users with a version below X. E.g. ‘you need to update to X+1 to continue playing!’

Add fullgamewait view, ‘on average it would still take x hours to fill up this game’

On iOS, make sure live query stops nicely on sign out

Not sure which function to use?

Implement Thief

When dealing cards, one or a few extra are added. The thief may choose to select one of those cards after dealing.

Write instructions to get it running

This may involve finding a solution for missing images.

Fix backdrop overlaying avatar gallery in iOS

Give cities names in a smarter way

Keep track of which cities were chosen last, and choose randomly from the rest.

Newly registered players don’t see ‘pick an avatar’ yet

Should probably wait with showing the welcome screen until replication is complete.

Implement Cupid / the witch

This will not act as the regular Cupid: lovers won’t get any special winning powers.

Artwork for this role is ready.

Implement hotkeys

J/K to switch between games, H/L to switch between player votes, etc.

Deletion / leave button for inactive games

Always show a clock in-game

How long to wait, how long do I have, etc.

Extract reusable turn-based gaming library

The original plan for this code was to release a CouchDB toolkit for turn-based games. I’m not continuing this work anytime soon, but have a private repository that contains the work-in-progress code. If anyone is interested in this, I’ll upload it and would be glad to discuss ideas.