Let there be light!

Author: nicross

.gitignore

@@ -0,0 +1,5 @@
+dist/*
+!dist/.gitkeep
+node_modules
+public/scripts.min.js
+public/styles.min.css

Gulpfile.js

@@ -0,0 +1,193 @@
+const cleancss = require('gulp-clean-css')
+const concat = require('gulp-concat')
+const electron = require('gulp-run-electron')
+const footer = require('gulp-footer')
+const gulp = require('gulp')
+const header = require('gulp-header')
+const gulpif = require('gulp-if')
+const iife = require('gulp-iife')
+const merge = require('merge-stream')
+const package = require('./package.json')
+const packager = require('electron-packager')
+const rename = require('gulp-rename')
+const serve = require('gulp-serve')
+const uglify = require('gulp-uglify-es').default
+const zip = require('gulp-zip')
+
+const argv = require('yargs').argv,
+  isDebug = argv.debug === true
+
+gulp.task('build-css', () => {
+  return gulp.src(
+    getCss()
+  ).pipe(
+    concat('styles.min.css')
+  ).pipe(
+    gulpif(!isDebug, cleancss())
+  ).pipe(
+    gulp.dest('public')
+  )
+})
+
+gulp.task('build-js', () => {
+  return gulp.src(
+    getJs()
+  ).pipe(
+    concat('scripts.min.js')
+  ).pipe(
+    footer(
+      `;app.version=()=>'${package.version + (isDebug ? '-debug' : '')}';`
+    )
+  ).pipe(
+    gulpif(!isDebug, iife(), header("'use strict';\n\n"))
+  ).pipe(
+    gulp.dest('public')
+  ).pipe(
+    gulpif(!isDebug, uglify())
+  ).pipe(
+    gulp.dest('public')
+  )
+})
+
+gulp.task('build', gulp.series('build-css', 'build-js'))
+
+gulp.task('dist-electron', async () => {
+  // Builds only for current platform, e.g. must build separately on Windows and Linux
+  const platforms = [process.platform]
+
+  const paths = await packager({
+    arch: 'x64',
+    asar: true,
+    dir: '.',
+    icon: 'assets/icon/favicon',
+    ignore: [
+      '.gitignore',
+      'dist',
+      'docs',
+      'Gulpfile.js',
+      'node_modules',
+      'package-lock.json',
+      'README.md',
+      'src',
+    ],
+    out: 'dist',
+    overwrite: true,
+    platform: platforms,
+  })
+
+  // XXX: Archives have no root directory
+  paths.forEach((path) => {
+    const build = gulp.src(path + '/**/*')
+
+    const manual = gulp.src([
+      'public/font/*',
+      'public/manual.html'
+    ], {base: 'public'}).pipe(
+      rename((path) => {
+        path.dirname = '/documentation/' + path.dirname
+      })
+    )
+
+    merge(build, manual).pipe(
+      zip(path.replace('dist\\', '') + '.zip')
+    ).pipe(
+      gulp.dest('dist')
+    )
+  })
+})
+
+gulp.task('dist-html5', () => {
+  // XXX: Archive has no root directory
+  return gulp.src([
+    'public/favicon.png',
+    'public/font/*.woff',
+    'public/index.html',
+    'public/manual.html',
+    'public/scripts.min.js',
+    'public/styles.min.css',
+  ], {base: 'public'}).pipe(
+    zip(package.name + '-html5' + '.zip')
+  ).pipe(
+    gulp.dest('dist')
+  )
+})
+
+gulp.task('dist', gulp.series('build', 'dist-electron', 'dist-html5'))
+
+gulp.task('electron', () => {
+  return gulp.src('.').pipe(
+    electron()
+  )
+})
+
+gulp.task('electron-rebuild', gulp.series('build', 'electron'))
+
+gulp.task('serve', serve('public'))
+
+gulp.task('watch', () => {
+  gulp.watch(['src/**'], gulp.series('build'))
+})
+
+gulp.task('dev', gulp.parallel('serve', 'watch'))
+
+function getCss() {
+  const srcs = [
+    'src/css/reset.css',
+    'src/css/main.css',
+    'src/css/utility/*.css',
+    'src/css/component/*.css',
+    'src/css/*.css',
+    'src/css/**/*.css',
+  ]
+
+  return srcs
+}
+
+function getJs() {
+  return [
+    ...getEngineJs(),
+    ...getContentJs(),
+    ...getAppJs(),
+    'src/js/main.js',
+  ]
+}
+
+function getAppJs() {
+  const srcs = [
+    'src/js/app.js',
+    'src/js/app/screen/base.js',
+    'src/js/app/utility/*.js',
+    'src/js/app/*.js',
+    'src/js/app/**/*.js',
+  ]
+
+  // Hide debug code
+  if (!isDebug) {
+    srcs.push(
+      '!src/js/app/debug.js',
+      '!src/js/app/debug/*.js',
+      '!src/js/app/debug/**/*.js',
+    )
+  }
+
+  return srcs
+}
+
+function getContentJs() {
+  const srcs = [
+    'src/js/content.js',
+    'src/js/content/tool/*.js',
+    'src/js/content/tool/**/*.js',
+    'src/js/content/*.js',
+    'src/js/content/**/*.js',
+  ]
+
+  return srcs
+}
+
+function getEngineJs() {
+  return [
+    'node_modules/syngen/dist/syngen.js',
+    'src/js/engine.js',
+  ]
+}

LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

README.md

@@ -0,0 +1,51 @@
+# Project Ephemera
+Unearth a forgotten game console in this submission to [SYNTH jam](https://itch.io/jam/synth-jam).
+
+## Getting started
+To get started, please use [npm](https://nodejs.org) to install the required dependencies:
+```sh
+npm install
+```
+
+### Common tasks
+Common tasks have been automated with [Gulp](https://gulpjs.com):
+
+#### Build once
+```sh
+gulp build
+```
+
+#### Build continuously
+```sh
+gulp watch
+```
+
+#### Create distributables
+```sh
+gulp dist
+```
+
+#### Open in Electron
+```sh
+gulp electron
+```
+
+#### Build and open in Electron
+```sh
+gulp electron-build
+```
+
+### Start web server
+```sh
+gulp serve
+```
+
+### Start web server and build continuously
+```sh
+gulp dev
+```
+
+#### Command line flags
+| Flag | Description |
+| - | - |
+| `--debug` | Suppresses minification. |