https://github.com/mt-ctf/capturetheflag

Capture the Flag game using the Minetest Voxel Engine
https://github.com/mt-ctf/capturetheflag

capturetheflag ctf game minetest minetest-ctf minetest-game pvp

Last synced: 7 days ago
JSON representation

Capture the Flag game using the Minetest Voxel Engine

• Host: GitHub
• URL: https://github.com/mt-ctf/capturetheflag
• Owner: MT-CTF
• Created: 2015-07-16T17:28:00.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-09-24T23:18:59.000Z (9 days ago)
• Last Synced: 2024-09-26T08:42:29.346Z (7 days ago)
• Topics: capturetheflag, ctf, game, minetest, minetest-ctf, minetest-game, pvp
• Language: Lua
• Homepage: https://ctf.rubenwardy.com
• Size: 13.1 MB
• Stars: 81
• Watchers: 18
• Forks: 89
• Open Issues: 101
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Capture The Flag

[![ContentDB](https://content.minetest.net/packages/rubenwardy/capturetheflag/shields/downloads/)](https://content.minetest.net/packages/rubenwardy/capturetheflag/)  [![Build status](https://github.com/MT-CTF/capturetheflag/workflows/build/badge.svg)](https://github.com/MT-CTF/capturetheflag/actions)

## Installation

### Git

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)

### ContentDB

Simply download the game with the ingame content browser.

Note that this version may be slightly behind the git version, but it will be a little more stable.

## Recommended Setup

* Hosting your server using the `dummy` backend.

### For public servers:

* Storing rankings using the `redis` backend, all steps are required:

  * Install redis, luarocks, and luaredis (Ubuntu)

    * `sudo apt install luarocks redis`

    * `sudo luarocks install luaredis`

  * Add `ctf_rankings` to your `secure.trusted_mods`

	* Make sure you don't add any malicious mods to your server. **It is possible they can breach the sandbox through `ctf_rankings` when it is a trusted mod**

  * Run something like this when starting your server: `(cd minetest/worlds/yourworld && redis-server) | `

    * If you run your Minetest server using a system service it is recommended to run redis-server on a seperate service, with the Minetest service depending upon it

## Starting a game (GUI instructions)

* Create a new `singlenode` world

* Turn on `Enable Damage` and `Host Server`, turn off `Creative Mode`, *memorize* your port

* Click `Host Game`, a round should automatically start as soon as you join in

* Players on your LAN can join using your local IP and the port you *memorize*d

## Development

* ### [WIP CTF API DOCS](docs/ctf-api.md)

* 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

  * https://marketplace.visualstudio.com/items?itemName=GreenXenith.minetest-tools

## License

Created by [rubenwardy](https://rubenwardy.com/).

Developed by [LandarVargan](https://github.com/LoneWolfHT).

Previous Developers: [savilli](https://github.com/savilli).

Check out [mods/](mods/) to see all the installed mods and their respective licenses.

Licenses where not specified:\

Code: [GNU LGPLv2.1+](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html)\

Media: [CC BY-SA 3.0 Unported](https://creativecommons.org/licenses/by-sa/3.0/)

### Textures

* [Header](menu/header.png): [CC BY 3.0 Unported](https://creativecommons.org/licenses/by/3.0/) by [SuddenSFD](https://github.com/SuddenSFD)

* [Background Image](menu/background.png): [CC BY-SA 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/) (where applicable) by [GreenBlob](https://github.com/a-blob) (Uses [Minetest Game](https://github.com/minetest/minetest_game) textures, the majority of which are licensed [CC BY-SA 3.0 Unported](https://creativecommons.org/licenses/by-sa/3.0/)). The player skins used are licensed under [CC BY-SA 3.0 Unported](https://creativecommons.org/licenses/by-sa/3.0/)

* [Icon](menu/icon.png): [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/) by [SuddenSFD](https://github.com/SuddenSFD)