https://github.com/swimos/ripple
Simple shared surface streaming application
https://github.com/swimos/ripple
actor-model distributed-computing distributed-systems game game-development low-latency massively-multiplayer mmo open-source opensource real-time realtime stateful stream-processing streaming
Last synced: 7 months ago
JSON representation
Simple shared surface streaming application
- Host: GitHub
- URL: https://github.com/swimos/ripple
- Owner: swimos
- License: apache-2.0
- Created: 2019-02-19T13:19:06.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-31T19:54:52.000Z (almost 2 years ago)
- Last Synced: 2025-03-23T12:32:48.121Z (7 months ago)
- Topics: actor-model, distributed-computing, distributed-systems, game, game-development, low-latency, massively-multiplayer, mmo, open-source, opensource, real-time, realtime, stateful, stream-processing, streaming
- Language: TypeScript
- Homepage: http://ripple.swim.ai
- Size: 147 KB
- Stars: 20
- Watchers: 6
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ripple
See [Ripple in action](https://ripple.swim.inc).
## Prerequisites
* [Install JDK 11+](https://www.oracle.com/technetwork/java/javase/downloads/index.html).
* Ensure that your `JAVA_HOME` environment variable is pointed to your Java installation location.
* Ensure that your `PATH` includes `$JAVA_HOME`.
* [Install Node.js](https://nodejs.org/en/).
* Confirm that [npm](https://www.npmjs.com/get-npm) was installed during the Node.js installation.
## Run
### Windows
Install the [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
Execute the command `.\run.sh` from a console pointed to the application's home directory. This will start a Swim server, seeded with the application's logic, on port 9001.
```console
user@machine:~$ ./run.sh
```
### \*nix
Execute the command `./run.sh` from a console pointed to the application's home directory. This will start a Swim server, seeded with the application's logic, on port 9001.
```console
user@machine:~$ ./run.sh
```
## View the UI
Open the following URL on your browser: http://localhost:9001.