Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexpineda/titan-reactor
An OpenBW 2.5D map and replay viewer.
https://github.com/alexpineda/titan-reactor
broodwar react scr starcraft threejs webgl
Last synced: 3 months ago
JSON representation
An OpenBW 2.5D map and replay viewer.
- Host: GitHub
- URL: https://github.com/alexpineda/titan-reactor
- Owner: alexpineda
- Created: 2020-06-21T12:11:18.000Z (over 4 years ago)
- Default Branch: dev
- Last Pushed: 2024-01-19T23:36:32.000Z (about 1 year ago)
- Last Synced: 2024-10-12T22:27:41.816Z (4 months ago)
- Topics: broodwar, react, scr, starcraft, threejs, webgl
- Language: TypeScript
- Homepage:
- Size: 116 MB
- Stars: 42
- Watchers: 6
- Forks: 4
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Titan Reactor
An OpenBW 2.5D map and replay viewer.
Written in TypeScript with Three.JS.
Visit www.blacksheepwall.tv for more
### About
This is Titan Reactor the WebGL renderer + plugin system. It consists of three primary parts in order to function:
- Titan Reactor - main app that loads replays & maps and creates sessions for viewing. Can be served statically.
- Cascbridge - an asset server that reads from your Starcraft install and serves it to Titan Reactor locally
- UI Runtime - the part of the application the runs in the iframe for UI plugins. Can be served statically.
- Plugins - the plugins that can be served statically.### Requirements
- A purchased copy of Starcraft Remastered.
### Developing Plugins
- See the [CREATING_PLUGINS](https://github.com/imbateam-gg/titan-reactor/blob/dev/docs/CREATING_PLUGINS.md) document.
### Development Installation / Quick Start
Using node 18+, yarn 1.x
Clone this repo. The development branch is `dev` and `main` is used for releases.
In this repo:
`git lfs install`
`git lfs fetch`
`yarn install`
Now we want to run Titan Reactor, the ui runtime, the plugins, and cascbridge:
In your terminal run `yarn web` , in another terminal run `yarn runtime`, in the [plugins repo](https://github.com/alexpineda/titan-reactor-official-plugins) `npm run serve` and run [cascbridge](https://github.com/alexpineda/cascbridge).
The OpenBW wasm files are included (via git lfs). If you wish to build them yourself [visit the openbw fork repository](https://github.com/imbateam-gg/openbw).
[Code Architecture WIKI](https://github.com/imbateam-gg/titan-reactor/wiki/Code-Architecture)
### Legal
The documentation and functionality provided by Titan Reactor may only be utilized with assets provided by ownership of Starcraft. Starcraft® - Copyright © 1998 Blizzard Entertainment, Inc. All rights reserved. Starcraft and Blizzard Entertainment are trademarks or registered trademarks of Blizzard Entertainment, Inc. in the U.S. and/or other countries. Titan Reactor and any of its maintainers are in no way associated with or endorsed by Blizzard Entertainment®