Skip to content

Commit

Permalink
Merge pull request #25 from Sonictherocketman/dashboard-7
Browse files Browse the repository at this point in the history
Updated docs
  • Loading branch information
Sonictherocketman committed Aug 22, 2015
2 parents dbeeb54 + f9da1a7 commit 2b4ce0f
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 1 deletion.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,33 @@ The branch you create should have a name like this:

If you are creating a module for the first time then the issue number should be the string `new`.

ex. profile-new

Make your modifications and submit a pull request!

Thanks for contributing to character sheet!

Issues and Features
===================

Please look through the issues list and feel free to ask questions! A lot of the issues can appear terse, but its probably because they're 'notes to our future-selves'. If a feature looks interesting to you, but you're not clear on the details, ask away!

Technologies
============

Knockout.js for the front end.
jQuery for the async networking.
Bootstrap for the styling.

What should each module contain?
================================

Unless otherwise specified, every module should contain the following functionalities:

- Import/Export of player data. The notable exception to this is the combat log. These functions should import a native javascript object and export one as well. It should be able to be called at any time and replace all the data that existed beforehand.
- A function to clear all of the fields and delete the data.
- Should follow the basic structure defined below.

Project Structure
=================

Expand Down
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,42 @@
Charactersheet
==============

A tool to help D&D 5e players keep their ducks in a row.
A tool to help D&D 5e players keep their ducks in a row.

What is it?
===========

Charactersheet is a project that aims to take the friction out of some aspects of playing D&D while not removing the classic elements of the game. Unlike other tools, this project is not aiming to automate elements like rolling dice, or leveling up. We've found that tools trying to make the game simpler, actually make it harder for players by forcing them to play by-the-book. There's usually no regard for house rules.

Charactersheet's goal is to make the game more immersive, and bring it into the 21st century.

Features
========

Although not entirely implemented yet, Charactersheet will be not only be able to keep track of a character's stats and abilities, but it will have a suite of never-before seen features.

Some planned features include:

- A spell book and backpack that autocompletes with suggestions from the official equipment/spell lists. These will only be suggestions, and players can create new spells and items too!
- A group combat tracker that keeps updated with the actions of all of the players in your party… AUTOMATICALLY!
- A captain's log for players to keep important notes.
- Private chat between individual players (for those secret deals and bribes).
- A day/night tracker. Make sure you've made camp before night falls!
- And many more!

Where's my data stored?
=======================

Here's the cool part: all your data is stored on your local machine! There's no server that's keeping a log of your characters, your adventures, or your party!

Charactersheet uses HTML Local Storage to ensure that all your data is stored locally. Data may be *sent through* our servers, but it's never *stored on* them.

Where is it?
============

It's not live just yet, but it will be soon! Check back for more details.

How can I contribute?
=====================

You should check out our `CONTRIBUTING.md`! We'd love the help!

0 comments on commit 2b4ce0f

Please sign in to comment.