add: readme

This commit is contained in:
camille lechauve 2023-09-02 00:10:57 +02:00
parent 4d70ba6f5c
commit 59b62cd869

28
README.md Normal file
View File

@ -0,0 +1,28 @@
# Disease Addon
a GMOD Addon to add multiple disease
## config
!(example file)["./config.json.example"]
| root |
| -------- |
| diseases: the list of all disease |
| list of diseases |
| -------- |
| name: the name of the disease | What do you want |
| symbtoms_by_stages: a list of list of symbtoms, one list of list by stage |
| contaminations_method: a list of contamination method |
| stages_durations: a list of duration of stage |
| symbtom |
| -------- |
| name: the name of the symbtoms | `vomit`, `cough`, `faintness`, `pimple`, `fatigue`, `death` |
| delay: delay between two symbtoms | number of second |
| level: the level of the symbtoms | number between 0 and 1 |
| contaminations_method |
| name: the name of the method | `food`, `contact`, `injury`, `random` |
| chance: the change to get the disease | number between 0 and 1 |
| stages_durations |
| seconde before disease step up |