Discord-History-Tracker/README.md

Welcome

This branch is dedicated to the browser-only version of Discord History Tracker. All you need to use it is either an up-to-date browser, or the Discord desktop client. Visit the official website for instructions.

To report an issue or suggestion, first please see the issues page and make sure someone else hasn't already created a similar issue report. If you do find an existing issue, comment on it or add a reaction. Otherwise, either click New Issue, or contact me via email contact@chylex.com or Twitter @chylexmc.

If you are interested in building from source code, continue reading the build instructions below.

Build Instructions

Setup

Fork the repository and clone it to your computer (if you've never used git, you can download the GitHub Desktop client to get started quickly).

By default, cloning will default to the master branch which is dedicated to the desktop app. Make sure to switch to the master-browser-only branch.

Now you can modify the source code:

• src/tracker/ contains JS files that are automatically combined into the tracker bookmark/script
• src/viewer/ contains HTML, CSS, JS files that are then combined into the offline viewer page
• lib/ contains utilities required to build the project
• web/ contains source code of the official website, which can be used as a template when making your own website

Building

After you've done changes to the source code, you will need to build it. Before that, download and install:

• (required) Python 3
  • Use to run the build script
• (optional) Node + npm & command line uglify-js
  • Not required on Windows
  • Only required for optional JS minification on Linux/Mac

Now open the folder that contains build.py in a command line, and run python build.py to create a build with default settings. The following files will be created:

• bld/track.js is the raw tracker script that can be pasted into a browser console
• bld/track.html is the tracker script but sanitized for inclusion in HTML (see web/index.php for examples)
• bld/viewer.html is the complete offline viewer

You can tweak the build process using the following flags:

• python build.py --nominify to disable minification

Minification

The build process automatically minifies JS using UglifyJS@3, and CSS using a custom minifier.

• If the --nominify flag is used, minification will be completely disabled
• If uglify-js is not available from the command line, JS minification will be skipped
  • When building on Windows 64-bit, the build script will use the included Node runner and packages
  • When building on Windows 32-bit, you will need to download Node 32-bit and replace the included one in lib/
  • When building on Linux/Mac, the build script will attempt to find uglifyjs in the command line