lanpartytools
/
LANCommander
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 17 Activity

Update README.md

dhcp-server
Pat Hartl 2023-08-02 23:49:20 -05:00 committed by GitHub
parent 4abef5c61f
commit 97ccfd420e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
README.md
View File

@ -8,64 +8,9 @@ The platform is designed to work on local networks and loads no assets from the
Currently only Windows is supported. This may change in the future and a Docker container may be made available for the main web application. Currently only Windows is supported. This may change in the future and a Docker container may be made available for the main web application.
> Note from the author: I started working on this project years ago because I was fed up with playing IT support while at a LAN party. There's nothing more frustrating than having a group of people together and dealing with issues such as "it says my CD key is invalid" or "server connection blocked: invalid version". Think of LANCommander as DIY Steam. ## Community
* [Discord](https://discord.gg/vDEEWVt8EM)
## Adding Games * [Wiki](https://lancommander.app/index.php/Main_Page)
After initial setup, go to the "Games" page and click "Add Game". Details provided in this form will be used as metadata for Playnite. Note: games will only show up in Playnite when an archive is available to download.
## Looking Up Metadata
When adding or editing a game, use the Lookup button next to the game's title to query (if configured via Settings) IGDB's database. Basic information about the game will be populated for you. Other information such as total player count in multiplayer modes will also be populated. This information can be used to filter the list of games within Playnite.
![enter image description here](Docs/AddGame.gif)
## Uploading an Archive
After the initial addition of game you will be able to upload an archive of the game's files. Currently the game's files must put into a compressed ZIP archive. For portable games this is usually pretty simple. For more complex games, you will have to use scripts.
![enter image description here](Docs/ArchiveUploading.gif)
## Scripts
LANCommander supports the addition and management of PowerShell scripts for games that might require a more advanced configuration. Currently the following types of scripts are supported:
- Install
- Uninstall
- Key Change
- Name Change
Scripts can be useful for games that may require changes to the Windows registry, or prerequisite config files. Here's some examples of scripts that may be useful:
- Automatically set a game's resolution to the desktop's current resolution
- Scaffolding of profiles
- Configuration of favorited servers
- Additional patches for compatibility
The script editor is pretty fully featured and is based around Microsoft's Monaco editor. Some useful snippets are included and can be inserted into the editor automatically.
![Editing an existing script](Docs/EditingScript.gif)
## Managing Serial Keys
You can manage serial keys from the LANCommander web interface. Click the "Edit" button under the Keys section to get a text editor. Each key should be on a separate line. When a key has been allocated, an admin may force that key to be released/unallocated through the web interface.
> Tip: if multiple keys exist for a game (e.g. the base game and its
> expansion packs), create groups of keys separated by commas. Within
> the key change script you can then split by comma to get the
> individual keys.
![Basic key editing and management](Docs/KeyManagement.gif)
## Authenticating through Playnite
LANCommander includes a Playnite extension, which allows you to install games from your local server. If you are on the same subnet, the server's address will be automatically discovered.
![Login screen for the Playnite extension](Docs/PlayniteAuthentication.png)
## Installing a Game through Playnite
Once authenticated, the list of games in Playnite will refresh and list the available games added to LANCommander. Click on any of the games and hit the install button. The game will download, extract, and run any post-install scripts defined.
![enter image description here](Docs/InstallingGames.gif)
## Changing a Key through Playnite
You can also change your allocated serial key through the Playnite extension. Click the "More" button in Playnite and choose "Change Game Key". If a key is available, it will be allocated to your machine by MAC address and then will run the configured KeyChange script.
![Manually request a new key](Docs/ChangeKey.png)
## Dashboard
There is also a basic dashboard so you can remotely view the server's network usage, storage allocation, and CPU usage.
![Dashboard overview](Docs/Dashboard.gif)
## FAQ ## FAQ
### How do I get games? ### How do I get games?
@ -87,12 +32,12 @@ LANCommander is far from complete. The basic implementation that exists will all
- Download games - Download games
- Basic user management - Basic user management
- New user registration - New user registration
- Local "cloud" user saves
- Game patching
The following features are being considered: The following features are being considered:
- Local "cloud" user saves
- Dedicated server management/administration - Dedicated server management/administration
- Linux build - Linux build
- Some expansion of the dashboard with useful stats - Some expansion of the dashboard with useful stats
- Built-in VPN client/server for remote LAN parties - Built-in VPN client/server for remote LAN parties
- Game patching