[{"data":1,"prerenderedAt":555},["ShallowReactive",2],{"navigation":3,"/getting-started/installation":67,"/getting-started/installation-surround":550},[4,18,33,48,63],{"title":5,"path":6,"stem":7,"children":8,"icon":17},"Getting Started","/getting-started","1.getting-started/1.index",[9,12],{"title":10,"path":6,"stem":7,"icon":11},"Introduction","i-lucide-rocket",{"title":13,"path":14,"stem":15,"icon":16},"Installation","/getting-started/installation","1.getting-started/2.installation","i-lucide-download",false,{"title":19,"path":20,"stem":21,"children":22,"page":17},"Configuration","/configuration","2.configuration",[23,28],{"title":24,"path":25,"stem":26,"icon":27},"Autostart","/configuration/autostart","2.configuration/1.autostart","i-lucide-power",{"title":29,"path":30,"stem":31,"icon":32},"Keybindings","/configuration/keybindings","2.configuration/2.keybindings","i-lucide-keyboard",{"title":34,"path":35,"stem":36,"children":37,"page":17},"Customization","/customization","3.customization",[38,43],{"title":39,"path":40,"stem":41,"icon":42},"Theming","/customization/theming","3.customization/1.theming","i-lucide-palette",{"title":44,"path":45,"stem":46,"icon":47},"Bar Layout","/customization/bar-layout","3.customization/2.bar-layout","i-lucide-layout",{"title":49,"path":50,"stem":51,"children":52,"page":17},"Community","/community","4.community",[53,58],{"title":54,"path":55,"stem":56,"icon":57},"Contributing","/community/contributing","4.community/1.contributing","i-lucide-heart-handshake",{"title":59,"path":60,"stem":61,"icon":62},"Credits","/community/credits","4.community/2.credits","i-lucide-award",{"title":64,"path":65,"stem":66},"Disclaimer","/disclaimer","disclaimer",{"id":68,"title":13,"body":69,"description":543,"extension":544,"links":545,"meta":546,"navigation":547,"path":14,"seo":548,"stem":15,"__hash__":549},"docs/1.getting-started/2.installation.md",{"type":70,"value":71,"toc":536},"minimark",[72,76,81,84,117,120,124,127,374,376,380,383,474,476,480,483,516,518,522,525,532],[73,74,75],"p",{},"Choose between an automated script or a manual deployment sequence from source code.",[77,78,80],"h2",{"id":79},"quick-install-arch","Quick Install (Arch)",[73,82,83],{},"For a rapid deployment on Arch Linux distributions, you can stream the setup script directly:",[85,86,91],"pre",{"className":87,"code":88,"language":89,"meta":90,"style":90},"language-bash shiki shiki-themes catppuccin-mocha","curl -fsSL https://raw.githubusercontent.com/caffyne-org/caffyne-shell/main/install.sh | bash\n","bash","",[92,93,94],"code",{"__ignoreMap":90},[95,96,99,103,107,110,114],"span",{"class":97,"line":98},"line",1,[95,100,102],{"class":101},"sO0CG","curl",[95,104,106],{"class":105},"sX9bP"," -fsSL",[95,108,109],{"class":105}," https://raw.githubusercontent.com/caffyne-org/caffyne-shell/main/install.sh",[95,111,113],{"class":112},"sMC71"," |",[95,115,116],{"class":101}," bash\n",[118,119],"hr",{},[77,121,123],{"id":122},"manual-installation","Manual Installation",[73,125,126],{},"Follow these steps to set up the environment manually on your system.",[128,129,131,136,139,237,255,259,262,290,294,297,338,342,345],"steps",{"level":130},"3",[132,133,135],"h3",{"id":134},"install-system-dependencies","Install System Dependencies",[73,137,138],{},"Ensure the following packages are compiled and accessible within your distribution path:",[140,141,142,166,183,197,211],"ul",{},[143,144,145,149,150,153,154,153,157,153,160,153,163],"li",{},[146,147,148],"strong",{},"Core Core Libraries:"," ",[92,151,152],{},"gtk3",", ",[92,155,156],{},"awww",[92,158,159],{},"matugen",[92,161,162],{},"cairo",[92,164,165],{},"libgirepository",[143,167,168,149,171,153,174,153,177,153,180],{},[146,169,170],{},"Introspection Runtimes:",[92,172,173],{},"gobject-introspection",[92,175,176],{},"gobject-introspection-runtime",[92,178,179],{},"gtk-layer-shell",[92,181,182],{},"libdbusmenu-gtk3",[143,184,185,149,188,153,191,153,194],{},[146,186,187],{},"Desktop & Playback Services:",[92,189,190],{},"cinnamon-desktop",[92,192,193],{},"playerctl",[92,195,196],{},"fabric-cli",[143,198,199,149,202,153,205,153,208],{},[146,200,201],{},"Python Ecosystem:",[92,203,204],{},"python",[92,206,207],{},"python-pip",[92,209,210],{},"python-venv",[143,212,213,149,216,153,219,153,222,153,225,153,228,153,231,153,234],{},[146,214,215],{},"Hardware Integration Protocols:",[92,217,218],{},"gnome-bluetooth-3.0",[92,220,221],{},"bluez",[92,223,224],{},"bluetoothctl",[92,226,227],{},"brightnessctl",[92,229,230],{},"wf-recorder",[92,232,233],{},"networkmanager",[92,235,236],{},"upower",[238,239,240],"note",{},[73,241,242,245,246,248,249],{},[146,243,244],{},"Non-Arch"," Linux users may need to compile ",[92,247,196],{}," manually. Find the repository here: ",[250,251,252],"a",{"href":252,"rel":253},"https://github.com/Fabric-Development/fabric-cli",[254],"nofollow",[132,256,258],{"id":257},"clone-the-repository","Clone the Repository",[73,260,261],{},"Clone the project structure explicitly into your configuration path:",[85,263,265],{"className":87,"code":264,"language":89,"meta":90,"style":90},"git clone https://github.com/caffyne-org/caffyne-shell.git ~/.config/caffyne-shell\ncd ~/.config/caffyne-shell\n",[92,266,267,281],{"__ignoreMap":90},[95,268,269,272,275,278],{"class":97,"line":98},[95,270,271],{"class":101},"git",[95,273,274],{"class":105}," clone",[95,276,277],{"class":105}," https://github.com/caffyne-org/caffyne-shell.git",[95,279,280],{"class":105}," ~/.config/caffyne-shell\n",[95,282,284,288],{"class":97,"line":283},2,[95,285,287],{"class":286},"sDSzL","cd",[95,289,280],{"class":105},[132,291,293],{"id":292},"create-virtual-environment","Create Virtual Environment",[73,295,296],{},"Isolate your workspace dependencies by instantiating a python virtual environment:",[85,298,300],{"className":87,"code":299,"language":89,"meta":90,"style":90},"python -m venv venv\nsource venv/bin/activate\npip install -r requirements.txt\n",[92,301,302,315,323],{"__ignoreMap":90},[95,303,304,306,309,312],{"class":97,"line":98},[95,305,204],{"class":101},[95,307,308],{"class":105}," -m",[95,310,311],{"class":105}," venv",[95,313,314],{"class":105}," venv\n",[95,316,317,320],{"class":97,"line":283},[95,318,319],{"class":286},"source",[95,321,322],{"class":105}," venv/bin/activate\n",[95,324,326,329,332,335],{"class":97,"line":325},3,[95,327,328],{"class":101},"pip",[95,330,331],{"class":105}," install",[95,333,334],{"class":105}," -r",[95,336,337],{"class":105}," requirements.txt\n",[132,339,341],{"id":340},"compile-cgtk-libraries","Compile C/GTK Libraries",[73,343,344],{},"Compile the performance-critical submodules included inside the shell snippets path:",[85,346,348],{"className":87,"code":347,"language":89,"meta":90,"style":90},"cd ~/.config/caffyne-shell/snippets/blur/lib\nmake\ncd ~/.config/caffyne-shell/snippets/hacktk/lib\nmake\n",[92,349,350,357,362,369],{"__ignoreMap":90},[95,351,352,354],{"class":97,"line":98},[95,353,287],{"class":286},[95,355,356],{"class":105}," ~/.config/caffyne-shell/snippets/blur/lib\n",[95,358,359],{"class":97,"line":283},[95,360,361],{"class":101},"make\n",[95,363,364,366],{"class":97,"line":325},[95,365,287],{"class":286},[95,367,368],{"class":105}," ~/.config/caffyne-shell/snippets/hacktk/lib\n",[95,370,372],{"class":97,"line":371},4,[95,373,361],{"class":101},[118,375],{},[77,377,379],{"id":378},"matugen-integration","Matugen Integration",[73,381,382],{},"Follow these steps to install the Caffyne template and hook it into your Matugen configuration tree.",[128,384,385,389,392,408,412,419,459,463,466],{"level":130},[132,386,388],{"id":387},"create-template-directories","Create Template Directories",[73,390,391],{},"First, ensure that Matugen's local configuration and template paths exist in your home directory:",[85,393,395],{"className":87,"code":394,"language":89,"meta":90,"style":90},"mkdir -p ~/.config/matugen\n",[92,396,397],{"__ignoreMap":90},[95,398,399,402,405],{"class":97,"line":98},[95,400,401],{"class":101},"mkdir",[95,403,404],{"class":105}," -p",[95,406,407],{"class":105}," ~/.config/matugen\n",[132,409,411],{"id":410},"update-matugen-configuration","Update Matugen Configuration",[73,413,414,415,418],{},"Open your Matugen configuration file located at ",[92,416,417],{},"~/.config/matugen/config.toml"," and append the template mapping block.",[85,420,424],{"className":421,"code":422,"language":423,"meta":90,"style":90},"language-toml shiki shiki-themes catppuccin-mocha","[config] # Include this if it's not already in your file\n\n# caffyne shell Color Generation\n[templates.caffyne]\ninput_path = '~/.config/caffyne-shell/matugen/caffyne-shell-colors.css'\noutput_path = '~/.config/caffyne-shell/style/colors.css'\n","toml",[92,425,426,431,437,442,447,453],{"__ignoreMap":90},[95,427,428],{"class":97,"line":98},[95,429,430],{},"[config] # Include this if it's not already in your file\n",[95,432,433],{"class":97,"line":283},[95,434,436],{"emptyLinePlaceholder":435},true,"\n",[95,438,439],{"class":97,"line":325},[95,440,441],{},"# caffyne shell Color Generation\n",[95,443,444],{"class":97,"line":371},[95,445,446],{},"[templates.caffyne]\n",[95,448,450],{"class":97,"line":449},5,[95,451,452],{},"input_path = '~/.config/caffyne-shell/matugen/caffyne-shell-colors.css'\n",[95,454,456],{"class":97,"line":455},6,[95,457,458],{},"output_path = '~/.config/caffyne-shell/style/colors.css'\n",[132,460,462],{"id":461},"trigger-color-generation","Trigger Color Generation",[73,464,465],{},"Run Matugen as you normally do to change your wallpaper or colors. Matugen will now automatically parse the template and compile your new active colors directly into:",[85,467,472],{"className":468,"code":470,"language":471,"meta":90},[469],"language-text","~/.config/caffyne-shell/style/colors.css\n","text",[92,473,470],{"__ignoreMap":90},[118,475],{},[77,477,479],{"id":478},"executing-shell","Executing shell",[73,481,482],{},"You can initialize the runtime thread either via the provided helper engine script or raw execution commands:",[484,485,486,496],"code-group",{},[85,487,490],{"className":87,"code":488,"filename":489,"language":89,"meta":90,"style":90},"./start.sh\n","Helper Script",[92,491,492],{"__ignoreMap":90},[95,493,494],{"class":97,"line":98},[95,495,488],{"class":101},[85,497,500],{"className":87,"code":498,"filename":499,"language":89,"meta":90,"style":90},"source venv/bin/activate\npython3 main.py\n","Manual Execution",[92,501,502,508],{"__ignoreMap":90},[95,503,504,506],{"class":97,"line":98},[95,505,319],{"class":286},[95,507,322],{"class":105},[95,509,510,513],{"class":97,"line":283},[95,511,512],{"class":101},"python3",[95,514,515],{"class":105}," main.py\n",[118,517],{},[77,519,521],{"id":520},"python-dependencies-reference","Python Dependencies Reference",[73,523,524],{},"Here is the exact dependency locked tree manifest for the runtime environment:",[85,526,530],{"className":527,"code":528,"filename":529,"language":471,"meta":90},[469],"cffi==2.0.0\nclick==8.4.1\nfabric @ git+https://github.com/Fabric-Development/fabric.git@23cab85fc61f1cdbb5f60db0027dc57026ba05b7\nloguru==0.7.3\npam==0.2.0\npillow==12.2.0\npsutil==7.2.2\npycairo==1.29.0\npycparser==3.0\nPyGObject==3.50.0\npython-pam==2.0.2\nRapidFuzz==3.14.5\nsetproctitle==1.3.7\nsix==1.17.0\nthefuzz==0.22.1\n","requirements.txt",[92,531,528],{"__ignoreMap":90},[533,534,535],"style",{},"html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html pre.shiki code .sO0CG, html code.shiki .sO0CG{--shiki-default:#89B4FA;--shiki-default-font-style:italic}html pre.shiki code .sX9bP, html code.shiki .sX9bP{--shiki-default:#A6E3A1}html pre.shiki code .sMC71, html code.shiki .sMC71{--shiki-default:#94E2D5}html pre.shiki code .sDSzL, html code.shiki .sDSzL{--shiki-default:#F38BA8;--shiki-default-font-style:italic}",{"title":90,"searchDepth":98,"depth":283,"links":537},[538,539,540,541,542],{"id":79,"depth":283,"text":80},{"id":122,"depth":283,"text":123},{"id":378,"depth":283,"text":379},{"id":478,"depth":283,"text":479},{"id":520,"depth":283,"text":521},"Get caffyne shell up and running on your system.","md",null,{},{"icon":16},{"title":13,"description":543},"252_gTsyIRkbsLx802PtFKZm9p5P3uQiCDNPwbSCQc4",[551,553],{"title":10,"path":6,"stem":7,"description":552,"icon":11,"children":-1},"Welcome to caffyne shell, a modern, highly customisable desktop built for Wayland.",{"title":24,"path":25,"stem":26,"description":554,"icon":27,"children":-1},"Learn how to configure caffyne shell to hook into your compositor session.",1780946377786]