lancommander-ref/LANCommander
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Pat Hartl 2024-08-04 20:05:50 -05:00 • committed by GitHub
parent e3c001a32a
commit bb2617fe95
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -8,13 +8,13 @@
![Discord](https://img.shields.io/discord/1134004697712316506)
[![Support me on Patreon](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3DLANCommander%26type%3Dpatrons&style=flat)](https://patreon.com/LANCommander)
LANCommander is an open-source digital video game distribution system.
LANCommander is an open-source digital game platform.
The main application is self-hostable and is built on the ASP.NET Blazor web application framework. Instead of reinventing the wheel with yet-another-game-launcher, client-functionality has been implemented via a Playnite extension. The database is implemented using SQLite so there is no complex setup required.
The main application is self-hostable and is built on the ASP.NET Blazor web application framework. Your self-hosted platform can be accessed through the offical LANCommander launcher. The database is implemented using SQLite so there is no complex setup required.
The platform is designed to work on local networks and loads no assets from the internet. It was originally developed to help assist a LAN party where the local network is closed and no internet access is permitted.
Builds for Windows and Linux are provided. Some features such as server management may be best experienced on Windows.
Builds for Windows, Linux, and macOS are provided, with varying levels of support/compatibility. **Currently the launcher has only been tested to run on Windows**
## Community
* [Discord](https://discord.gg/vDEEWVt8EM)
@ -65,7 +65,7 @@ If you're not a developer but still want to contribute, writing documentation in
The LANCommander dev team is currently spearheaded by one developer in their free time. Paid donation tiers are available over at the [Patreon](https://patreon.com/LANCommander) page.
## SDK
A separate assembly called `LANCommander.SDK` has been created for use in client applications. The offical Playnite add-on utilizes this assembly to handle the authentication, download, install, and uninstall of entries from a LANCommander server. Here is a quick example of how one can authenticate to a LANCommander server and install a game to `C:\Games`:
A separate assembly called `LANCommander.SDK` has been created for use in client applications. Here is a quick example of how one can authenticate to a LANCommander server and install a game to `C:\Games`:
```csharp
var client = new LANCommander.SDK.Client("http://localhost:1337", "C:\\Games");
@ -89,9 +89,9 @@ LANCommander is far from complete. The basic implementation that exists will all
- Redistributable management and distribution
- IPX Beacon for emulators such as DosBox
- Game media management and automatic lookup (covers, icons, backgrounds)
- Dedicated launcher for easy client setup
The following features are being considered:
- Dedicated launcher for easy client setup
- Peer-to-peer file sharing of game files
- Built-in VPN client/server for remote LAN parties
- Social features including chat, friends list, etc.