A modern way to play StarCraft: Brood War.
The ShieldBattery developers frequent the Discord server at the link below, feel free to stop in with questions, comments, or just to hang out!
See our getting started guide for information on initial developer setup.
yarn run start-server
The server will automatically rebuild the necessary client JavaScript files as they change. If you make changes to the server files, you'll need to restart the server manually.
The standalone has two development components: a development server that rebuilds and hot-reloads client JavaScript files, and the Electron application itself (that loads and uses these files). Both must be running for things to work correctly.
To run the development server, use:
yarn run dev
To run the app, use:
yarn run app
This setup will automatically rebuild and reload for any client changes you make. If you make changes to
things in the app folder, you'll need to close and restart the app (using the above command) for them to
take effect.
To test the multiplayer aspect of the project, whether that's in the application or in an actual game, you
can start multiple instances of the application with the different sessions by using the SB_SESSION
environment variable. By default, the name of the session is simply session. So if you want to start an
additional instance of the standalone application, you can set the environment variable SB_SESSION to
anything other than the default name in a new console window. Eg., on Windows:
set SB_SESSION=session1
Note that ShieldBattery supports multiple instance of StarCraft running at the same time, so you can even start a game with two different accounts if you need to test something in the game.
In order to actually run the game through the standalone application, you need to ensure that you successfully built the Rust code as explained in the getting started guide.
The ShieldBattery project is broken down into four big pieces, located in these folders:
- app: the standalone application.
- client: all of the client-side code which is used by the standalone application and the website client
- game: Rust code related to the game.
- server: the server-side code including all the HTTP API handlers and WebSocket API handlers.
There are also some other important folders:
- assets: contains source assets for our graphics
- test: contains tests for various things (runnable with
yarn test). Note that the server has its own tests, which are located inside of theserver/testdirectory. - tools: contains third-party tools we use for building and maintaining various parts of the project, such as generating diffs to patch between game versions
MIT