Reorganized documents.

This commit is contained in:
Richard Helgeby
2013-01-12 06:45:10 +01:00
parent 5c980b5edc
commit b07dcb0452
7 changed files with 24 additions and 2451 deletions

View File

@ -0,0 +1,261 @@
===============================================================================
Zombie:Reloaded Beta 2
Patch Changelog
===============================================================================
For detailed info about changes in configuration files, see diff-files in the
"changes" directory. They describe added and removed lines for each patch
released. If the file is empty there are no config changes in that patch.
2009.12.11 - r545
-------------------
* Initial beta 2 release. See zr_3.0-b2_release_notes.txt.
2009.12.17 - r555
-------------------
* Fixed too short translation buffer on yes/no phrases.
* Fixed warning about invalid class attribute.
2009.12.23 - r557
-------------------
* Added russian translation by exvel.
2009.12.25 - r565
-------------------
* Fixed incorrect link in docs.
* Removed redundant check for class menu command.
* Fixed suicide intercept message not displayed in chat. Text from chat will
still appear in console if written from console.
* Added source code for current snapshot in release package.
2010.01.07 - r580
-------------------
* Added zrdocs/changes.diff in patches that will describe changes in text files
since the main release, in unified diff format. Use a editor that support
diff coloring for easier reading.
* Fixed players not extinguished properly when in water.
* Fixed invalid default values in some has_napalm class attributes.
* Fixed the display bug in ZTele showing 0/X uses instead of 1/X.
* Changed to error types to be fatal and stop plugin to prevent further errors
(fixes rare invalid handle error in weapon module).
* Fixed weapon not rendering correctly in rare cases.
* Added a cvar to allow zombies to pick up weapons at the end of the round.
2010.01.25 - r584
-------------------
* Simplified english and norwegian zmarket menu phrases.
* Fixed account module giving money to zombies hurting themself with
self-inflicted damage
* Fixed zr_damage_suicide_human not working when enabled.
* Switched the plugin to use SDK Hooks extension instead of ZR Tools (r584 and
newer). Run this on SourceMod 1.3 or newer.
2010.02.14 - r595
-------------------
* Added patch changelog.
* Fixed unlimited ammo exploit in ZMarket menu.
* Fixed admin classes not restored from cookies.
* Fixed a bug in client listing menus when selecting a client that left the
game caused errors.
* Fixed the default sky on the first map not reverting properly if
zr_veffects_sky was enabled in zombiereloaded.cfg.
* Fixed players not extinguished when in water.
* Stopped the "Zombies can't use weapons" message when using autobuy outside of
a buyzone.
* Fixed problems that came up if a client was infected through admin after the
round started, but before the freezetime expired.
* Fixed a bug where zr_suicide_cmds was being ignored and only the default
value was being used.
2010.02.23 - r598
-------------------
* Fixed cookies being reset on some occasions and admin-dependant classes are
restored properly as well.
2010.04.05 - r607
-------------------
* Separated patch difflog (changes.diff) into separate file for each patch
released.
* Added scream and moan commands for zombies, with spam protection.
* Added missing note about no_fall_damage class attribute in docs.
* Fixed class attributes applied too early (moved to spawn post event). This
fixes issues with FOV and bots.
* Fixed saved classes not validated by team id when restoring from cookies.
2010.06.03 - r611
-------------------
* Added cvar to enable suicide intercept before the first zombie.
* Added cvar for minimum dx level on overlays.
* Fixed classes not always restored from cookies.
2010.06.03 - r613
-------------------
* Fixed signatures and round end defines that were updated in CS:S OB.
2010.07.25 - r633
-------------------
* Added support for different speed methods, defaulted to prop offset method.
See the manual for more information about the class speed attribute.
Important: Class speeds and spawn protection speed must be updated! Use this
conversion formula:
prop speed offset = ((lmv speed / 300) * 250) - 250
If you don't want to update speed values right now, use
"zr_classes_speed_method lmv" in zombiereloaded.cfg for backwards
compatibility.
* Added 'explode' suicide command from OB update to intercept list (bug 190).
* Removed unnecessary antistick commands for model hull width, all models have
the same hull width.
* Removed hint sound on hp display and spawn protection timer. Credits goes to
to Tauphi.
* Fixed an error that happened when buying ammo and not having a weapon in
prim/sec slot.
* Fixed class menus being disabled and not checking if the player have access
to private classes.
* Fixed client not connected error in class module.
* Updated compiler. ZR now requires SourceMod 1.3 or newer.
2010.08.28 - r643
-------------------
* Fixed function signatures that were changed after a CS update. Credit goes to
psychonic.
* Fixed class speed multiplier not properly applied with prop speed method (bug
199).
* Fixed invalid handle error in ZMarket module (bug 152).
* Fixed a rare case where removing weapons didn't work.
* Possibly fixed invalid handle error with WeaponsEntityToDisplay (bug 163).
* Lowered sv_maxspeed to work around a acceleration issue with spectators.
* Added validation error messages for individual attributes when loading
classes. Easier than reading bits from a number.
* Improved confusing description of the NVGs class attribute.
2010.10.15 - r644
-------------------
* Changed default speed method to LMV because prop speed offsets are broken at
the moment. This will introduce some side effects again; jump and fall speed
is affected. Weapon recoil is also affected, but it's not confirmed that it
has negative impact on bullets or aiming itself.
Note: Those who already changed speed method back to LMV don't need this
patch.
2010.11.14 - r647
-------------------
* Added external plugin API for ZR with basic infection and respawn tools. The
following natives and forwards are now available:
ZR_IsClientZombie
ZR_IsClientHuman
ZR_InfectClient
ZR_HumanClient
ZR_OnClientInfect
ZR_OnClientInfected
ZR_OnClientHuman
ZR_OnClientHumanPost
ZR_RespawnClient
ZR_OnClientRespawn
ZR_OnClientRespawned
ZR_SetKilledByWorld
ZR_GetKilledByWorld
See addons/sourcemod/scripting/include/zr in the package for details.
Also see addons/sourcemod/scripting/testsuite/zr for API usage examples.
2010.11.17 - r648
-------------------
* Fixed players not respawning as zombies when they are supposed to.
2011.06.17 - r651, r653
-------------------------
* Added improved random number generator from SMLIB.
* Fixed dead players being able to get weapons through ZMarket.
* Fixed consecutive mother zombie infection prevention not always working.
2011.06.23 - r657
-----------------
* Added spanish translation by Franc1sco.
2011.08.05 - r666
-----------------
* Increased class limit to 64 classes.
* Fixed the ragdoll module unintentionally removing other valid entities if a
ragdoll was attempted to be removed after the round restarted.
* Fixed format settings in spanish translation spamming logs.
* Fixed index out of bounds error when class limit is reached.
* Fixed double inclusion of jump boost module preventing code from compiling on
newer compilers.
2011.10.30 - r669
-----------------
* Fixed internal player spawn post event fired too early (causing invisible
models).
* Possibly fixed invalid entity error (bug 195).
2011.12.08 - r671
-----------------
* Updated gamedata file. Thanks to pillepallus.
2011.12.26 - r673
-----------------
* Added infection countdown. Backported from zr-dev:52955b169945 (655).
2011.12.27 - r675
-----------------
* Added cvar for disabling team balancing on round end (for use with custom
team balancer): zr_roundend_balance_teams. Disabling this will cause players
to remain on their current team when a new round starts. If zombies win,
everyone will remain on the terrorists team.
* Fixed invalid handle error after a map change.
* Fixed language code typo in translations.
* Infection countdown is no longer displayed if the infection delay is just one
second.
2012.06.10 - r689
-----------------
* Fixed ragdoll removal not being entirely disabled.
* Fixed disabled classes still being validated.
* Fixed memory leak in infection countdown feature.
* Updated to use new natives in cstrike extension instead of SDK calls (fixing ZR not finding some signatures in some cases). Requires SourceMod 1.4.0 or newer.
* Changed ZMarket to auto-buy weapons once settings are loaded (if auto-buy is enabled).
2012.07.03 - r692
-----------------
* Replaced RemoveEdict with kill entity input command. This might fix some rare crashes.
* Updated gamedata file. Thanks to psychonic and TnTSCS.
2012.07.04 - r693
-----------------
* Fixed incorrect offsets in gamedata file.

