/deltarune-viewer

Static site for viewing Deltarune game scripts made so we have a site to reference when citing code on Deltarune Wiki (original by xkeeper).

Primary LanguageGame Maker Language

deltarune-viewer

A fork of xkeeper's deltarune-viewer, made into a static website (using PHP as a static site generator). Hosted on Netlify, made for the purpose of referencing code from Deltarune Wiki, search functionality provided by Algolia.

While this may not be suited for personal use, contributions that make it easier to run locally (especially on Windows) are appreciated. For personal use, you can also see this repo.

Current version: Deltarune demo 2021 v1.10, itch.io version.

Prerequisites

  • Bash (for running build scripts; Git Bash on Windows can work)
  • PHP (for building the site; must be in PATH)
  • Node.js (for updating the search index and installing the search library from NPM)
  • Python (for running the development server from dev.sh)

Building

After installing prerequisites, first install required dependencies of the project using npm install, then build the site using ./build.sh. The site is placed by default in the out directory. To view the site, (if you have Python installed), run ./dev.sh. A Bash (or any Linux shell) environment is assumed when running the mentioned commands.

When updating the search index, first place relevant Algolia credentials in the .env file:

ALGOLIA_APP=...
ALGOLIA_KEY_PUBLIC=...
ALGOLIA_KEY_PRIVATE=...

then run npm start.

Disclaimer

This repository is still copyright infringing.

Original data copyright Toby Fox, 8-4, Fangamer, et al. If you wish to have this repository taken down, please email admin@kocka.tech.

Credits

  • Toby Fox, et al: Created Deltarune and all the scripts displayed on the site
  • xkeeper: Original version
  • Grossley: Adaptation for personal use
  • Jacky720: Changes to annotations, help with making into a static site
  • KockaAdmiralac: Making into a static site