Dissolve ctf_pvp_engine modpack into other modpacks
This commit is contained in:
rubenwardy
parent
9f05af002e
commit
450027c3b7
78 changed files with 0 additions and 269 deletions
52
docs/doc_data.md
Normal file
52
docs/doc_data.md
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
## Players
|
||||
|
||||
Commonly called tplayer (may be called data or player in old code).
|
||||
Player name is commonly called name (but may be called other things in older code).
|
||||
|
||||
```lua
|
||||
ctf.players = {
|
||||
username = (player_table)
|
||||
}
|
||||
|
||||
(player_table) = {
|
||||
name = "username",
|
||||
team = "teamname",
|
||||
auth = false
|
||||
-- true if the player is a team admin. Team admins can change team settings.
|
||||
-- See ctf.can_mod()
|
||||
-- Note that priv:ctf_admin can also change team settings
|
||||
}
|
||||
```
|
||||
|
||||
## Teams
|
||||
|
||||
Commonly called team.
|
||||
Team name is commonly called tname (but may be called team in old code).
|
||||
|
||||
```lua
|
||||
ctf.teams = {
|
||||
teamname = (team_table)
|
||||
}
|
||||
|
||||
(team_table) = {
|
||||
data = {
|
||||
name = "teamname",
|
||||
color = "teamcolor" -- see ctf_colors
|
||||
},
|
||||
flags = {
|
||||
(flag_table), (flag_table)
|
||||
},
|
||||
players = {
|
||||
username1 = (player_table),
|
||||
username2 = (player_table)
|
||||
},
|
||||
spawn = { x=0, y=0, z=0 }
|
||||
-- fallback team spawn. Read by ctf.get_spawn() and overriding functions
|
||||
-- Don't use directly, instead call ctf.get_spawn("teamname")
|
||||
}
|
||||
|
||||
(flag_table) = {
|
||||
x=0, y=0, z=0,
|
||||
flag_name = "Capital" -- human readable name
|
||||
}
|
||||
```
|
||||
70
docs/doc_project_overview.md
Normal file
70
docs/doc_project_overview.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# Welcome
|
||||
|
||||
The aim of CTF_PvP_Engine is to provide a base to any subgame which uses the
|
||||
concepts of teams. Flags are a plugin mod, so it isn't CTF as such.
|
||||
|
||||
# Modules in CTF_PvP_Engine
|
||||
|
||||
## hudkit
|
||||
|
||||
A support library to make the HUD API nicer.
|
||||
WTFPL.
|
||||
|
||||
## ctf
|
||||
|
||||
Requires hudkit. Support for chatplus.
|
||||
Core framework, players, teams, diplomacy, hud and gui.
|
||||
|
||||
* core - adds saving, loading and settings. All modules depend on this.
|
||||
* teams - add the concepts of teams and players. All modules except core depend on this.
|
||||
* diplomacy - adds inter team states of war, peace and alliances.
|
||||
* gui - adds the team gui on /team. Allows tabs to be registered.
|
||||
* hud - adds the name of the team in the TR of the screen, and sets the color
|
||||
|
||||
## ctf_chat
|
||||
|
||||
Requires ctf. Support for chatplus.
|
||||
Chat commands and chat channels.
|
||||
|
||||
## ctf_colors
|
||||
|
||||
Requires ctf. Support for 3d_armor.
|
||||
Adds player colors.
|
||||
|
||||
* gui - settings form
|
||||
* hud - team name color, player skin color, nametag color
|
||||
* init - table of colors
|
||||
|
||||
## ctf_flag
|
||||
|
||||
Requires ctf and ctf_colors. Support for chatplus.
|
||||
Adds flags and flag taking.
|
||||
|
||||
* api - flag callbacks, flag management (adding, capturing, updating), flag checking (asserts)
|
||||
* flag_func - functions for flag node definitions.
|
||||
* flags - flag node definitions.
|
||||
* gui - flag naming GUI, flag teleport GUI.
|
||||
* hud - waypoints, alerts ("Punch the enemy flag!" etc in top right)
|
||||
* init - get nearest flag, overrides ctf.get_spawn(), minimum build range, pick up sound, flag capture timeout.
|
||||
|
||||
## ctf_protect
|
||||
|
||||
Adds node ownership / protection to teams.
|
||||
Requires ctf_flag.
|
||||
|
||||
# Past/Other Mods
|
||||
|
||||
Please look
|
||||
|
||||
## ctf_turret
|
||||
|
||||
Adds auto-firing turrets that fire on enemies.
|
||||
See git history.
|
||||
|
||||
## Capture the flag
|
||||
|
||||
more mods available in [capture the flag](http://github.com/rubenwardy/capturetheflag/).
|
||||
|
||||
* ctf_match - adds the concept of winning, match build time,
|
||||
and reseting the map / setting up a new game.
|
||||
Requires ctf_flag
|
||||
60
docs/doc_settings.md
Normal file
60
docs/doc_settings.md
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
# ctf
|
||||
|
||||
| name | default value | description |
|
||||
| -------------------------- | ------------- | ---------------------------------------------------------------- |
|
||||
| allocate_mode | 0 | 0=off, 1=firstnonfullteam, 2=RandomOfSmallestTwo, 3=SmallestTeam |
|
||||
| autoalloc_on_joinplayer | true | Trigger auto alloc on join player |
|
||||
| default_diplo_state | "war" | "war", "alliance" or "peace" |
|
||||
| diplomacy | true | Is diplomacy enabled |
|
||||
| friendly_fire | true | True if players can't hit other players on their team |
|
||||
| maximum_in_team | -1 | Player cap |
|
||||
| players_can_change_team | true | |
|
||||
| hud | true | Enable HUD |
|
||||
| gui | true | Enable GUI |
|
||||
| gui.team | true | Whether to show team gui (/team) |
|
||||
| gui.team.initial | "news" | Initial tab |
|
||||
| gui.tab.diplo | true | Show diplo tab |
|
||||
| gui.tab.news | true | Show news tab |
|
||||
| gui.tab.settings | true | Show settings tab |
|
||||
| spawn_offset | {x=0, y=0, z=0} | Offset of static spawn-point from team-base |
|
||||
|
||||
# ctf_chat
|
||||
|
||||
| name | default value | description |
|
||||
| -------------------------- | ------------- | ---------------------------------------------------------------- |
|
||||
| chat.default | "global" | "global" or "team" |
|
||||
| chat.global_channel | true | |
|
||||
| chat.team_channel | true | |
|
||||
|
||||
# ctf_colors
|
||||
|
||||
| name | default value | description |
|
||||
| -------------------------- | ------------- | ---------------------------------------------------------------- |
|
||||
| colors.nametag | true | Whether to colour the name tagColour nametag |
|
||||
| colors.nametag.tcolor | false | Base nametag colour on team colour |
|
||||
| colors.skins | false | Team skins are coloured |
|
||||
|
||||
# ctf_flag
|
||||
|
||||
| name | default value | description |
|
||||
| -------------------------- | ------------- | ---------------------------------------------------------------- |
|
||||
| flag.alerts | true | Prompts like "X has captured your flag" |
|
||||
| flag.alerts.neutral_alert | true | Show prompt in neutral state, ie: "attack and defend!" |
|
||||
| flag.allow_multiple | true | Teams can have multiple flags |
|
||||
| flag.capture_take | false | Whether a player needs to return flag to base to capture |
|
||||
| flag.drop_time | 420 | Time in seconds before a player drops the flag they're holding |
|
||||
| flag.drop_warn_time | 60 | Warning time before drop |
|
||||
| flag.nobuild_radius | 3 | Area around flag where you can't build |
|
||||
| flag.names | true | Enable naming flags |
|
||||
| flag.protect_distance | 25 | Area protection distance |
|
||||
| flag.waypoints | true | Enable waypoints to flags |
|
||||
| flag.crafting | false | Enable the crafting of flags |
|
||||
| gui.tab.flags | true | Show flags tab |
|
||||
| gui.team.teleport_to_flag | true | Enable teleport to flag button in flags tab |
|
||||
| gui.team.teleport_to_spawn | false | Enable teleport to spawn button in flags tab |
|
||||
|
||||
# ctf_protect
|
||||
|
||||
| name | default value | description |
|
||||
| -------------------------- | ------------- | ---------------------------------------------------------------- |
|
||||
| node_ownership | true | Whether node protection per team is enabled |
|
||||
Loading…
Add table
Add a link
Reference in a new issue