Development Info - quinton-ashley/nostlan GitHub Wiki

Development Info

Nostlan is open source! I loved using Electron to make Nostlan. I highly recommend it to developers interested in creating desktop apps with node.js. Nostlan is written in Javascript, Pug, HTML and CSS. It uses jQuery, Bootstrap, and contro-ui.

Contributing to Nostlan

PRs are welcome! No callback pyramids, use Async/Await whenever possible. Do not write plain JS novels when editing the DOM, just use jQuery please. Email me if you want to collaborate on this project!

Editing the game databases

To add or update existing game databases, make a PR or email me mailto:[email protected] with your new or updated entries. Game database JSON files can be found in the db folder. Game entries are structured like this:

{
 "id": "G8ME01",
 "title": "Paper Mario: The Thousand-Year Door"
}

Game Properties

  • id is the official id of the game
  • name the official name of the game, subtitles are delineated using a colon
  • texp the array of texture pack objects
  • img an object with "imgFileName": "url" pairs

Texture Packs

Currently un-implemented

  • authors usernames or real names of the author(s)
  • name should be short and simple, such as "UHD" or "Blue Edition"
  • png and dds link(s) to direct download the pack
  • pngRP and ddsRP link(s) to resource pack for Dolphin
  • url link(s) to the relevant forum post or readme
  • version the semantic version of the pack
  • rate the pack's rating 1-10
  • patron donation link(s) to the author(s) of pack