{"id":30735725,"url":"https://github.com/jpdillingham/soulseek.net","last_synced_at":"2026-03-14T21:02:11.475Z","repository":{"id":33392120,"uuid":"153015647","full_name":"jpdillingham/Soulseek.NET","owner":"jpdillingham","description":"A .NET Standard client library for the Soulseek network.","archived":false,"fork":false,"pushed_at":"2025-08-02T16:27:58.000Z","size":10831,"stargazers_count":195,"open_issues_count":9,"forks_count":25,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-08-08T08:54:16.681Z","etag":null,"topics":["csharp","dotnet","hacktoberfest","soulseek","soulseek-network"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jpdillingham.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-10-14T20:24:31.000Z","updated_at":"2025-08-06T00:15:24.000Z","dependencies_parsed_at":"2023-11-24T00:25:18.547Z","dependency_job_id":"e9106852-1b4a-4608-ad0d-859ccf153b30","html_url":"https://github.com/jpdillingham/Soulseek.NET","commit_stats":null,"previous_names":[],"tags_count":68,"template":false,"template_full_name":null,"purl":"pkg:github/jpdillingham/Soulseek.NET","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpdillingham%2FSoulseek.NET","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpdillingham%2FSoulseek.NET/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpdillingham%2FSoulseek.NET/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpdillingham%2FSoulseek.NET/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jpdillingham","download_url":"https://codeload.github.com/jpdillingham/Soulseek.NET/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpdillingham%2FSoulseek.NET/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273502368,"owners_count":25117177,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["csharp","dotnet","hacktoberfest","soulseek","soulseek-network"],"created_at":"2025-09-03T20:13:30.025Z","updated_at":"2026-03-14T21:02:11.465Z","avatar_url":"https://github.com/jpdillingham.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Soulseek.NET\n\n[![NuGet version](https://img.shields.io/nuget/v/Soulseek.svg)](https://www.nuget.org/packages/Soulseek/)\n[![Semantic Versioning](https://img.shields.io/badge/semver-2.0.0-3D9FE0.svg)](https://semver.org/)\n[![license](https://img.shields.io/github/license/jpdillingham/Soulseek.NET.svg)](https://github.com/jpdillingham/Soulseek.NET/blob/master/LICENSE)\n\n[![CircleCI](https://circleci.com/gh/jpdillingham/Soulseek.NET/tree/master.svg?style=shield)](https://circleci.com/gh/jpdillingham/Soulseek.NET/tree/master)\n[![codecov](https://codecov.io/gh/jpdillingham/Soulseek.NET/branch/master/graph/badge.svg)](https://codecov.io/gh/jpdillingham/Soulseek.NET)\n[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=jpdillingham_Soulseek.NET\u0026metric=sqale_rating)](https://sonarcloud.io/dashboard?id=jpdillingham_Soulseek.NET)\n[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=jpdillingham_Soulseek.NET\u0026metric=reliability_rating)](https://sonarcloud.io/dashboard?id=jpdillingham_Soulseek.NET)\n[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=jpdillingham_Soulseek.NET\u0026metric=security_rating)](https://sonarcloud.io/dashboard?id=jpdillingham_Soulseek.NET)\n\nA .NET Standard client library for the Soulseek network.\n\n# Quick Start\n\nInstall from [NuGet](https://www.nuget.org/packages/Soulseek/).\n\n## Connect to a Soulseek server\n\n```c#\nvar client = new SoulseekClient(minorVersion: \u003ca unique version for your application\u003e);\nawait client.ConnectAsync(\"Username\", \"Password\");\n```\n\n### About Minor Versions\n\nStarting with version 9, the `minorVersion` constructor is required.  This version identifies your application on the Soulseek network,\nand provides a way for administrators to understand traffic and behavior patterns.  Choose a unique integer to supply.\n\n## Search for something\n\n```c#\nIEnumerable\u003cSearchResponse\u003e responses = await Client.SearchAsync(SearchQuery.FromText(\"some search\"));\n```\n\nNote: `SearchAsync` accepts a `SearchQuery` with the constructor `SearchQuery(string query, IEnumerable\u003cstring\u003e exclusions, int? minimumBitrate, int? minimumFileSize, int? minimumFilesInFolder, bool isVBR, bool isCBR)`, allowing all of the options provided by the official client.\n\n`SearchResponse` has the following shape:\n\n```c#\nint FileCount\nIReadOnlyCollection\u003cFile\u003e Files\nint LockedFileCount\nIReadOnlyCollection\u003cFile\u003e LockedFiles\nint FreeUploadSlots\nlong QueueLength\nint Token\nint UploadSpeed\nstring Username\n```\n\n`File` has a number of properties; you'll need for `Filename` and `Size` for downloading.\n\n## Download a file\n\n```c#\nbyte[] file = await Client.DownloadAsync(username: \"some username\", filename: \"some fully qualified filename\", size: 42);\n```\n\nOR (ideally)\n\n```c#\nvar fs = new FileStream(\"c:\\downloads\\local filename\", FileMode.Create);\nawait Client.DownloadAsync(username: \"some username\", filename: \"some fully qualified filename\", outputStream: fs, size: 42);\n```\n\nNote: Download to a stream where possible to reduce memory overhead.\n\n# Documentation\n\nThe external interface of the library is sparse and well documented; the best resource is the code itself.  Of particular interest:\n\n* [ISoulseekClient](https://github.com/jpdillingham/Soulseek.NET/blob/master/src/ISoulseekClient.cs)\n* [SoulseekClientOptions](https://github.com/jpdillingham/Soulseek.NET/blob/master/src/Options/SoulseekClientOptions.cs)\n* [SearchOptions](https://github.com/jpdillingham/Soulseek.NET/blob/master/src/Options/SearchOptions.cs)\n* [TransferOptions](https://github.com/jpdillingham/Soulseek.NET/blob/master/src/Options/TransferOptions.cs)\n\n## Excluded Search Phrases\n\nStarting around the beginning of 2024, the Soulseek server has begun sending a list of 'excluded search phrases' as a way to restrict content exchanged on the network and appease copyright trolls.\n\nThis list of phrases is delivered in the event `ExcludedSearchPhrassReceived`, and it is my expectation that any outgoing search results _must_ be filtered to exclude files that contain any of the excluded phrases in the path or filename.\n\nI appreciate everyone's cooperation and commitment to ensuring the long term health of the Soulseek network.\n\n# Example Web Application\n\nNote that the example application as been superseded by [slskd](https://github.com/slskd/slskd) and will no longer be maintained.\n\nIncluded is a small [web application](https://github.com/jpdillingham/Soulseek.NET/tree/master/examples/Web) which serves as an example.\n\nIt's important to note that there are currently no controls over uploads; anything you share can be downloaded by any number of people at any given time.  With this in mind, consider sharing a small number of files from the example.\n\nIt's also important to note that some displays in the application poll the daemon for updates; this is inefficient, and you really shouldn't use this application over a mobile data connection.\n\n## Running with Docker\n\nA Docker image containing the application can be pulled from [jpdillingham/slsk-web-example](https://hub.docker.com/r/jpdillingham/slsk-web-example).\n\nA minimal `run` would look like:\n\n```\ndocker run -i \\\n    -p 5000:5000 \\\n    -v \u003cpath/to/downloads\u003e:/var/slsk/download \\\n    -v \u003cpath/to/shared\u003e:/var/slsk/shared \\\n    -e \"SLSK_USERNAME=\u003cyour username\u003e\" \\\n    -e \"SLSK_PASSWORD=\u003cyour password\u003e\" \\\n    jpdillingham/slsk-web-example:latest\n```\n\nThe application will then be accessible on port 5000 (e.g. http://localhost:5000).  With this configuration the application won't be able to accept incoming connections and won't connect to the distributed network.  You may receive limited search results and users won't find your files via search.  Other users may have difficulty browsing your shares.\n\nThe full set of options is as follows:\n\n```\ndocker run -i \\\n    -p 5000:5000 \\\n    -p 50000:50000 \\\n    -v \u003cpath/to/downloads\u003e:/var/slsk/download \\\n    -v \u003cpath/to/shared\u003e:/var/slsk/shared \\\n    -e \"SLSK_USERNAME=\u003cyour username\u003e\" \\\n    -e \"SLSK_PASSWORD=\u003cyour password\u003e\" \\\n    -e \"SLSK_LISTEN_PORT=50000\" \\\n    -e \"SLSK_CONNECT_TIMEOUT=5000\" \\\n    -e \"SLSK_INACTIVITY_TIMEOUT=15000\" \\\n    -e \"SLSK_READ_BUFFER_SIZE=16384\" \\\n    -e \"SLSK_WRITE_BUFFER_SIZE=16384\" \\\n    -e \"SLSK_ENABLE_DNET=true\" \\\n    -e \"SLSK_DNET_CHILD_LIMIT=10\" \\\n    -e \"SLSK_DIAGNOSTIC=Info\" \\\n    -e \"SLSK_SHARED_CACHE_TTL=3600000\" \\\n    -e \"SLSK_ENABLE_SECURITY=true\" \\\n    -e \"SLSK_SECURITY_TOKEN_TTL=604800000\" \\\n    -e \"SLSK_ROOM_MESSAGE_LIMIT=250\" \\\n    -e \"SLSK_BASE_PATH=/\"\n    jpdillingham/slsk-web-example:latest\n```\n\nWith this configuration the application will listen on port 50000 and will connect to the distributed network, allowing up to 10 child connections.  The application shouldn't have any trouble connecting provided you've forwarded port 50000 properly, and will receive and respond to distributed search requests.\n\nIf `SLSK_ENABLE_SECURITY` is `true`, you will be prompted to log in.  Supply the values you specified for the `SLSK_USERNAME` and `SLSK_PASSWORD` fields.  Setting this option to `false` will disable the prompt.\n\nIf you would like to run the application behind a reverse proxy, set `SLSK_BASE_PATH` to your proxied path.\n\nFor convenience, two scripts, `run` and `start`, have been included in `examples/Web/bin` for running the example interactively and as a daemon, respectively.\n\n## Running without Docker\n\nThe example application is split into two projects; a .NET 5.0 WebAPI and a React application bootstrapped with create-react-app.  If you'd like to run these outside of Docker you'll need to start both applications; `dotnet run` for the API and `yarn|npm start` for the React application.  You can connect to http://localhost:3000, or the API serves Swagger UI at http://localhost:5000/swagger.\n\nA build script included in the `bin` directory of the example which will build the React app, copy the static files to the wwwroot directory of the API, build the API, then attempt to build the Docker image.\n\n## See also\n\n### References\n\n* [Nicotine+ (most up to date)](https://github.com/nicotine-plus/nicotine-plus/blob/master/doc/SLSKPROTOCOL.md)\n* [SoulseekProtocol - Museek+](https://www.museek-plus.org/wiki/SoulseekProtocol)\n* [Soulseek Protocol Documentation (mirrored)](https://htmlpreview.github.io/?https://github.com/jpdillingham/Soulseek.NET/blob/master/docs/Soulseek%20Protocol%20Documentation.html)\n\n### Alternative Clients and Libraries\n\nMuch of Soulseek.NET was made possible by the work of others. The following resources were used as a reference:\n\n* [nicotine-plus](https://github.com/Nicotine-Plus/nicotine-plus)\n* [livelook](https://github.com/misterhat/livelook) by @misterhat\n* [museek-plus](https://github.com/eLvErDe/museek-plus) by @eLvErDe\n* [slsk-client](https://github.com/f-hj/slsk-client) by @f-hj.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpdillingham%2Fsoulseek.net","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjpdillingham%2Fsoulseek.net","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpdillingham%2Fsoulseek.net/lists"}