Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erb3/sveio
A multiplayer geography game inspired by Posio
https://github.com/erb3/sveio
geography geography-game hacktoberfest posio rust
Last synced: 29 days ago
JSON representation
A multiplayer geography game inspired by Posio
- Host: GitHub
- URL: https://github.com/erb3/sveio
- Owner: Erb3
- License: mit
- Created: 2024-01-15T19:36:14.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-11-01T18:47:04.000Z (about 2 months ago)
- Last Synced: 2024-11-01T19:29:18.687Z (about 2 months ago)
- Topics: geography, geography-game, hacktoberfest, posio, rust
- Language: Rust
- Homepage:
- Size: 516 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Sveio
A geography game inspired by [Posio](https://github.com/abrenaut/posio), written in 🔥🚀Rust.
## Deployment
> [!IMPORTANT]
> Sveio does not impose any rate limit itself.
> You have to do this yourself, with something like nginx.
### Docker
Sveio is available as a docker image. If you use `docker run` you can run the following to start it:
```bash
docker run -d -p 8085:8085 ghcr.io/erb3/sveio:latest
```
Alternatively, you can use the following docker compose:
```yml
services:
sveio:
container_name: sveio
image: ghcr.io/erb3/sveio:latest
ports:
- 8085:8085
restart: unless-stopped
```
## Configuration
| Name | Description | Env | Flag | Default |
| ------------- | ---------------------------------- | --------------------- | ----------------- | ------- |
| Port | The HTTP port to listen to | `SVEIO_PORT` | `-p` | 8085 |
| Logging | Logging level | `SVEIO_LOGGING_LEVEL` | `-l` | info |
| Guess time | Amount of seconds allowed to guess | `SVEIO_GUESS_TIME` | `--guess-time` | 7 |
| Showcase time | Amount of seconds to show markers | `SVEIO_SHOWCASE_TIME` | `--showcase-time` | 3 |
For more information please run `sveio -h`.
## Socket.io
Sveio uses [Socketioxide](https://github.com/Totodore/socketioxide)
Here are some resources to get you started with Socketioxide:
- [I never thought I'd use Socket.Io again](https://www.youtube.com/watch?v=HEhhWL1oUTM) by Dreams of Code
- The examples
## Credits
- [Posio](https://github.com/abrenaut/posio) by [Abrenaut](https://github.com/abrenaut)
- [JSON of cities](https://github.com/abrenaut/posio/blob/master/game/data/cities.json) by [Abrenaut](https://github.com/abrenaut)
- [Leaflet.js](https://leafletjs.com/)
- [Carto maps](https://carto.com/)