Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Alienmario authored Nov 28, 2023
1 parent a38ed3e commit dc10bcc
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,27 @@

Provides fastdownload support for srcds without the need for webhosting. By default, it will automatically change the value of `sv_downloadurl` and serve files that are either in the downloadables stringtable or the mapcycle.

By default, if `System2` extension is installed, this will also automatically compress missing .bz2 archives to speed up the downloads further.
If `sv_downloadurl_bz2folder` is not empty, such folder will be added as a search path for bz2 files, as well as used by the compressor.
Otherwise, the compressed files are placed in same folder as the source file.
- For usage on a local server, you should be all set.
- For usage on a live server, edit sv_downloadurl_hostname to match your server ip or hostname.

> While there are some ways to automatically recognize the host, none of them prove to be as reliable as setting it manually.
#
### Good to know
Files are preprocessed (added to whitelist and compressed) on every mapchange. If you don't change downloads at runtime, you can save some time by setting `sv_downloadurl_autoreload` to 0.

Files inside the custom folder are fully supported.

Configuration file is automatically created at cfg\sourcemod\plugin.simple-fastdownload.cfg.

Configuration file is automatically created at cfg\sourcemod\plugin.simple-fastdownload-redux.cfg.
#
### Compressor
By default, if `System2` extension is installed, this will also automatically compress missing .bz2 archives to speed up the downloads further.
If `sv_downloadurl_bz2folder` is not empty, such folder will be added as a search path for bz2 files, as well as used by the compressor.
Otherwise, the compressed files are placed in same folder as the source file.
#
### Dependencies
* [Conplex & Webcon](https://forums.alliedmods.net/showthread.php?t=270962)
* [(Optional) System2](https://forums.alliedmods.net/showthread.php?t=146019)

#
### ConVars
ConVar | Default Value | Description
------ | ------- | ---------
Expand Down

0 comments on commit dc10bcc

Please sign in to comment.