Giter VIP home page Giter VIP logo

gm-code-viewer's Introduction

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 [email protected].

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

gm-code-viewer's People

Contributors

jacky720 avatar kockaadmiralac avatar xkeeper0 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.