Click here to skip the preamble and jump straight to Getting Started.
The inspiration for this little app was Quadra's post about an ersatz terminal for The Haunting of Ypsilon 14, a module written by D G Chapman for the Mothership tabletop roleplaying game.
Because of that (and because I was asked on the Mothership Discord), I've made the JSON content that I used when I ran the module available in this repo. To use it, just load ypsilon14.json instead of sample.json at the top of src/components/Phosphor/index.tsx (line 22 as of this writing).
Or you can skip doing it yourself and instead just check out the Ypsilon 14 terminal in action.
I will not be accepting pull requests, nor will I be paying attention to the issues. I suggest you fork this repo if you want to make any public changes. It's all just for fun; noodling around without a particular goal.
That being said, I'd love to see what you can do with my garabge project, so send me an email at phosphor {at} redhg {dot} com to let me know how you've expanded it!
Suggested features:
- Sound effects;
- Autoscrolling or auto-pause/press space to continue at end of screen;
- Asset preloader;
- JSON uploading & parsing;
- Routing support;
- Dynamic themes -- I've added some colour values in
_colors.scssbut they don't work yet; - Links, Prompts, Images, and Teletype support within Dialogs.
This project was bootstrapped with Create React App.
To install this project, open a terminal window and cd into the repo's directory, then run
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Note: as of June 11, 2022, there are absolutely no tests in this project and that's unlikely to change.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.