mirror of
https://github.com/CHOMPStation2/CHOMPStation2.git
synced 2025-12-09 07:57:00 +00:00
54 lines
3.4 KiB
Plaintext
54 lines
3.4 KiB
Plaintext
#### Asset settings ####
|
|
## Asset Transport
|
|
## The normal way of getting assets to clients is to use the internal byond system. This can be slow and delay the opening of interface windows. It also doesn't allow the internal IE windows byond uses to cache anything.
|
|
## You can instead have the server save them to a website via a folder within the game server that the web server can read. This could be a simple webserver or something backed by a CDN.
|
|
## Valid values: simple, webroot. Simple is the default.
|
|
#ASSET_TRANSPORT webroot
|
|
|
|
|
|
### Simple asset transport configurable values.
|
|
|
|
## Uncomment this to have the server passively send all browser assets to each client in the background. (instead of waiting for them to be needed)
|
|
## This should be uncommented in production and commented in development
|
|
#ASSET_SIMPLE_PRELOAD
|
|
|
|
|
|
### Webroot asset transport configurable values.
|
|
|
|
## Local folder to save assets to.
|
|
## Assets will be saved in the format of asset.MD5HASH.EXT or in namespaces/hash/ as ASSET_FILE_NAME or asset.MD5HASH.EXT
|
|
#ASSET_CDN_WEBROOT data/asset-store/
|
|
|
|
## URL the folder from above can be accessed from.
|
|
## for best results the webserver powering this should return a long cache validity time, as all assets sent via this transport use hash based urls
|
|
## Encryption (https) is supported here, but linux clients will have issues if you require higher then tls 1.0. Windows clients down to windows 7 can handle tls 1.2 no issue.
|
|
## if you want to test this locally, you simpily run the `localhost-asset-webroot-server.py` python3 script to host assets stored in `data/asset-store/` via http://localhost:58715/
|
|
#ASSET_CDN_URL http://localhost:58715/
|
|
|
|
## Assets can opt-in to caching their results into `cache/`.
|
|
## The cache is assumed to be cleared by TGS recompiling, which deletes `cache/`.
|
|
## This should be disabled on development,
|
|
## but enabled on production (the default).
|
|
#CACHE_ASSETS
|
|
|
|
## Enables 'smart' asset caching, for assets that support it.
|
|
## This is a type of asset cache that automatically invalidates itself based on inputs to the asset generation.
|
|
## It lowers the generation cost and is safe to enable on development and production.
|
|
## This cache is only cleared by the game or manually, but it shouldn't affect the results.
|
|
## This setting is independent of `CACHE_ASSETS`, they do not affect each other whatsoever.
|
|
SMART_CACHE_ASSETS
|
|
|
|
## If this is uncommented, we will save all associated spritesheet PNGs and CSS files to a folder in the round-specific logs folder.
|
|
## Useful for developers to debug potential spritesheet issues to determine where the issue is cropping up (either in DM-side sprite generation or in the TGUI-side display of said spritesheet).
|
|
## Will only seek to waste disk space if ran on production.
|
|
#SAVE_SPRITESHEETS
|
|
|
|
# If configured, this allows server operators to define the persistent origin used for clientside
|
|
# storage. This must host the same file as available in tgui/public/iframe.html. This is also hosted
|
|
# on the GitHub Pages site for the /tg/station repository, so does not need to be configured.
|
|
# If multiple servers use the same domain name, clientside features such as message saving
|
|
# and chat tabs will be persistent across both.
|
|
# If this setting is not configured, but the webroot CDN is, that will be used instead of GitHub Pages.
|
|
# If this setting is mpty, and the webroot CDN is disabled, byondstorage will be used.
|
|
# STORAGE_CDN_IFRAME https://vorestation.github.io/byond-client-storage/iframe.html
|