Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/satisfactorymodding/SatisfactoryModManager
A mod manager for easy installation of mods and modloader for Satisfactory
https://github.com/satisfactorymodding/SatisfactoryModManager
Last synced: 23 days ago
JSON representation
A mod manager for easy installation of mods and modloader for Satisfactory
- Host: GitHub
- URL: https://github.com/satisfactorymodding/SatisfactoryModManager
- Owner: satisfactorymodding
- License: gpl-3.0
- Created: 2019-03-31T21:43:42.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-04T09:33:25.000Z (7 months ago)
- Last Synced: 2024-05-04T10:30:43.379Z (7 months ago)
- Language: Go
- Homepage:
- Size: 8.54 MB
- Stars: 317
- Watchers: 28
- Forks: 74
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-modding - Satisfactory Mod Manager - Application handling all the steps of installing mods in Satisfactory for you. (Other Games / Cyberpunk 2077 / REDEngine 4)
README
# Satisfactory Mod Manager
Mod manager for [Satisfactory](https://www.satisfactorygame.com/).
Handles all the steps of installing mods for you.
Implemented in [Wails](https://wails.io/) using [Svelte](https://svelte.dev/) and [Skeleton](https://www.skeleton.dev/).
## Installation and Usage
Check the [modding documentation](https://docs.ficsit.app/satisfactory-modding/latest/index.html#_for_users)
for installation and usage instructions.
## Features
* One-click install of any mod
* Automatically downloads the dependencies of any mod
* Mod update notifications
* Mod profiles and sharing of them
* View the mod description in the app
## Reporting issues
If you have any questions or run into issues, you can ask in the
[Satisfactory Modding discord](https://discord.gg/TShj39G)
for quicker responses than the GitHub issues.
If there is any error message, please include it along with the generated debug info zip.
## Troubleshooting
Check the [modding documentation](https://docs.ficsit.app/satisfactory-modding/latest/ForUsers/SatisfactoryModManager.html)
for common issues and their solutions.
* Profile and installation records are located in `%APPDATA%\ficsit\`
* Downloads are cached in `%LOCALAPPDATA%\ficsit\downloadCache\`
* Logs are stored in `%LOCALAPPDATA%\SatisfactoryModManager\logs`
## Development
### Dependencies
* [Go 1.22](https://go.dev/doc/install)
* [pnpm](https://pnpm.io/installation)
* [nodejs](https://nodejs.org/en/download/)
* Wails (`go install github.com/wailsapp/wails/v2/cmd/wails@latest`)
* IDE of Choice. Goland or VSCode suggested.
### Configuration
If you want to point to the SMR staging API instead of production, edit:
* `main.go` to set `api-base` to the staging api (`https://api.ficsit.dev`)
* `frontend\.graphqlrc.yml` to set `schema` to the staging api (`https://api.ficsit.dev/v2/query`)
### Development Server
The development server will hot reload whenever you make changes to the Go or Typescript code.
```bash
wails dev
```
Upon successful launch of the development server, the application will open automatically.
The command line output will also include a localhost URL you can visit in your browser if you wish to utilize browser developer tools for debugging.
Make sure you don't already have a copy of the application running or the command will silently fail.
Although `wails dev` should run these commands for you under normal circumstances,
you may need to run `pnpm graphql-codegen` in the `frontend` directory to update the code generated from the SMR API,
or run `pnpm translations` to update the translation data.
### IDE Configuration
Make sure that your IDE is connecting with the frontend's installation of ESLint to get the best experience.
VSCode users, a preconfigured workspace is provided in `.vscode/`
that allows editing both Go and Svelte files
while maintaining correct ESLint functionality.
### Building
```bash
wails build
```
### Linting
Install `golangci-lint` via the directions [here](https://golangci-lint.run/usage/install/#local-installation),
but make sure to install the version specified in `.github/workflows/push.yaml` instead of whatever it suggests.
Then, to run it, use:
```bash
golangci-lint run --fix
```
You may also need to manually run the frontend linter. First, navigate to the `frontend` directory, then run:
```bash
pnpm run format
```
### Localization
If you'd like to help translate and localize SMM to different languages, join our [discord server](https://discord.ficsit.app/).
SMM handles localization through the Tolgee Svelte integration.
This allows for [in-context translation](https://tolgee.io/js-sdk/) - simply alt-click on a translatable element to open the Tolgee interface.
In order to edit translations in-context, you will need to provide a tolgee API key with edit permissions.
You can create an API key for yourself [here](https://translate.ficsit.app/projects/4/integrate) once you're added to the project.
To supply this API key at development time, create or edit `/frontend/.env.local` and supply the key in a similar format as `.env`.
The in-context translation screenshot feature requires installing the _Tolgee Tools_ browser extension.
After running `wails dev`, open `http://localhost:34115/` in your browser of choice to access the application.
## Code Signing Policy
Free code signing provided by SignPath.io, certificate by SignPath Foundation
Committers and reviewers
Approvers
Privacy Policy
Organization members
Owners
https://ficsit.app/privacy-policy