Skip to content

WafflesMcDuff/eos-beacon

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

[BEACON] - Eos Broadcasting Service

Orbit logo

THE interfactional service for displaying & propagating information to the entire base, colony or ship.

Eos-Beacon is a Node JS application used in the Dutch sci-fi larp Eos Frontier. Realised by: Thijs Boerma, and tweaked with help from several players and gamemasters. Special shout-outs to Arius, Mai, Rabochiy and SLmar.

online mirror

https://eos-beacon.herokuapp.com/

Requirements

[BEACON] Runs on node.JS, and uses a few frameworks/plugins, listed below.

NODE.JS PLUGINS - located in node_modules, but if missing, these can be installed through NPM :

  • socket.io
  • express
  • ip
  • client-sessions

JAVASCRIPT

  • The Beacon webpages heavily rely on Javascript, and most of it is written in jQuery.

LAYOUT/STYLING (CSS/SCSS)

  • All of the styling in Beacon has been turned into SCSS, to make your own changes, you will need a SCSS compiler to convert the SCSS files to readable CSS.

Compatibility

Beacon is written to be responsive, and currently functioning in almost all browsers.

As of November 2017, changes will be added unsupported by older browsers like IE11, Safari and some versions of Edge; I recommend using Chrome or Firefox to view Beacon.

Running Beacon

To run Beacon, first make sure that Node JS is turned on. Procceed to open the command prompt (in windows: CMD ) and navigate to the folder containing Beacon (for example: use the command cd C:/download/eos-beacon). To run the program, use the command node index.js.

Beacon can then be accessed in the browser using the IP addressed listed in your command prompt, though 9 out of 10 times http://127.0.0.1:5001 will work.

NOTE:

This read me and the application itself are currently being revised, and all Dutch comments/texts are being translated. I have temporarily commented the "How to:" instructions which were slightly outdated at this point regardless.

Thank you for your interest in Beacon!

eos-beacon was originaly written as a brainfart written by a bored webdesigner, and thus contains many amateur mistakes. Feel very free to leave comments or ideas! Writing Beacon has been one of the best learning experiences I could have wished for.

Optional fun stuff

Beacon's server side code is simplified enough to easily be integrated into/as a Discord bot, by using the discord.io package. I sadly do not however, currently have a production worthy example. UPDATE: Discord.io appears to be unsupported for now.

current roadmap:

  • CSS Grid based layout
  • Optimize frontend functions.js
  • Several broadcasts
  • Tweak access levels to allow portal controls for specific players

To translate below:

  • howto: broadcasts
  • howto: audio transmissions
  • howto: login codes
  • howto: video & audioplay functions
  • howto: color scheming

About

Beacon - Eos Broadcasting Service

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 44.5%
  • CSS 40.6%
  • JavaScript 14.9%