Client Settings

Upon the first run the program creates a file called settings.json. Since then as long as the file exists and is of correct format it is used as a source of settings. (The program won't tell you the settings are corrupt, he will go back to the default values but trust me, there will be cues.)

The settings are stored in JSON format and contain many important values. Bellow is a complete list and explanation of every accepted setting. Nevertheless we recommend not to alter the settings unless you are sure what you are doing. (For example you have been directed here from the Advanced Setup section)

Attributes

Attribute	Meaning
COLLECTION_FILE_PATH	points to the collection.json file which contains the Standard Collection.
EASTER_COLLECTION_FILE_PATH
SONG_DATA_FILE_PATH	points to the folder where the song HTML files are stored.
EGG_DATA_FILE_PATH
RESOURCE_FILE_PATH	points to the resources folder.
CSS_RESOURCES_FILE_PATH	points to the css folder.
TEMPLATE_RESOURCES_FILE_PATH	points to the templates folder.
DATA_ZIP_FILE_PATH	points to the data.zip file which is used for both saving and loading data.
EDIT_LOG_FILE_PATH	points to the last_modified_by.txt file that keeps track of when changes to the collection have been made. Useless when working locally.
AUTO_LOAD_DATA	whether the client should try to load data from the server on start.
REMOTE_SAVE_LOAD_ENABLED	whether to save and load data remotely to the server. Do not enable if you do not remember setting up any server.
TEMP_FILE_PATH	points to the folder for temporary session files.
ASSETS_RESOURCES_FILE_PATH	points to the folder with asset resources.
OUTPUT_FILE_PATH	points to the location where exported files will be stored.
DATA_FILE_PATH	points to the data folder where the entire songbook is stored.
TEMP_TIMESTAMP_FILE_PATH	points to the session_timestamp.txt file.
REMOTE_DATA_ZIP_FILE_DOWNLOAD_URL	address of the server API endpoint for download.
REMOTE_DATA_ZIP_FILE_UPLOAD_URL	address of the server API endpoint for upload.
REMOTE_DATA_FILE_HASH_URL	address of the server API endpoint for remote data checksum.
REMOTE_DATA_FILE_LAST_EDITED_URL	address of the server API endpoint for remote data last modification data.
DEFAULT_READ_TOKEN	default token for server authentification. Never use for token with writing permissions!
AUTH_FILE_PATH	points to the .auth file with authentification tokens.
LOG_FILE_PATH	points to the log.txt file.
AUTH_TYPE	"TOKEN" and "PHRASE" are two accepted values.
LOG_ENABLED	whether to log what happens on the inside.
SCRIPTS_FILE_PATH	points to the scripts folder.
BIND_SONG_TITLES	whether to update the title of the HTML file and the title stored in the database when the other changes. true or false.
plugins	plugin settings.

---