diff --git a/README.md b/README.md new file mode 100644 index 0000000..f6ea074 --- /dev/null +++ b/README.md @@ -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 | \ No newline at end of file