https://github.com/allejo/checkpoint
A BZFlag plug-in to save a player's spawn location when they reach checkpoints
https://github.com/allejo/checkpoint
bzflag bzflag-plugin
Last synced: 3 months ago
JSON representation
A BZFlag plug-in to save a player's spawn location when they reach checkpoints
- Host: GitHub
- URL: https://github.com/allejo/checkpoint
- Owner: allejo
- License: mit
- Created: 2019-11-29T03:49:50.000Z (over 5 years ago)
- Default Branch: release
- Last Pushed: 2020-06-23T04:25:28.000Z (almost 5 years ago)
- Last Synced: 2025-01-15T03:05:24.514Z (5 months ago)
- Topics: bzflag, bzflag-plugin
- Language: C++
- Homepage:
- Size: 24.4 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Checkpoint
[](https://github.com/allejo/Checkpoint/releases/latest)
[](LICENSE.md)
This is a rewrite of the [original Checkpoint](https://forums.bzflag.org/viewtopic.php?f=79&t=16273&p=158192) plug-in that is used on obstacle course like maps to allow players to save their spawn positions.
## Requirements
- C++11
- BZFlag 2.4.20+
This plug-in follows [my standard instructions for compiling plug-ins](https://github.com/allejo/docs.allejo.io/wiki/BZFlag-Plug-in-Distribution).
## Usage
### Loading the plug-in
This plug-in does not take any configuration options at load time.
```
-loadplugin Checkpoint
```
### Custom BZDB Variables
These custom BZDB variables can be configured with `-set` in configuration files and may be changed at any time in-game by using the `/set` command.
```
-set
```
| Name | Type | Default | Description |
| ---- | ---- | ------- | ----------- |
| `_checkPointsLifetime` | int | 5 | Number of minutes a checkpoint record should be saved between rejoins for a player. |
| `_clearCheckPointsOnCap` | bool | false | Whether or not to clear all checkpoints after a flag capture. |
### Custom Slash Commands
| Command | Permission | Description |
| ------- | ---------- | ----------- |
| `/checkpoints ` | spawn | Slash command to interact with saved checkpoints. |
| `/cp ` | spawn | An alias for the `checkpoints` command. |
- `/checkpoints list` - List the 10 most recent checkpoints a player has reached
- `/checkpoints save` - Save the current position the tank is in within a given checkpoint to serve as the exact spawn position for the next spawn
- `/checkpoints swap ` - Change your most recent checkpoint to respawn at a different location; you may only spawn at checkpoints you've reached before
### Custom Map Objects
This plug-in introduces the `CHECKPOINT` map object which supports the traditional `position`, `size`, and `rotation` attributes for rectangular objects and `position`, `height`, and `radius` for cylindrical objects.
```text
checkpoint
name
position 0 0 0
size 5 5 5
rotation 0
team
message
end
```
- `name` - A unique name to reference this zone; this is a required field
- `message` (optional) - A message to send to the players when they have successfully entered the zone and have saved it
- `team` (optional) - This option restricts the checkpoint to only be available to tanks of a certain color. If this option is left out, it'll apply to all teams. Supported values:
- 0 - Rogue Team
- 1 - Red Team
- 2 - Green Team
- 3 - Blue Team
- 4 - Purple Team
- 5 - Rabbit Team
- 6 - Hunter Team
## License
[MIT](LICENSE.md)