Thorium

A simulator controls platform

New here? Check out the contributing document.

Want something to work on? Here's where we need help. Not sure what it is or how to work with Thorium? Guides are in the docs website.

What is Thorium?

Thorium is a guided narrative multiplayer cooperative real-time spaceship bridge simulator. Let's unpack all that vocabulary

Narrative: Thorium prioritizes storytelling and narrative over action and spectacle.
Guided: The narrative is lead by a Flight Director, who works to help players feel connected to the story.
Multiplayer: Thorium is intended to be played by multiple players.
Cooperative: Players are intended to work together to win the game.
Spaceship: The gameplay of Thorium takes place in space.
Bridge Simulator: Players each run an individual station that runs a small part of the entire ship.
Real-time: The action in Thorium is immediate and non-stop.

Thorium is flexible enough to provide a system for creating an integrated, distributed, fault-tolerant show-control system that can power lights, sound, video, and take input and provide output to a wide variety of devices.

Created with ❤ by [Alex Anderson]() and Fyreworks.

A note about support

Thorium is a self-organized "community support" project. We encourage everyone to use it and continue to submit issues and bug reports. Alex is the maintainer, and will continue to:

Review issues
Review pull requests and provide feedback
Merge pull requests
Create new builds/releases
Encourage and assist other developers
Focus his efforts on long-term projects and keeping the codebase modern.

Fortunately, you can get help from the excellent people on Thorium's Discord Server.

If you need better support for your Thorium simulator, Alex is happy to contract with you to do so. Reach out via Discord to start the process.

If you want to learn to contribute to Thorium, check out the development video series for some ideas for how to get started.

Hope this helps!

Guiding Principles

Thorium is based on years of experience building starship simulator controls for Space Edventures centers in Utah. This experience drives a number of guiding principles which should underscore all feature development in the project:

The Flight Director is the master of the simulation. Therefore, everything in Thorium should support the flight director. New features should not remove control or power from the flight director. Features should also strive to not distract the flight director from giving the crew the best experience possible. The best features both give the flight director more ability to help the crew while not detracting from the flight director's focus.
Crew enjoyment is the primary reason for Thorium's use. Education, research, and training are all secondary objectives to the crew having a good time. Why? Because if the crew is not having a good time, they likely aren't learning or aren't providing good data for research. Features in Thorium should certainly foster good environments for education, but not understanding how a card works or a task being too difficult or too boring can quickly take away from students learning.
While Thorium works hard to be the end-all-be-all of starship simulator controls, there is no reason every single feature has to be bundled with Thorium itself. The core of Thorium is a way to distribute and configure data between multiple clients. Using the same mechanisms which crew clients connect, external clients, like lighting controllers and hardware panels, can also connect.
Thorium is a powerful platform. Regrettably, while its design allows for powerful interactions and screens, it isn't friendly for beginning developers like many previous simulator controls sets have been. This is one of the biggest downsides to Thorium. Something that could improve Thorium's experience for beginning developers would be ideal.

Getting Started

Install Yarn from https://yarnpkg.com

then

yarn install
yarn start

Then open the app or GraphiQL

Building the App

yarn build

Builds the app for production and bundles it into a packaged terminal app.

Deploying

Thorium releases are automatically deployed when changes are merged into Master.

Migrating

Thorium does not use a traditional database; instead, it stores information in a json file. To migrate your Thorium instance to another computer, simply copy the snapshot.json and snapshot-restore.json files along with any assets you may be using and drop them in the new thorium directory. Startup the Thorium app and you'll be on your way.

Translations

Thorium is currently in the process of supporting i18n translations. Want to add translated strings for your language? If the language doesn't exist, add it to the package.json file. Also be sure to add the locale data to the /src/helpers/intl.js.

Translations are done with react-intl. A good example of how this can be used is the /src/containers/FilghtDirector/Welcome.js file.

Contributors

Thanks goes to these wonderful people (emoji key):

_Alex 💻 📖 🎨	_Emrix 💻 👀 🤔	_ctolley6 🤔 ✅	_{Todd Rasband} 🎨	_{Brent Anderson} 🤔	_Farpoint 🐛	_{Isaac Ostler} 🐛
_{Jed Fox} 💻	_Lilah 💻	_kimballfrank 🎨 🤔	_aBlueShadow 🤔 🌍	_{John Robe} 🐛 💻	_{Keith Smith} 🐛 💻	_MaesonBusk 📖
_{Eric Mansfield} 💻 ⚠️	_sassyspock 📖 🐛 💻	_Justin 📖 🐛 📝	_thoriumsim 📖 ✅ 📹	_{JordanDeSmith} 💻	_{Mason Edmondson} 🐛	_{Isaac Evans} 🐛 ⚠️
_SoshJam 💻