{"id":13823046,"url":"https://github.com/satisfactorymodding/SatisfactoryModManager","last_synced_at":"2025-05-16T17:33:06.397Z","repository":{"id":42682033,"uuid":"178745575","full_name":"satisfactorymodding/SatisfactoryModManager","owner":"satisfactorymodding","description":"A mod manager for easy installation of mods and modloader for Satisfactory","archived":false,"fork":false,"pushed_at":"2024-05-04T09:33:25.000Z","size":8950,"stargazers_count":317,"open_issues_count":41,"forks_count":74,"subscribers_count":28,"default_branch":"master","last_synced_at":"2024-05-04T10:30:43.379Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/satisfactorymodding.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-31T21:43:42.000Z","updated_at":"2024-05-29T21:15:16.184Z","dependencies_parsed_at":"2023-12-22T14:47:34.355Z","dependency_job_id":"2730c2f9-e28a-4dc8-9985-c5a2942814ba","html_url":"https://github.com/satisfactorymodding/SatisfactoryModManager","commit_stats":null,"previous_names":[],"tags_count":53,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/satisfactorymodding%2FSatisfactoryModManager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/satisfactorymodding%2FSatisfactoryModManager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/satisfactorymodding%2FSatisfactoryModManager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/satisfactorymodding%2FSatisfactoryModManager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/satisfactorymodding","download_url":"https://codeload.github.com/satisfactorymodding/SatisfactoryModManager/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254576790,"owners_count":22094455,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-04T08:02:31.454Z","updated_at":"2025-05-16T17:33:01.388Z","avatar_url":"https://github.com/satisfactorymodding.png","language":"Go","funding_links":[],"categories":["Other Games","Vue","Mods"],"sub_categories":["Cyberpunk 2077 / REDEngine 4"],"readme":"# Satisfactory Mod Manager\n\nMod manager for [Satisfactory](https://www.satisfactorygame.com/).\nHandles all the steps of installing mods for you.\n\nImplemented in [Wails](https://wails.io/) using [Svelte](https://svelte.dev/) and [Skeleton](https://www.skeleton.dev/).\n\n## Installation and Usage\n\nCheck the [modding documentation](https://docs.ficsit.app/satisfactory-modding/latest/index.html#_for_users)\nfor installation and usage instructions.\n\n## Features\n\n* One-click install of any mod\n* Automatically downloads the dependencies of any mod\n* Mod update notifications\n* Mod profiles and sharing of them\n* View the mod description in the app\n\n## Reporting issues\n\nIf you have any questions or run into issues, you can ask in the\n[Satisfactory Modding discord](https://discord.gg/TShj39G)\nfor quicker responses than the GitHub issues.\nIf there is any error message, please include it along with the generated debug info zip.\n\n## Troubleshooting\n\nCheck the [modding documentation](https://docs.ficsit.app/satisfactory-modding/latest/ForUsers/SatisfactoryModManager.html)\nfor common issues and their solutions.\n\n* Profile and installation records are located in `%APPDATA%\\ficsit\\`\n* Downloads are cached in `%LOCALAPPDATA%\\ficsit\\downloadCache\\`\n* Logs are stored in `%LOCALAPPDATA%\\SatisfactoryModManager\\logs`\n\n## Development\n\n### Dependencies\n\n* [Go 1.22](https://go.dev/doc/install)\n* [pnpm](https://pnpm.io/installation)\n* [nodejs](https://nodejs.org/en/download/)\n* Wails (`go install github.com/wailsapp/wails/v2/cmd/wails@latest`)\n* IDE of Choice. Goland or VSCode suggested.\n\n### Configuration\n\nIf you want to point to the SMR staging API instead of production, edit:\n\n* `main.go` to set `api-base` to the staging api (`https://api.ficsit.dev`)\n* `frontend\\.graphqlrc.yml` to set `schema` to the staging api (`https://api.ficsit.dev/v2/query`)\n\n### Development Server\n\nThe development server will hot reload whenever you make changes to the Go or Typescript code.\n\n```bash\nwails dev\n```\n\nUpon successful launch of the development server, the application will open automatically.\nThe 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.\n\nMake sure you don't already have a copy of the application running or the command will silently fail.\n\nAlthough `wails dev` should run these commands for you under normal circumstances,\nyou may need to run `pnpm graphql-codegen` in the `frontend` directory to update the code generated from the SMR API,\nor run `pnpm translations` to update the translation data.\n\n### IDE Configuration\n\nMake sure that your IDE is connecting with the frontend's installation of ESLint to get the best experience.\n\nVSCode users, a preconfigured workspace is provided in `.vscode/`\nthat allows editing both Go and Svelte files\nwhile maintaining correct ESLint functionality.\n\n### Building\n\n```bash\nwails build\n```\n\n### Linting\n\nInstall `golangci-lint` via the directions [here](https://golangci-lint.run/usage/install/#local-installation),\nbut make sure to install the version specified in `.github/workflows/push.yaml` instead of whatever it suggests.\n\nThen, to run it, use:\n\n```bash\ngolangci-lint run --fix\n```\n\nYou may also need to manually run the frontend linter. First, navigate to the `frontend` directory, then run:\n\n```bash\npnpm run format\n```\n\n### Localization\n\nIf you'd like to help translate and localize SMM to different languages, join our [discord server](https://discord.ficsit.app/).\n\nSMM handles localization through the Tolgee Svelte integration.\nThis allows for [in-context translation](https://tolgee.io/js-sdk/) - simply alt-click on a translatable element to open the Tolgee interface.\n\nIn order to edit translations in-context, you will need to provide a tolgee API key with edit permissions.\nYou can create an API key for yourself [here](https://translate.ficsit.app/projects/4/integrate) once you're added to the project.\nTo supply this API key at development time, create or edit `/frontend/.env.local` and supply the key in a similar format as `.env`.\n\nThe in-context translation screenshot feature requires installing the _Tolgee Tools_ browser extension.\nAfter running `wails dev`, open `http://localhost:34115/` in your browser of choice to access the application.\n\n## Code Signing Policy\n\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd colspan=3\u003e\n      Free code signing provided by \u003ca href=\"https://about.signpath.io/\"\u003eSignPath.io\u003c/a\u003e, certificate by \u003ca href=\"https://signpath.org/\"\u003eSignPath Foundation\u003c/a\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003cth\u003e\n      Committers and reviewers\n    \u003c/th\u003e\n    \u003cth\u003e\n      Approvers\n    \u003c/th\u003e\n    \u003cth\u003e\n      Privacy Policy\n    \u003c/th\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\n      \u003cimg src=\"https://github.com/satisfactorymodding.png?size=24\" alt=\"Satisfactory Modding Logo\" align=\"center\" /\u003e\u003ca href=\"https://github.com/orgs/satisfactorymodding/teams/members\"\u003eOrganization members\u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd\u003e\n      \u003cimg src=\"https://github.com/satisfactorymodding.png?size=24\" alt=\"Satisfactory Modding Logo\" align=\"center\" /\u003e\u003ca href=\"https://github.com/orgs/satisfactorymodding/people?query=role%3Aowner\"\u003eOwners\u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd\u003e\n      \u003ca href=\"https://ficsit.app/privacy-policy\"\u003ehttps://ficsit.app/privacy-policy\u003c/a\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\u003c!-- markdownlint-enable --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsatisfactorymodding%2FSatisfactoryModManager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsatisfactorymodding%2FSatisfactoryModManager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsatisfactorymodding%2FSatisfactoryModManager/lists"}