52 lines
2.1 KiB
Markdown
52 lines
2.1 KiB
Markdown
# Capture The Flag
|
|
|
|
[](https://content.minetest.net/packages/rubenwardy/capturetheflag/) [](https://github.com/MT-CTF/capturetheflag/actions)
|
|
|
|
|
|
## Installation
|
|
|
|
Capture the flag uses several submodules. Make sure to grab them all by cloning like this:
|
|
|
|
```sh
|
|
git clone --recursive https://github.com/MT-CTF/capturetheflag.git
|
|
```
|
|
(Using ssh to clone is recommended for developers/contributors)
|
|
|
|
## Development
|
|
|
|
* If you use Visual Studio Code we recommend these extensions:
|
|
* https://marketplace.visualstudio.com/items?itemName=sumneko.lua
|
|
* https://marketplace.visualstudio.com/items?itemName=dwenegar.vscode-luacheck
|
|
|
|
## System Requirements
|
|
|
|
### Recommended
|
|
|
|
* Hosting your server using the `dummy` backend.
|
|
|
|
* Storing rankings using the `redis` backend:
|
|
* Ubuntu:
|
|
* `sudo apt install luarocks redis`
|
|
* `sudo luarocks install luaredis`
|
|
* Add `ctf_rankings` to your secure.trusted_mods. MIGHT BE POSSIBLE FOR OTHER MODS TO BREACH SECURITY. MAKE SURE YOU ADD NO MALICIOUS MODS TO YOUR CTF SERVER
|
|
* Run something like this when starting your server (With parentheses): (cd minetest/worlds/yourworld && redis-server) | <command to launch your minetest server>
|
|
* If you run your Minetest server using a system service it is recommended to run redis-server in it's own service, with the Minetest one depending upon it
|
|
|
|
## License
|
|
|
|
Created by [rubenwardy](https://rubenwardy.com/).
|
|
Developed by [LandarVargan](https://github.com/LoneWolfHT) and [savilli](https://github.com/savilli).
|
|
|
|
Licenses where not specified:
|
|
Code: LGPLv2.1+
|
|
Textures: CC-BY-SA 3.0
|
|
|
|
### Textures
|
|
|
|
* [Header](menu/header.png): CC BY-SA 4.0 by xenonca
|
|
* [Background Image](menu/background.png): CC0 (where applicable) by Apelta (Uses [Minetest Game](https://github.com/minetest/minetest_game) textures, the majority of which are licensed CC-BY-SA 3.0). The player skin used is licensed CC-BY-SA 3.0
|
|
|
|
### Mods
|
|
|
|
Check out [mods/](mods/) to see all the installed mods and their respective licenses.
|