Skip to content

Commit

Permalink
update readme and remove outdated tests
Browse files Browse the repository at this point in the history
  • Loading branch information
Bauumm committed Oct 24, 2024
1 parent 390c638 commit 1f32159
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 120 deletions.
15 changes: 2 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,11 @@ Apart from the pure lua dependencies that are present in the repository, the gam
These dependencies may have dependencies of their own.

## Building
There is a `CMakeLists.txt` for installing most of the dependencies and building the c code for the video export. It requires the following dependencies to work:
There is a `CMakeLists.txt` for building the c code for the video export. It requires the following dependencies to work:
- cmake
- make
- gcc
- git
- libsodium
- pkg config
- lua 5.1
- ffmpeg

On debian-based distributions they can be installed with this command:
Expand All @@ -33,9 +30,7 @@ apt install \
make \
g++ \
git \
libsodium-dev \
pkg-config \
liblua5.1-dev \
libavformat-dev \
libavcodec-dev \
libswresample-dev \
Expand All @@ -46,7 +41,7 @@ apt install \

On arch based distributions they can be installed with this line:
```
pacman -S cmake make gcc git libsodium pkgconf lua51 ffmpeg
pacman -S cmake make gcc libsodium pkgconf ffmpeg
```
Then you can proceed with building
```
Expand All @@ -57,16 +52,10 @@ make install
```
The last command will put the libraries inside the repository folder where the game will find them (it will not attempt to put files in standard system directories).

Instead of `cmake ..` you may also run `cmake -DVIDEO_EXPORT=0 ..` to skip building the video encoder.

## Server
If you want to run a server with the web api you also need to install other dependencies.
To install openssl headers on a debian-based distribution execute: `apt install libssl-dev`.
On an arch based distribution you can use `pacman -S openssl`.
Then install the lua modules using luarocks: `luarocks --lua-version 5.1 install luasec`

To run the web api server with tls you need to set the environment variables `TLS_KEY` and `TLS_CERT` to point to their respective .pem files.

## Tests
Run tests with `luajit test/main.lua` in the source directory.
Generate coverage statistics with `luajit test/main.lua --coverage`
32 changes: 0 additions & 32 deletions test/main.lua

This file was deleted.

75 changes: 0 additions & 75 deletions test/replay.lua

This file was deleted.

0 comments on commit 1f32159

Please sign in to comment.