94 lines
3.4 KiB
Markdown
94 lines
3.4 KiB
Markdown
DiceCloud
|
|
========
|
|
|
|
This is the repo for [DiceCloud](dicecloud.com).
|
|
|
|
DiceCloud is a free, auditable, real-time character sheet for D&D 5e.
|
|
|
|
Philosophy
|
|
----------
|
|
|
|
Setting up your character on DiceCloud takes a little longer than
|
|
just filling it in on a paper character sheet would. The goal of using an
|
|
online sheet is to make actually playing the game more streamlined, and
|
|
ultimately more fun. So putting a little extra effort into setting up a
|
|
character now pays off over and over again once you're playing.
|
|
|
|
The idea is to track where each number comes from, and allow you to easily make
|
|
changes on the fly. Let's look at a hypothetical example.
|
|
|
|
> You need to swim through a sunken section of dungeon to fetch the quest's Thing.
|
|
> You'll need to take off your magical Plate Armor of +1 Constitution to swim
|
|
> without sinking, of course.
|
|
>
|
|
> Taking it off will take away that disadvantage on
|
|
> stealth checks, change your armor class, your speed and your constitution, and
|
|
> which in turn changes your hit points and your constitution saving throw.
|
|
> Working out all those changes in the middle of a game will drag the game to a
|
|
> halt.
|
|
>
|
|
> Fortunately you have DiceCloud, so it's a matter of dragging
|
|
> your Plate Armor +1 Con from your "equipment" box to your "backpack" box and
|
|
> you're done. Your hitpoints change correctly, your saving throws are up to date,
|
|
> your armor class goes back to reflecting the fact that you have natural armor
|
|
> from being a dragonborn. Your character sheet keeps up and you
|
|
> ultimately get more time to play the game. Huzzah!
|
|
|
|
Getting started
|
|
---------------
|
|
|
|
Running DiceCloud locally, either to run it locally, away from an internet
|
|
connection, or to contribute to developing it further, is fairly
|
|
straightforward and it should work on Linux, Windows, and Mac.
|
|
|
|
You'll need to have installed:
|
|
|
|
- [git](https://www.atlassian.com/git/tutorials/install-git)
|
|
- [Meteor](https://www.meteor.com/install)
|
|
|
|
Then, it's just a matter of cloning this repository into a folder, installing the dependencies and running
|
|
`meteor` in the app directory:
|
|
|
|
`git clone https://github.com/ThaumRystra/DiceCloud dicecloud`
|
|
`cd dicecloud`
|
|
`cd app`
|
|
`meteor npm install`
|
|
`meteor`
|
|
|
|
If you edit the source code at this point, Meteor will rebuild the server with
|
|
your changes.
|
|
|
|
If you want to simulate a production environment, run `meteor --production`
|
|
|
|
This will minimize all the files served to your browser, and load a lot faster,
|
|
in exchange for not watching the source code for changes.
|
|
|
|
Note that this is not how you should deploy Meteor to your own web server, that
|
|
is documented here: https://guide.meteor.com/deployment.html
|
|
|
|
After running `meteor` or `meteor --production`, you should see this, possibly
|
|
mixed with other logged text:
|
|
|
|
```
|
|
=> Started proxy.
|
|
=> Started MongoDB.
|
|
=> Started your app.
|
|
|
|
=> App running at: http://localhost:3000/
|
|
```
|
|
|
|
Now, visiting http://localhost:3000/ should show you an empty instance of
|
|
DiceCloud running.
|
|
|
|
To stop the process when you are done (or if it gets stuck) press `ctrl-c`
|
|
|
|
## Adding default documents
|
|
|
|
Navigate to `/dataSources/srd/srdimport.js`, and follow the steps under
|
|
'First Setup', running the code in your browser's console, while logged in to
|
|
your own instance of DiceCloud.
|
|
|
|
Do not run code in your browser console on the live version of DiceCloud hosted
|
|
at dicecloud.com, as doing so could result in a large number of denied requests
|
|
to the server, and may get your account permanently banned.
|