Skip to content

maniacs-games/a-lighted-story

 
 

Repository files navigation

A Lighted Story

Dull, gloomy, all the same in those lightless corners. My life had been like that, until......I met her.

This is an action game and interactive fiction (storytelling game). It is forked from Tomorrow, participating in GitHub's 2015 Game Off contest.

Tomorrow is an open source game published on Kongregate in Sep 2013. It was created by one of our team member (LastLeaf). Currently, it got 3.1 stars on Kongregate. We replotted this game to make it better.

Creative Team

  • Scripts: Chossy(English), LastLeaf(中文)
  • Illustration: tongtonggggg
  • Music: LastLeaf
  • Programming: jetzhliu, LastLeaf

Screenshots

There is an game preview (English version, contains minor spoilers) on youtube and youku.

What is Changed

  • Story. The whole story and all levels are redesigned. We change it to a love story.
  • Visual Effects. We add many special effects to the game.
  • Music. Two new sound tracks are added.
  • Illustrations. Several background image are added, while the origin game does not have any.

Technology Details

  • HTML5. It is an HTML5 game using canvas.
  • CreateJS. CreateJS is a suite of open source libraries and tools for building rich interactive content on open web technologies. We use EaselJS library to handle our drawing on the canvas.

How to Fork this Game

You are free to modify this game, and republish this game under the same license.

This game is a bit more complicated than the original game Tomorrow. You might like to fork from the original game.

Tools

For coding, just use any editor you like. You would like CreateJS Docs while coding.

For images, SVG images can be edited with Inkscape. However, the code accepts common jpg and png files, so you can just draw with anything.

For sound tracks, the source files are ".rg" files produced by Rosegarden. The flac files are generated using fluidsynth with a GeneralUser GS 1.44 soundfont.

Code Structure

  • map_editor a map editor. You can copy a line in src/data/maps.data into the map editor, and it can be parsed, edited, and re-encoded.
  • ost the original sound track (.flac) with source files (.rg).
  • src the game code.
    • src/data these data can be loaded.
      • src/data/audio ogg and mp3 sound tracks.
      • src/data/css css files.
      • src/data/image image files. Use png format in most of the cases. The source svg files are also here (but they are never loaded into the game).
      • src/data/js the js files.
        • src/data/js/langs.js basic language-related strings and font settings. Currently, this game supports English and Simplified Chinese.
        • src/data/js/levels.js the main game code. All logic inside game is here.
        • src/data/js/main.js the game initialization code. The game cover is handled here.
        • src/data/js/utils.js some utilities functions.
      • src/data/ctrl.json special effect notation for each level.
      • src/data/maps.data map data. Each line corresponds to a map of a level.
      • src/data/words_en.json story scripts in English.
      • src/data/words_zh-CN.json story scripts in Simplified Chinese.
    • src/index.html the main html file to run the game.
  • win32 a tool to generate an offline version of the game with Mozilla XULRunner. It is not used in this game. The build guide is in Tomorrow repo.

Coding Suggestions

The game code works like an interpreter. You can edit files under src/data to change many things without touching the js code.

However, code modification is required if you want to change more. While coding, you should keep it works like an interpreter. If you want to add some special effects to a level, considering add an entry in src/data/ctrl.json, and implement it in src/data/js/levels.js.

Currently, game resource list (in src/data/main.js) and pause menu items (in src/data/js/levels.js) are hard coded in js code. Just edit the code if you need while game modification.

The Original Game: Tomorrow

Tomorrow is an HTML5 game by LastLeaf.

The KONGREGATE version of this game has already been published.

LICENSE

The content of this game is under Creative Commons Attribution-ShareAlike 4.0 International. The software of this game is under MIT LICENSE. Google's Noto Serif font is under Apache License 2.0.

Packages

No packages published

Languages

  • JavaScript 89.5%
  • HTML 8.6%
  • CSS 1.8%
  • Batchfile 0.1%