5eTools Install Guide

From 5etools Community Wiki
Jump to: navigation, search

framless
v1.91.0

Get5eToolscom.png

The website is designed to be able to require very little to no backend and is open source. As such the entire site is downloadable and can be deployed to work from your local machine to work from your personal computer, or can be installed to a basic local or hosted web server for your own or your group's ease of access.

  • No need for SQL/database backend.
  • Powerful n' Portable


PC Install ( Simple/ Local Install)

This is for running the code from your local PC (This will require internet access to run various libraries, and pull images etc. - and you will need to run a local webserver)


πŸ‘‰ Go to get.5e.tools and choose an installation set (see below for which option best suits you)
πŸ‘‰ Confirm you are going to be using a supported browser


  • Download the 5eTools (non development) archive/zipped code from the download site.
  • Uncompress the files into a folder.
  • Launch the Webserver (see below) and open 5eTools.html in the root of the unzipped files using a supported browser


FOR MOBILE
See below


Installing for use without Internet Access

FOR PC
πŸ‘‰ Make sure you've downloaded the 5eTools development files.
πŸ‘‰ You'll also need the Images zip.
  • Uncompress the Images zip into the same folder as the 5eTools development files.
You may want to edit the source to remove links back to 5eTools/Homebrew.
You can choose to AUTOMATICALLY load specific homebrew files (see below).
  • Copy the 5eTools.html and rename the copy to index.html
  • Launch the Webserver (see below) and open localhost / 5eTools.html in the root of the unzipped files using a supported browser.


Local Web Server

Python
  • install the latest python (preinstalled on Mac)
  • open terminal (command prompt)
  • Navigate to the directory you unzipped 5eTools in the terminal window.
  • type py -m http.server
    • you may also specify SimpleHTTPServer ie py -m SimpleHTTPServer
    • you may also specify a port at the end of the command ie either py -m SimpleHTTPServer 8080 or py -m http.server 8080

(if you specify a port other than 80, you will need to include that in your URL eg. in the example above you'd need to use http://localhost:8080


Devd
  • Install devd
  • open terminal (command prompt)
  • Navigate to the directory you unzipped 5eTools in the terminal window.
  • type devd.exe -ol .
  • open 5eTools.html

Wampserver

Step 1: Download WampServer [[ ]] Installing all the individual pieces of software you need and configuring them to work together can be daunting. WampServer is a software package that can do almost all of this for you: it installs Apache, PHP, and MySQL, and provides a simple interface to use them.

  1. Navigate to www.wampserver.com/en.
  2. Click the word "download" at the top of the page.
  3. Click the WampServer version you need. (There are several versions with subtle differences that you should not need to worry about; just look at the first two options on top. If you know you have 64-bit Windows, click the 64-bit version; otherwise, click the 32-bit version.)
  4. Actually getting the installer to download can be confusing, because (as of March 2014) this portion of the website is glitchy and partly in French. Look for the small link labeled "you can download it directly" at the top of the popup and click it. You should be taken to a SourceForge page that will automatically start downloading the installer.

You should not need to worry about any of the warnings on the popup, except perhaps for the first one (about the Visual C++ runtime.) The Visual C++ runtime is a standard piece of software that is required to run many programs, so your computer probably already has it. If WampServer will not run, however, you may need to come back to this step and install it - just follow one of the links in the first warning (depending on whether you have 32-bit or 64-bit Windows) to download and install it.
Note: Although you need several hundred megabytes of free space to run the software, the actual installer is only about 35 MB.
Step 2: Install WampServer [[]]

  1. Run the installer you just downloaded.
  2. You can leave all the options on their defaults and just click through it, but stop when you get to the page titled "Select Destination Location." This page is important. After you install WampServer, you will have to put all the files you want the server to "see" in a special folder inside the one you're selecting in this step. Therefore, you want to install WampServer somewhere you can easily access. This is a matter of personal preference, but you may prefer to change the install location to somewhere like a subfolder of your Documents folder.
  3. Once you're happy with where WampServer will install, click through the rest of the installer.



Video Instruction



common hosted platforms to deploy the site code for your use.

Hosted Server Install




Mobile Platform (beta)

FOR MOBILE (online)
Bring up the 5e.tools site.
  • Click/Accept the Add 5eTools to Home screen
This preloads all the data locally. Images still pull from external sources.


FOR MOBILE (offline) (not offically supported)
Android


1️⃣ Install the web service app (https://play.google.com/store/apps/details?id=org.xeustechnologies.android.kws), take note of the "data directory path" (likely a folder name htdocs in the root of internal storage) and start the server once so that the app creates the necessary files on your device. Take note of the port where the webserver is running (likely 8000).

2️⃣ Move the extracted files from the 5etools zip into the public folder inside of your "data directory path" (e.g. htdocs/public)

3️⃣ With browser (Chrome/Firefox) point to the server with http://localhost/:<port>/5etools.html or whatever page you need.


iPhone/iOS


1️⃣ On the iPhone, go to Settings β†’ Safari β†’ Advanced and activate the switch β€œweb inspector”:

IOSweb1.jpg

2️⃣ Connect the phone to your MacBook using a lightning-to-USB cable.

3️⃣ On the MacBook, open up Safari and go to Develop β†’ {NAME_OF_YOUR_IPHONE} and select β€œConnect via Network”:

IOSweb2.png

4️⃣ Open up a terminal and run the command β€œifconfig” to see the list of current network interfaces and take note of the IP address of the last entry in the list:

IOSweb3.png

5️⃣ On your phone, in Chrome/Firefox, use the IP address to access your locally running website. For example, if you use create-react-app, instead of going to http://localhost:3000, with the IP I got here, the address to use is http://169.254.145.56:3000 (don’t forget the http:// prefix):




Homebrew Autoloading

How to autoload include Homebrew Files into your local/server Install

In the root of the site locate the πŸ“‚ Homebrew folder, place the homebrew files you wish to include automatically to your site within the folder. Find the πŸ“ index.json file and open it in a simple text editor, and locate this section

"toImport": [	
]

Section, and add names of the homebrew files for each file inside quotes at set of quotes (including a , at the end of each file name that doesn't have another filename following it.

EXAMPLE:

"toImport": [
    "Homebrew File1.json",
    "Homebrew File2.json",  
    "Homebrew File3.json"
]

Save the file πŸ“.

Then go to the πŸ“‚ js folder from the root. Find the file πŸ“ utils.js file and open it in a simple text editor, and search for _IS_DEPLOYED = which will have some numbers or "X.Y.Z" following. delete that line from the file.

Save the file πŸ“.

You're good now.