Renaming to vssm and adding a readme

This commit is contained in:
2026-06-05 19:39:32 -05:00
parent 8e575cab6e
commit ba5dd4f1ca
6 changed files with 112 additions and 45 deletions

49
README.md Normal file
View File

@@ -0,0 +1,49 @@
# VSSM (VintageStory Server Manager)
*A server manager for VintageStory*
## IMPORTANT INFORMATION
This project is currently in development, and thus everything is subject to change
## About
VSSM allows you to create and manage multiple VS servers
## Installation and Usage
There are no binaries just yet, so you have to download the source files.
Setup is easy from source, all you need is:
- Linux
- Go
- .NET 10 Runtime
**If you are using NixOS, a flake.nix is provided, just run `nix develop` for a full development enviroment**
- Once you have the source code downloaded or cloned, you can run `go build` to generate an executable.
- Run `./vssm daemon` to start the daemon - *(For now, theres no background service created by default, but you can run it in the background with `vssm daemon &` and kill the process with `pkill vssm`)*
- Run `./vssm` with no arguments to show usage
## Configuration
**For now, the configuration file is stored in `~/.config/vssm/config.json`, but this will be configurable later.**
## Roadmap
- [-] Configuration
- [x] Application data path
- [x] Declarative Servers
- [-] Server management
- [x] Create servers
- [x] Start/Stop servers
- [x] Multiple servers support
- [x] List servers and their status
- [ ] Delete servers
- [ ] Automated server backups
- [ ] Binary releases
- [-] Other
- [-] First class NixOS support
- [x] Patch downloaded server binaries for NixOS
- [ ] Official nix package or flake
- [ ] All configuration options