Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cfoust/sour
Sauerbraten for the web in a single Docker image.
https://github.com/cfoust/sour
cube emscripten first-person-shooter game golang metaverse multiplatform multiplayer typescript
Last synced: 2 months ago
JSON representation
Sauerbraten for the web in a single Docker image.
- Host: GitHub
- URL: https://github.com/cfoust/sour
- Owner: cfoust
- License: mit
- Created: 2021-08-14T17:19:29.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-27T22:50:43.000Z (3 months ago)
- Last Synced: 2024-10-28T02:30:17.475Z (3 months ago)
- Topics: cube, emscripten, first-person-shooter, game, golang, metaverse, multiplatform, multiplayer, typescript
- Language: C++
- Homepage: https://sourga.me/
- Size: 412 MB
- Stars: 158
- Watchers: 6
- Forks: 30
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## What is this?
Sour is a multiplatform modernization of Cube 2: Sauerbraten delivered as a single executable (with adjacent assets.) It is a Sauerbraten server that serves a fully-featured web-version of Sauerbraten (with support for mobile devices) in addition to accepting connections from the traditional, desktop version of the game. Sour is the easiest way to play Sauerbraten with your friends.
## Installation
You can download an archive containing the Sour server and all necessary assets from [the releases page](https://github.com/cfoust/sour/releases). For now, only Linux and macOS are supported.
You can also install Sour via `brew`:
```bash
# Install the latest version:
brew install cfoust/taps/sour
# Or a specific one:
brew install cfoust/taps/[email protected]
```
## Running Sour
To run Sour, extract a release archive anywhere you wish, navigate to that directory, and run `./sour`. If you installed Sour with `brew`, just run `sour` in any terminal session.
Running `sour` will start a Sour server accessible to web clients at `http://0.0.0.0:1337` and to desktop clients on port 28785. In other words, you should be able to connect to the Sour server in the Sauerbraten desktop client by running `/connect localhost`.
By serving on `0.0.0.0` by default, the Sour server will be available to other devices on the local network at IP of the device running the Sour server.
## Configuration
Sour is highly configurable. When run without arguments, `sour` defaults to running `sour serve` with the [default Sour configuration](https://github.com/cfoust/sour/blob/main/pkg/config/default.yaml). You change Sour's configuration by providing the path to a configuration file to `sour serve`:
```bash
sour serve config.yaml
```
Sour can be configured using `.yaml` or `.json` files; the structure is the same in both cases.
To print the default configuration to standard output, run `sour config`:
```bash
sour config > config.yaml
```
Sour also supports merging configurations together.
```bash
sour serve config_a.yaml some_path/config_b.json config_c.yaml
```
These configurations are merged from left to right using [CUE](https://cuelang.org/docs/). CUE merges JSON data by overwriting values (if they're scalar, such as strings, booleans, and numbers) or combining values (if they're arrays). In effect, this means that configurations can specify values for only a subset of properties without problems.
## Goals
- **Modernize Sauerbraten.** The gaming landscape has changed. Provide a modern multiplayer experience with matchmaking, private games, rankings, and seamless collaboration on maps. Make as much of this functionality available to the unmodified desktop game as possible.
- **Preserve the experience of playing the original game.** While it is possible that Sour may someday support arbitrary game modes, assets, clients, and server code, the vanilla game experience should still be available.
- **Be the best example of a cross-platform, open-source FPS.** Deployment of Sour on your own infrastructure with whatever configuration you like should be easy. Every aspect of Sour should be configurable.
## Architecture
Here is a high level description of the repository's contents:
- `pkg` and `cmd`: All Go code used in Sour and its services.
- `cmd/sourdump`: A Go program that calculates the minimum list of files necessary for the game to load a given map.
- `cmd/sour`: The Sour game server, which provides a number of services to web clients:
- Gives clients both on the web and desktop client access to game servers managed by Sour.
- `game`: All of the Cube 2 code and Emscripten compilation scripts. Originally this was a fork of [BananaBread](https://github.com/kripken/BananaBread), kripken's original attempt at compiling Sauerbraten for the web. Since then I have upgraded the game to the newest mainline version several times and moved to WebGL2.
- `client`: A React web application that uses the compiled Sauerbraten game found in `game`, pulls assets, and proxies all server communication over a WebSocket.
- `assets`: Scripts for building web-compatible game assets. This is an extremely complicated topic and easily the most difficult aspect of shipping Sauerbraten to the web. Check out this [section's README](services/assets) for more information.
## Contributing
Join us on [Discord](https://discord.gg/WP3EbYym4M) to chat with us and see how you can help out! Check out the [issues tab](https://github.com/cfoust/sour/issues) to get an idea of what needs doing.
## Inspiration
Some years ago I came across [BananaBread](https://github.com/kripken/BananaBread), which was a basic tech demo that used [Emscripten](https://emscripten.org/) to compile Sauerbraten for the web. The project was limited in scope and done at a time when bandwidth was a lot more precious.
## License
Each project that was forked into this repository has its own original license intact, though the glue code and subsequent modifications I have made are licensed according to the MIT license specified in `LICENSE`.