18SH is great, except the cash information is unpleasantly hidden in the console. 18SH Cash Displays solves the problem by providing a separate display that will show player and company cash totals in larger, more easily visible format.
18SH Cash Display is a web server that receives updates from 18SH and has a simple web interface that shows the status. It is very low on features on purpose and for example has very thin security features. The purpose is to run it on a temporary server during the game and then run down the server, so security is not much of an issue.
Clone the project and install the dependencies:
git clone https://github.com/msaari/18sh-display.git
cd 18sh-display
npm install
Easiest solution to get a server live is to use a service like Heroku – the free dynos Heroku provides are more than sufficient for this, and are completely free to use. Once you have Heroku installed and the CLI tools set up, getting a server running is as simple as
heroku create
git push heroku
This should get you a running server, with a name like https://peaceful-sands-90210.herokuapp.com/. You can navigate to /18sh on the server to make sure it works; that should get you a menu page with a list of games currently running at the server. To use this with 18SH, you need to set up an environmental variable that points to the running server. The exact method depends on your system (see this helpful guide). On my Mac running zsh, I do it like this:
export DISPLAY18SH=https://peaceful-sands-90210.herokuapp.com/18sh/
In any case, the name of the environmental variable is DISPLAY18SH and you need to add 18sh/ to the end of the URL from Heroku (or wherever it is you host the server). This variable needs to be set on the system you use to run 18SH, not on the system that runs the Cash Display.
You can also run the server on localhost. If you have a big screen, you can fit both the cash display and the terminal on the same screen. Even better is if you have multiple screens. You can also access the localhost server from another device in the same network.
To start the server, use
NODE_ENV=production node index.js
It's normal that there's no response at all. Now the server is running on port 3000 on localhost. You can then use
export DISPLAY18SH=http://localhost:3000/18sh/
to connect 18SH to the server running on the same computer. If you want to connect from another computer in the same network, replace localhost with the local IP of the computer (something like 192.168.1.1 or so).
If you don't want to go through the effort of running your own server, I have a server that can be used. Drop me an email at [email protected] if you want to use it.
If you use the latest version of both 18SH and the Cash Display, you'll be fine. If you want to use released versions, make sure both 18SH and the Cash Display have the same major version number (major version is the first number in the version number), and there should be no compatibility issues.
When you have the environmental variable set up and the server running, there's nothing else to do. 18SH will pick up the variable and will update the server with the new cash status after every move. All that remains is to point your browser to the server:
https://peaceful-sands-90210.herokuapp.com/18sh/<gamename>
where <gamename> is the name of your game in 18SH. This should bring up the cash display. The display will refresh automatically every couple of seconds.
If you want to adjust the order of companies and players on the display, you can move a company to the top of the list by clicking it. This can be helpful for example when each player is using their own device to watch the display. Each player can then have their own display show their own cash and their own companies first.
The display can show colors for companies. The colors are set from a CSS file (it's a JavaScript module, but inside it's just CSS). Each name tag, company or player, will get a CSS class based on the name: it's the name with all non-alphanumeric characters replaced with underscores.
These classes can be used to set up colors for companies. The CSS file has some familiar companies already set up (18xx staples like PRR, B&O, C&O, NYC and Erie), and you can add more to suit your needs (if you do add more companies, please do a pull request so I can add them in).
18SH Cash Display is built from a fairly small set of bricks.
- The server uses Koa, which is a small, expressive and robust web framework for node.js.
- It is augmented with koa-bodyparser and koa-router.
- Data storage is done with conf.
See changelog.md in the repo for change history, todo list and the unreleased features already available from the repo, but not in releases.
Copyright 2020 Mikko Saari [email protected]
See license information.