1 files changed, 84 insertions, 0 deletions
diff --git a/example/example.sb b/example/example.sb
new file mode 100644
index 0000000..476be3b
--- /dev/null
+++ b/example/example.sb
@@ -0,0 +1,84 @@
+# NOTES
+# 1) if any path does not start with / or ~/ , the path is calulated
+#    acording to the game profile location
+# 2) if an option is specified in the soibox config
+#    its ignored from game profiles unless specified
+# 3) soibox config is located at ~/.config/soibox/soibox.conf, this applies
+#    to all games, game profiles are specific to each game
+
+# use mangohud for perfomance overlay in games.
+# mangohud : on
+
+# 4 options 0,1,2,3. 1 outputs just progress bars and banners, 3 being the most verbose
+# loglevel : 1
+
+# this can either be gzip(gz) or plain text
+# banner : path/to/banner.gz
+
+# to use feral's gamemode
+# gamemode : on
+
+# to use the SteamOS session compositing window manager
+# might cause problems if you have a nvidia gpu
+# gamescope : on
+
+# sandbox games with firejail (recommended)
+# the value can be either on or name of one of the premade firejail profile
+# shipped by your GNU/Linux distribution or it can be path to one
+# firejail : on
+
+# use bind to interface to block wan activity
+# not needed when using firejail
+# bind_interface : on
+
+# if your game needs wine to run you can use this option
+# it's value can either be system which will use your distribution's wine
+# or github_username/wine, in this case soibox will fetch the latest version of
+# of wine from the specified user's fork of of github
+# eg: to use GloriousEggroll's wine you can put "GloriousEggroll/proton-ge-custom"
+# wine : system
+
+# if you dont want the latest version of wine pulled from github
+# you can specify the version here
+# eg
+# wine     : GloriousEggroll/proton-ge-custom
+# wine_tag : GE-Proton7-49
+
+# path to wine prefix
+# wine_prefix : path/to/wine/prefix
+
+# note: this does not ignore game profile if specified in the soibox config
+# but appends game profile version to the config
+# WINEDLLOVERRIDES
+# winedll_ovrids : mshtml=d
+
+# if your game needs directx to vulkan translation you can use this option
+# it's value can be github_username/dxvk, soibox will fetch the latest version of
+# of dxvk from the specified user's fork of of github
+# eg
+# dxvk : doitsujin/dxvk
+
+# if you dont want the latest version of dxvk pulled from github
+# you can specify the version here
+# eg
+# dxvk_tag : v2.1
+
+# if your game needs directx12 to vulkan translation you can use this option
+# it's value can be github_username/vkd3d, soibox will fetch the latest version of
+# of vkd3d from the specified user's fork of of github
+# eg
+# vkd3d : HansKristian-Work/vkd3d-proton
+
+# if you dont want the latest version of vkd3d pulled from github
+# you can specify the version here
+# eg
+# vkd3d_tag : v2.8
+
+# groot can either be a directory or tar or dwarfs archive
+# groot : path/to/game/files
+
+# this path is always relative to groot
+# executable : game.exe
+
+# dont bug user about outdated wine,dxvk,vkd3d
+# offline_mode : on