View File

@ -0,0 +1,105 @@
===============================================================================
Zombie:Reloaded Release Notes
Targets plugin version 3.0.0 Beta 2, 2009.12.11
Written by Richard Helgeby
Last modified: 2009.12.11
===============================================================================
Release Notes For Changes In Beta 2
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Almost all known issues is now fixed. Beta 2 is a result of six months of work
on our spare time, which is pretty good in our opinion. There's a few new
features and some changes. These are the major news (also see changelog below):
* Support for group authentication on admin commands, models and classes.
See Admin Authentication (3.24) in the user manual for usage information.
* Class selections and other settings can be saved in cookies (stored in a
database or a file on the server).
* Class editor for volumetric features. Modify class attributes on players in a
certain area. This could be extra jump boost in some places, or lower knock
back in tubes and vents. Note that this feature is still a work in progress.
Documentation for this one isn't written yet. This syntax should help:
zr_vol_add <x1> <y1> <z1> <x2> <y2> <z2> classedit <class attribute>=<value>
This will make players run fast in a certain area (replace coordinates):
zr_vol_add -492 -522 497 511 534 681 classedit speed=500
* Changed model list to Valve's key/values format (same as classes use). Now
it's possible to separate models into different groups and teams.
* There's a compatibility fix in classes for servers with plugins that change
models. "model_path" in a class can be set to "no_change" so model can be
changed by another plugin than Zombie:Reloaded.
* The user manual is converted to a nice looking HTML manual with links for
quick navigation. Don't forget to have a look at it, at least if you have
problems.
Troubleshooting section is updated with explanation of all error messages
and some info about common problems. Otherwise look at the configuration
section on how to configure every feature.
Richard Helgeby &
Greyscale
Changelog
-----------
Added a cvar to either reset the burn time when naded, or to use the original burn-time. (r408)
Added norwegian translations. (r413)
Added cvars for disallowing class selection, per team. (r421)
Added cvar to redisplay class selection menu every spawn. (r424)
Added feature for allowing instant class change on humans after spawning, with a time limit. (r424)
Added feature for using group based authentication on admin commands in Zombie:Reloaded, using SourceMod groups. (425)
Added support for group authentication on classes (makes VIP and donator classes possible). (r427)
Added feature for saving class selections in cookies. (r432)
Added zr_version command for dumping version info. Useful when reporting problems. (r442)
Added support for Grenade Pack plugin (by Greyscale). (r447)
Added class editor volumetric feature that can modify certain class attributes on players in a volume. (r469)
Added HTML version of the user manual. (r486)
Added more random model selection presets for classes: public, admins, hidden and mother zombies. (r506)
Added cvar for displaying class menu on first spawn. (r518)
Changed lightstyle cvar default to be disabled. (r414)
Changed classes to support not changing player model (for compatibility with other plugins). (r431)
Changed maximum class limit to 48 classes. (r478)
Changed class dumping commands to admin commands. (r479)
Changed sky and sun cvars default to be disabled (to mach default lightstyle setting). (r483)
Changed default setting to allow humans to use teleport after mother zombie spawn. (r486)
Changed admin teleport command to also log target names. (r493)
Changed map config files to be loaded at correct time. (r500)
Changed model config to key/value format and improved model module features. (r506)
Fixed translation buffers too short for languages that use unicode characters. (r409)
Fixed some potential problems in ZMarket handling NVGs. (r410)
Fixed some menus not properly translating into the client's language. (r411)
Fixed translation issues in class menus (r412).
Fixed ZMarket auto-rebuy possibly being stuck on if market was disabled. Now auto-disables if market is disabled. (r416)
Fixed missing quote in english translation file. (r421)
Fixed default class assignment assigning classes players doesn't have access to. (r433)
Fixed teleport not resetting velocity. (r434)
Fixed no fall damage class attribute not working on human classes. (r435)
Fixed weapon type restriction menu not translating the first time. (r443)
Fixed ZMarket weapon type selection menu title not translated.
Fixed too short title string buffer in ZMarket loadout, ZTele force, ZSpawn force and hit group menus. (r443)
Fixed "empty" phrase not translated. (r443)
Fixed on/off translation string space too short in hit group menu. (r443)
Fixed not all grenades being removed when infected. (r458)
Fixed players ignited twice on some anticamp volumes. (r561)
Fixed health regeneration timer not stopping if a player were kicked or timed out. (r469)
Fixed existing volumes not removed after a map change. (r469)
Fixed server console not having full access to admin commands. (r488)
Fixed memory leak in ZMarket. (r489)
Fixed memory leak in model list parser. (r492)
Fixed timer handle error on map end. (r500)
Fixed ambience sound still playing when disabled. (r520)
Fixed health regeneration timer handle error. (r527)
Fixed zr_class_set_multiplier not aborting when there's a invalid attribute name specified. (r529)
Fixed broken FOV. (r542)

