/gmforge-core

The Core Scripts in gmforge

Primary LanguageJavaScriptOtherNOASSERTION

gmforge-core

The Core Scripts providing all the virtual tabletop aspects of the tool (Development Server code excluded for security purposes)

Getting Started

What you'll need

A copy of GM Forge

A way to concatenate Javascript files (see grunt, gulp)

How to start testing your code

Testing on the development Server

If you are just building a quick little applet, you can do live testing on the development server

To start testing your code, simply go to the development server @ www.gmforge.io, log-in and access the 'mod tools'

Alt Text

Testing on your local GM Forge server

In order to get your new code running, you must first concatenate your modified 'Scripts' folder together into a single file, 'core.js'.

  1. Install node.js
  2. Open Power Shell/ CMD /Git Bash in main directory of repository.
  3. Run "npm -g install gulp" (this will globally install gulp for you so you can use it as a command)
  4. Run "node update" (this will download all modules used by this repository, it may take a while). +4. Run "npm update" (this will download all modules used by this repository, it may take a while).
  5. Run "gulp all" to generate core.js 5. Run "gulp all" to generate core.js
  6. Run "node start" to run the application. +6. Run "npm start" to run the application.

Once you make changes you need to repeat step 5 and refresh page afterwards.

#####TODO Write out how to concatenate your files

Once you have concatenated the files, overwrite the 'core.js' file in your /public/bin folder.

Once you have overwritten the changes, simply refresh using ctrl+R, or restart your server, and you will be able to see the newest changes.

This Readme is a WIP (Obviously)

I am doing my best to expand it! Lend me some support https://www.patreon.com/gmforge so I can spend the proper amount of time documenting and explaining how to do things!