✨ feat(config): provide a new config option `animation` (#424)

websurfx/config.lua

@@ -1,18 +1,18 @@
 -- ### General ###
 logging = true -- an option to enable or disable logs.
-debug = false  -- an option to enable or disable debug mode.
-threads = 10   -- the amount of threads that the app will use to run (the value should be greater than 0).
+debug = false -- an option to enable or disable debug mode.
+threads = 10 -- the amount of threads that the app will use to run (the value should be greater than 0).
 
 -- ### Server ###
-port = "8080"            -- port on which server should be launched
+port = "8080" -- port on which server should be launched
 binding_ip = "127.0.0.1" --ip address on the which server should be launched.
-production_use = false   -- whether to use production mode or not (in other words this option should be used if it is to be used to host it on the server to provide a service to a large number of users (more than one))
+production_use = false -- whether to use production mode or not (in other words this option should be used if it is to be used to host it on the server to provide a service to a large number of users (more than one))
 -- if production_use is set to true
 -- There will be a random delay before sending the request to the search engines, this is to prevent DDoSing the upstream search engines from a large number of simultaneous requests.
-request_timeout = 30      -- timeout for the search requests sent to the upstream search engines to be fetched (value in seconds).
+request_timeout = 30 -- timeout for the search requests sent to the upstream search engines to be fetched (value in seconds).
 rate_limiter = {
-    number_of_requests = 20, -- The number of request that are allowed within a provided time limit.
-    time_limit = 3,       -- The time limit in which the quantity of requests that should be accepted.
+	number_of_requests = 20, -- The number of request that are allowed within a provided time limit.
+	time_limit = 3, -- The time limit in which the quantity of requests that should be accepted.
 }
 
 -- ### Search ###
@@ -43,15 +43,24 @@ safe_search = 2
 -- tomorrow-night
 -- }}
 colorscheme = "catppuccin-mocha" -- the colorscheme name which should be used for the website theme
-theme = "simple"                 -- the theme name which should be used for the website
+-- The different themes provided are:
+-- {{
+-- simple
+-- }}
+theme = "simple" -- the theme name which should be used for the website
+-- The different animations provided are:
+-- {{
+-- simple-frost
+-- }}
+animation = "simple-frosted-glow" -- the animation name which should be used with the theme or `nil` if you don't want any animations.
 
 -- ### Caching ###
 redis_url = "redis://127.0.0.1:8082" -- redis connection url address on which the client should connect on.
-cache_expiry_time = 600              -- This option takes the expiry time of the search results (value in seconds and the value should be greater than or equal to 60 seconds).
+cache_expiry_time = 600 -- This option takes the expiry time of the search results (value in seconds and the value should be greater than or equal to 60 seconds).
 -- ### Search Engines ###
 upstream_search_engines = {
-    DuckDuckGo = true,
-    Searx = false,
-    Brave = false,
-    Startpage = false,
+	DuckDuckGo = true,
+	Searx = false,
+	Brave = false,
+	Startpage = false,
 } -- select the upstream search engines from which the results should be fetched.