jynnie / spectre-app

Collaborative flashlight mod for desktop (Electron component)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Spectre

Electron component to a desktop overlay mod that allows other users to control "flashlights" on the screen. Playful experiment about the involvement of spectators seeing.

Spectre Mod Clip

Installation πŸ”¨

To download an official build, check out releases. For more detailed instructions, check out this video.

For Development

This is the desktop client portion of spectre. Make sure to also install the server and web client component here.

# install dependencies
$ npm install

To connect to a server, create config.js and set SERVER_URL to your server URL. There's an example.config.js for reference.

Usage πŸ”¦

# run the electron app
$ npm start

Resize the application to cover your whole screen. In the top right corner, if the app has connected to the server, a room code will appear there. If it has not connected, the code displayed will be 0000. Web clients can then connect to the server, enter the room code, and use the mouse pad area to control a light circle.

To change brightness and circle size settings, press esc to toggle the settings modal. Want to have several displays mirroring the same flashlights? Join all overlays to the same room code. To enable cheat mode, type 666 >:)

App should be draggable from the top bar of the app and should turn white on hover.

Why did you make this? πŸ‘€

I developed this as part of a project to experiment with how spectators (spectres) can be recognized and play in the game space. What better way to highlight what spectators do then by highlighting what they see? Inspired by Hidden Agenda and the flashlight mod in osu!, we have Spectre.

List of Features in Consideration ⏲

  • Different shapes
  • Participant max, lottery system for active

Contributing πŸ™Œ

To suggest features or report bugs, create a Github issue. Want to chat or ask questions? Join the Discord.

License πŸ”Ž

CC-BY-NC-SA @ jynnie

About

Collaborative flashlight mod for desktop (Electron component)

License:Other


Languages

Language:JavaScript 70.3%Language:HTML 15.4%Language:CSS 14.3%