View File

@ -0,0 +1,238 @@
===============================================================================
Zombie:Reloaded Release Notes
Targets plugin version 3.0.0 Beta 1, 2009.07.25
Written by Richard Helgeby
Last modified: 2009.12.11
===============================================================================
Release Notes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This is a major release and it do break compatibility with older configuration!
Clean install of configuration files and reconfiguring is recommended.
A lot of work is put into this plugin. The entire plugin is completely recoded
with lots of improvements and fixes.
Our code base have expanded at least five times compared to version 2.5.1
(source have reached 30 000 lines total). Of course, made with optimizing in
mind. This is, as far as we know, the biggest SourceMod plugin ever made!
We also hope Zombie:Reloaded will be a good learning resource for new or
existing coders to find out how certain things are done. The code is well
structured and documented with comments explaining almost what every line do.
In addition we try to make this a quality release with a well tested release
and a full user manual. Read the user manual for details on how to use or
configure individual features. Better quality and less time spent on support
gives more time for us to do more.
UPDATE: See "zr_3.0-b2_release_notes.txt" for changes in Beta 2.
Richard Helgeby &
Greyscale
OVERVIEW OF MAJOR CHANGES
---------------------------
* New configuration style. Configuration files and CVARs are also validated so
errors and invalid values are caught early.
* Expanded class system with support for human classes and additional
attributes like setting transparency on player classes, effects or other
special behaviour.
* New weapon configurations that support knock back multipliers per weapon and
custom weapon groups for easy restriction.
* Market feature for pre configuring or buying equimpents and weapons from the
oposite team, also outside the buy zone if allowed in configuration.
* Improved knock back with support for scaling based on different modules. Now
it's possible to fully customize knock back behaviour.
* Volumetric features. Define areas in maps and do certain stuff to players in
those areas based on a selection of features like the anti-camp.
* Improved teleport settings. Delays and limits separated per team.
* Admin menu. Configure certain settings in-game, do generic commands like
infect, spawn and teleport.
* Cookies. This plugin is using the cookie system of SourceMod so player
preferences can be saved until next time they connect.
* New logging system that is fully customizable. Makes it possible to decide
what stuff to be logged by setting generic logging flags and applying module
filters.
CONFIGURATION CHANGES
-----------------------
Configuration settings are validated when the plugin starts. The plugin will
stop, use defaults or disable features if there are invalid values. Also a
warning is logged in the SourceMod error logs.
The validation prevents unexpected or invalid behaviour in the plugin. Dealing
with errors or warnings in error logs helps a lot troubleshooting eventual
issues in the plugin caused by incorrect configurations.
It's also possible to specify the path of configuration files. This can be used
in combination with map configs, so it's possible to have different
configuration sets per map.
Support for post map configs is made. These are configs executed after the
plugin and its features are loaded. Some settings can only be changed or
overridden after loading. Those commands must be placed in post map configs.
IMPROVED CLASS SYSTEM
-----------------------
There's a lot of new features in the class system. The major change is that
it's made for multiple teams (humans and zombies). Now human classes can be
made. It has support for extended team filtering where admin-only and mother
zombie classes can be made.
In addition any attribute on one or more classes can be modified in-game, which
expands the possibilities in combination with map configs. This makes it easier
to improve the map balance by adjusting attributes like health, knock back and
running speed.
One of the new features is transparency on players. There are also immunity
modes (but it's currently a incomplete feature) that could implement slow
infection that requires zombies to stab multiple times with its knife before
the humans get infected, or stab them to death (turning into a zombie).
IMPROVED WEAPON SYSTEM
------------------------
The new weapon system lets makes it possible to do more than just restricting
weapons. Now it's possible to set knock back multipliers per weapon.
Hit groups can also be configured with knock back multipliers, or disable
damage on certain hit groups completely.
There's also a new market feature which is a custom buy menu with all available
weapons, including from the oposite team. It's also possible to buy weapons
outside the buy zone if the server admins enable that setting.
Weapon selections can be pre configured and even saved using cookies so they
can be quickly bought on next spawn or on next connect to the server.
CUSTOMIZING KNOCK BACK
------------------------
The knock back is based on three factors that are multiplied into the effective
knock back:
- Class knock back. This is the main value.
- Weapon knock back. Set knock back scale values per weapon.
- Hit group knock back. Customize or completely disable knock back scale
per hit group.
With these factors it's possible to fully customize knock back.
VOLUMETRIC FEATURES
---------------------
(Currently in development)
This is a brand new useful feature where custom defined areas in maps can do
certain stuff on players. These are the available features:
- Anti-camp: Slay or warn players that stay too long in a certain area.
Useful in unfair camping places, or to avoid glitches in maps.
- Modify class attributes.
- Restrict weapons. Takes away ammo, and gives back when leaving area.
- Modify ammo modes.
- Modify knock back set on players or knock back in hit groups.
- Teleporter.
Features that modify settings will be reverted when players leave volumes.
Example of usage is to only allow pistols in tubes, use the anti-camp to hurt
humans camping in a certain unfair place, or fine tune knock back for a area in
the map.
TELEPORTER
------------
The teleporter is improved with more settings like these:
- Deciding when players can teleport per team, before or after mother
zombie.
- Setting teleport delays per team.
- Limiting number of teleports per team.
- Abuse protection: Automatically aborting a teleport in progress if the
player moves a certain distance (configurable).
ADMIN MENU
------------
A menu for admins with basic commands to configure certain settings in-game
or do generic commands. That is:
- Infecting players.
- Spawning players.
- Modifying weapon restrictions.
- Modifying class data.
- Configuring log messages.
LOGGING SYSTEM
----------------
The logging system is based on logging flags and filtering that gives full
control of what log types and events to be logged.
There are a few generic log events and settings, like these:
- Core events: Executing config files, error messages, etc.
- Game events: Admin commands, suicide prevention, anticamp kills, etc.
- Player commands: Commands executed by non-admins: zspawn, teleport, class
change, etc.
- Debug messages, if any. Usually only developers use this one.
- Debug messages with more detail. It may cause spam, but this can be
avoided in combination with module filtering.
- Ignoring log events caused by server commands (console), like from map
configs.
- Logging to admin chat: A copy of the message is also logged to admins.
In addition a module filter can be enabled. Only log messages from modules
listed in the filter is logged, other are ignored. Except fatal errors, those
are logged anyways.
The logging system is made this way so server admins can monitor activity in
Zombie:Reloaded whithout reading spammed log messages.