Go to file
Sam Therapy 5dbc9eb80c
More code cleanup idk
Signed-off-by: Sam Therapy <sam@samtherapy.net>
2023-10-25 15:55:57 +02:00
.github misc(ci, README): Fix some small problems 2023-10-25 15:55:57 +02:00
src More code cleanup idk 2023-10-25 15:55:57 +02:00
.drone.yml misc(ci, README): Fix some small problems 2023-10-25 15:55:57 +02:00
.editorconfig refactor: Put FFI in its own project 2023-10-25 15:55:52 +02:00
.gitattributes feat: Initial commit 2023-05-13 20:10:14 +02:00
.gitignore feat: Initial commit 2023-05-13 20:10:14 +02:00
GNUmakefile refactor: Put FFI in its own project 2023-10-25 15:55:52 +02:00
LICENSE feat: Initial commit 2023-05-13 20:10:14 +02:00
README.md More code cleanup idk 2023-10-25 15:55:57 +02:00
Xdg.Net.sln refactor: Rewrite everything 2023-10-25 15:55:57 +02:00

README.md

Xdg.Net

Drone build status GitHub Actions Build GitHub Actions CodeQL Nuget

A small (the .dll is only 11 KB), fast and portable (Completely supports .NET Standard 2.0 and even NativeAOT!) .NET implementation of the XDG Base Directory Specification and XDG user directories for Windows, MacOS and Linux/FreeBSD.

Default Locations

If any of the respective XDG environment are specified, the variable will always be returned. Otherwise, the value depends on the operating system.

Inspiration is taken from the Go implementation for Windows and MacOS directories.

Base Directory
Environment Variable Windows macOS Linux/FreeBSD
XDG_DATA_HOME %LOCALAPPDATA% $HOME/Library/Application Support $HOME/.local/share
XDG_CONFIG_HOME %LOCALAPPDATA% $HOME/Library/Application Support $HOME/.config
XDG_STATE_HOME %LOCALAPPDATA% $HOME/Library/Application Support $HOME/.local/state
XDG_BIN_HOME null null $HOME/.local/bin
XDG_DATA_DIRS %APPDATA%:%PROGRAMDATA% /Library/Application Support /usr/local/share:/usr/share
XDG_CONFIG_DIRS %LOCALAPPDATA% $HOME/Library/Preferences:/Library/Application Support:/Library/Preferences /etc/xdg
XDG_CACHE_HOME %LOCALAPPDATA% $HOME/Library/Application Support $HOME/.config
XDG_RUNTIME_HOME %LOCALAPPDATA% $HOME/Library/Application Support /run/user/$UID
User Directory

User directories on Windows use Known Folders.

Environment Variable Windows macOS Linux/FreeBSD
XDG_DESKTOP_DIR Desktop $HOME/Desktop $HOME/Desktop
XDG_DOWNLOAD_DIR null $HOME/Downloads $HOME/Downloads
XDG_DOCUMENTS_DIR My Documents $HOME/Documents $HOME/Documents
XDG_MUSIC_DIR My Music $HOME/Music $HOME/Music
XDG_PICTURES_DIRS My Pictures $HOME/Pictures $HOME/Pictures
XDG_VIDEOS_DIR My Videos $HOME/Movies $HOME/Videos
XDG_TEMPLATES_DIR Templates $HOME/Templates $HOME/Templates
XDG_PUBLICSHARE_DIR %PUBLIC% $HOME/Public $HOME/Public
Extra Directories
Windows macOS Linux/FreeBSD
Home %USERPROFILE% $HOME $HOME

Packaging

Stable releases are available on NuGet, and preview releases are uploaded to both GitHub packages (need GitHub account to download) and Gitea packages (no login required).

dotnet add package Xdg.Directories

Native Library

View the README here

License

MIT