README
¶
sew
sew is a command-line interface tool designed to manage Steam Workshop items, blueprints, mods, scripts, and other related tasks for the game Space Engineers. This tool simplifies interactions with the Steam Workshop, making it easier for players to upload and manage their creations.
Disclaimer: This README was generated by ChatGPT and may not contain 100% accurate information. Please verify details and make necessary adjustments as needed.
Features
- Start/Stop Steam Client: Launch or terminate the Steam client from the command line.
- Setup SteamCMD: Automatically downloads and sets up SteamCMD if it's not already installed.
- Upload Workshop Items: Upload blueprints or mods to the Steam Workshop.
- Manage Blueprints and Mods: Access local directories for blueprints and mods.
- XML Metadata Handling: Read and manage XML metadata for Space Engineers mods.
Installation
To install sew, use the following command:
go install github.com/Merith-TK/se-workshop/cmd/sew@latest
Make sure you have Go installed and properly set up on your system. You can download and install Go from the official website.
Usage
You can run the sew command followed by various subcommands. Here's a list of available commands:
Commands
- folder: Displays the local directory for blueprints or mods.
Example
sew bp folder
This will output the directory path where your local blueprints or mods are stored.
Configuration
The application uses the following environment variable to determine the Space Engineers directory:
APPDATA: This should be set to the AppData folder for your user profile.
Structure
The application is structured into several packages:
shared: Contains common functionalities, configurations, and structures used across the application.sebp: Handles commands related to blueprints.semod: Manages commands related to mods.sescr: Deals with commands for in-game scripts.
Contributing
Contributions are welcome! If you'd like to contribute to this project, please fork the repository and submit a pull request.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
sew
command
Package main provides a command-line interface for managing Space Engineers blueprints, mods, scripts, and related Steam Workshop items.
|
Package main provides a command-line interface for managing Space Engineers blueprints, mods, scripts, and related Steam Workshop items. |
|
Package vdf provides utilities to read metadata files (e.g., info.txt and changelog.txt) for mods and workshop items, particularly for Space Engineers Workshop content.
|
Package vdf provides utilities to read metadata files (e.g., info.txt and changelog.txt) for mods and workshop items, particularly for Space Engineers Workshop content. |
|
workshop
|
|