Add settings documentation

master
rubenwardy 2016-05-19 22:31:53 +01:00
parent c54d7e2bbc
commit 87b345580a
2 changed files with 60 additions and 1 deletions

View File

@ -7,7 +7,7 @@ ctf.register_on_init(function()
ctf._set("flag.waypoints", true)
ctf._set("flag.protect_distance", 25)
ctf._set("flag.nobuild_radius", 3)
ctf._set("flag.capture_mode", "take")
ctf._set("flag.capture_mode", true)
ctf._set("flag.drop_time", 7*60)
ctf._set("flag.drop_warn_time", 60)
ctf._set("flag.alerts", true)

59
doc_settings.md Normal file
View File

@ -0,0 +1,59 @@
# ctf mod
| 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 |
# 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_mode | true | whether a player needs to return flag to base to capture |
| flag.capture_take | false |
| flag.drop_time | 420 |
| flag.drop_warn_time | 60 |
| flag.nobuild_radius | 3 |
| flag.names | true |
| flag.protect_distance | 25 |
| flag.waypoints | true |
| 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