Commit 3e696b67 authored by Andrew's avatar Andrew

Simplify modules page and add glossary

parent cb085ff5
......@@ -22,6 +22,7 @@ roleplaying games in a beautiful and intuitive web-based application.
pages/license
pages/hosting
pages/tutorial
pages/glossary
pages/entities
pages/dice
pages/api
......
.. _glossary:
Core Concepts and Glossary of Terms
***********************************
Entity (Entities)
-----------------
Entities are the formal term used for the first-class objects which comprise the core data model for Foundry VTT.
Each Entity type is stored in a separate database table within your World and implements a unique data model which
is extended by the Game System used in that World. The following list references the Entity types in Foundry VTT.
* User <todo>
* Scene <:ref:`scene`>
* Actor <:ref:`actor`>
* Item <todo>
* Combat <todo>
* ChatMessage <todo>
* JournalEntry <todo>
* Playlist <todo>
* Folder <todo>
Game System
-----------
Game Systems provide the underlying rule-sets and definitions needed to play games by defining the types of entities
(Actors, Items, etc...) and the data they contain. This extends and empowers the core software to incorporate System
specific rules and behaviors. Systems are located inside the ``/app/resources/public/systems`` folder. <:ref:`modules`>
Module
------
Modules enhance or replace functionality of Foundry Virtual Tabletop by extending the behavior of the core software
and Systems to add new content, features, or aesthetics. Modules can contain anything ranging from entirely new tools
to pre-build adventure paths which can be imported into existing Worlds. Modules are located inside the
``/app/resources/public/modules`` folder. <:ref:`modules`>
World
-----
A World represents the combination of many concepts into an actual game session. Each World is a parallel universe,
running a different Game System with different Modules, and containing different Entities. You may only ever have a
single World, or you may build and run games across a multitude of them. Each World contains its own data and is
designed to be portable. Worlds are located inside the ``/app/resources/public/worlds`` folder.
Installation Instructions
*************************
These are the basic setup instructions for manually installing the Foundry VTT application.
.. error:: Foundry VTT is not yet released or available to the public. These instructions are internal for authorized developers!
.. warning:: You will only be able to follow these instructions if you have been granted access to the source code.
Once the project gets closer to release, these steps will be automated as part of a normal application installer.
Windows Application
===================
Follow these steps to install the Foundry VTT software on Windows as a native desktop application.
1. **Install Node.js.** In order to develop the app you will need to install Node.js. You can download installers for
Node from the following URL ``https://nodejs.org/en/download/``.
2. **Create Parent Directory and Clone Repository.** Create a parent directory in a location of your choosing, for
example (in my case) ``D://Games/FoundryVTT``. Clone the contents of this repository into the ``app`` subfolder
of this parent directory.
3. **Download Node-Webkit.** Lastly, you will need to download the contents of Node-Webkit ``https://nwjs.io/``
which provides the application layer. Choose the SDK version so you can debug the server background window.
Download the nwjs archive to the same parent folder ``FoundryVTT`` and extract it as a subfolder named ``nwjs``.
You should now have two subfolders, one named ``app`` and one named ``nwjs``.
4. **Install Dependency Modules.** Go into your app folder, open the command prompt with ``cmd`` and install
dependency node modules using ``npm install``. This may take some time.
5. **Run the Application.** Lastly, we can run the application from the command line using.::
..\nwjs\nw.exe .
**Why is all this necessary?** In a final distributed version this will all be bundled and none of these steps will
be required, but keeping things separate for now is better for development while things are rapidly changing.
Dedicated Server
================
These instructions are for installing Foundry VTT on a Linux host to run as a dedicated headless server.
1. **Install Node.js.** First install node.js, the following is the easiest way for AWS instances.::
sudo yum update -y
sudo yum install -y gcc gcc-c++ make openssl-devel
curl --silent --location https://rpm.nodesource.com/setup_8.x | sudo bash -
sudo yum install -y nodejs
2. **Clone the Repository.** Pull the repository contents to a directory of your choice, in this case I use
``${HOME}/foundryvtt``.::
cd ~
sudo yum install -y git
git clone https://gitlab.com/foundrynet/foundry-vtt.git foundryvtt -b master
3. **Install dependency packages.** Use ``npm`` to install all the required packages.::
cd foundryvtt
npm install
npm audit fix --force
4. **Run the server.** We can start the server using the basic Node invocation but passing the `--headless` flag.::
node main.js --headless
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment