torjus/slopvivors
1
0
Fork 0
Code Issues 12 Pull Requests Actions Packages Projects 1 Releases Activity

chore: update README again

Browse Source
This commit is contained in:
Torjus Håkestad
2025-08-21 10:17:55 +02:00
parent 699b758afb
commit f166f138a3
1 changed files with 14 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -4,39 +4,38 @@ Not AI-slop, but just regular slop survivors game.
## Run ## Run
Can be run easily with either docker, or nix.
### Web-version using docker ### Web-version using docker
Run the following command to run a web-server using docker.
In your browser, navigate to http://localhost:8080 to play.
```console ```console
$ docker run --rm -it -p 8080:8080 git.t-juice.club/torjus/slopvivors:latest $ docker run --rm -it -p 8080:8080 git.t-juice.club/torjus/slopvivors:latest
``` ```
### Linux version using nix ### Linux version using nix
Desktop version can be run using nix flake.
```console ```console
$ nix run git+https://git.t-juice.club/torjus/slopvivors#slopvivors $ nix run git+https://git.t-juice.club/torjus/slopvivors#slopvivors
``` ```
## Build
Build using nix:
```console
$ nix build .#\slopvivors
```
## Development ## Development
Use nix to setup development environment. Contains godot and other useful tools. Use nix to setup development environment. Contains godot and other useful tools.
```console ```shell
$ nix develop nix develop
$ godot project.godot godot project.godot
# slop-format runs gdformat on gdscript files, run before commit # slop-format runs gdformat on gdscript files, run before commit
$ slop-format slop-format
...
# slop-push pushes image with latest-tag to git.t-juice.club # slop-push pushes image with latest-tag to git.t-juice.club
$ slop-push slop-push
...
``` ```