{"id":19742874,"url":"https://github.com/kubap/factorio-profiles","last_synced_at":"2025-02-27T23:23:20.629Z","repository":{"id":47048273,"uuid":"399176295","full_name":"KubaP/Factorio-Profiles","owner":"KubaP","description":"A set of powershell commands for easily managing \u0026 switching between different factorio profiles, (sets of saves, mods, configurations, etc).","archived":false,"fork":false,"pushed_at":"2022-02-13T19:20:12.000Z","size":752,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"development","last_synced_at":"2025-01-10T20:21:40.866Z","etag":null,"topics":["factorio","game","mod-manager","powershell","profile-manager"],"latest_commit_sha":null,"homepage":"","language":"C#","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/KubaP.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}},"created_at":"2021-08-23T16:34:45.000Z","updated_at":"2021-10-24T16:08:53.000Z","dependencies_parsed_at":"2022-08-30T05:41:35.693Z","dependency_job_id":null,"html_url":"https://github.com/KubaP/Factorio-Profiles","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":"KubaP/Powershell-TEMPLATE","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KubaP%2FFactorio-Profiles","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KubaP%2FFactorio-Profiles/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KubaP%2FFactorio-Profiles/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KubaP%2FFactorio-Profiles/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KubaP","download_url":"https://codeload.github.com/KubaP/Factorio-Profiles/tar.gz/refs/heads/development","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241072770,"owners_count":19904836,"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":["factorio","game","mod-manager","powershell","profile-manager"],"created_at":"2024-11-12T01:34:11.677Z","updated_at":"2025-02-27T23:23:20.591Z","avatar_url":"https://github.com/KubaP.png","language":"C#","readme":"![Banner](./img/logo.png#gh-light-mode-only)\n![Banner](./img/logo_dark.png#gh-dark-mode-only)\n\n\u003cbr\u003e\n\u003cbr\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://www.powershellgallery.com/packages/FactorioProfiles\"\u003e\n    \u003cimg src=\"https://img.shields.io/powershellgallery/v/FactorioProfiles?logo=powershell\u0026logoColor=white\"\u003e\n\u003c/a\u003e\n\u003ca href=\"\"\u003e\n    \u003cimg src=\"https://img.shields.io/powershellgallery/p/FactorioProfiles\"\u003e\n\u003c/a\u003e\n\u003ca href=\"./LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/license-GPLv3-blue\"\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cbr\u003e\n\nFactorio-Profiles is a module designed to help manage multiple factorio profiles, by providing a set of simple and self-explanatory cmdlets to use inside of powershell.\n\nThis module is aimed at anyone who has multiple factorio instances they play with, but still wants to play the game through steam rather than manually keeping track of many portable factorio installations.\n\n### Table of Contents\n1. [Getting Started](#getting-started)\n2. [Information \u0026 Features](#information--features)\n3. [FAQ](#faq)\n4. [Build Instructions](#build-instructions)\n5. [Support](#support)\n6. [Contributing](#contributing)\n7. [License](#license)\n\n## Getting Started\n### Installation\nIn order to get started with the latest version, simply download the module from the [PSGallery](https://www.powershellgallery.com/packages/FactorioProfiles), or install it from powershell by running:\n```powershell\nInstall-Module FactorioProfiles\n```\nAlternatively, download the `.zip` package from the [Releases](https://github.com/KubaP/Factorio-Profiles/releases) page, extract the contents, and copy over the `FactorioProfiles` folder to either:\n- `~\\Documents\\Powershell\\Modules` if you're using `pwsh \u003e= 6.0`, or\n- `~\\Documents\\WindowsPowershell\\Modules` if you're using `Windows Powershell 5.1`\n\n### Requirements\nThis module requires minimum `Powershell 5.1`.\n\nThis module works on **Windows** only, due to the windows-specific symbolic-link creation.\n\n### Creating a new Profile\nTo create a new profile, simply run:\n```powershell\nNew-FactorioProfile -Name \u003cPROFILE_NAME\u003e\n```\nThis will create a new profile at the default location.\n\n### Editing the contents of a Profile\nTo copy over existing mod/save files, modify the profile's contents, or do anything else, run:\n```powershell\nOpen-FactorioProfileFolder -Name \u003cPROFILE_NAME\u003e\n```\nThis will open `explorer.exe` at the profile folder.\n\n### Switching to a Profile\nTo active a profile, run:\n```powershell\nSwitch-FactorioProfile -Name \u003cPROFILE_NAME\u003e\n```\nThis will switch to the specified profile. You can now launch the game through Steam or a standalone installation and this profile will be in use.\n\n⚠It may be a good idea to disable the *Steam Cloud Sync* feature for the game if you are launching it through Steam.\n\n\n## Information \u0026 Features\n### Documentation\nFor a detailed rundown and explanation of all the features in this module, view the **help page** by running:\n```powershell\nImport-Module FactorioProfiles\nGet-Help about_FactorioProfiles\n```\nFor detailed help about a specific cmdlet, run:\n```powershell\nGet-Help \u003cCOMMAND NAME\u003e -Full\n```\n\n### Extra features\n\n#### Tab completion\nThe `Name`/`Names` parameter supports tab-completion of **existing** `Profile` names in the following cmdlets:\n- `Get-FactorioProfile`\n- `Set-FactorioProfileOption`\n- `Remove-FactorioProfile`\n- `Switch-FactorioProfile`\n- `Open-FactorioProfileFolder`\n\n#### Prompt support\nThe cmdlets do not support the `-WhatIf` nor the `-Confirm` switches. However, if any ambiguous or dangerous operations arise, a prompt will be displayed asking for user input.\n\n#### Formatting\nThe `Profile` object within this module has custom formatting rules for all views. Simply pipe the output of the `Get-FactorioProfile` cmdlet to one of:\n| Cmdlet        | Alias |\n| ------------- | ----- |\n| Format-List   | fl    |\n| Format-Table  | ft    |\n| Format-Custom | fc    |\n| Format-Wide   | fw    |\n\nThe `Format-Custom` \u0026 `Format-List` views contain the largest amount of information regarding a `Profile`.\n\n## FAQ\n**Q**. Why not just have multiple independent portable factorio installations?\n\n**A**. Portable factorio installations will not run through Steam. This is an issue if you like or rely on features Steam provides. Plus, even with portable installations, you would have to manually link files if you wanted to share \"things\" across multiple installations, such as sharing the config file.\n\n**Q**. If running through Steam is so important, why not just modify the `--config` and `--mod-directory` launch parameters?\n\n**A**. That requires manual editing each time you want to change the values, plus, there is no way to separate saves, scenarios, or other \"things\" in a factorio profile; only the configuration file and mods.\n\n## Build Instructions\n#### Prerequisites\nInstall the following:\n- Powershell 5.1+\n- dotnet 5.0+\n- Pester **4.10.1**\n- PSScriptAnalyzer 1.18.0+\n\n#### Clone the git repo\n```bash\ngit clone https://github.com/KubaP/Factorio-Profiles.git\n```\n\n#### Run the build scripts\nNavigate to the root repository folder and run the following commands:\n```powershell\n\u0026 .\\build\\vsts-prerequisites.ps1\n\u0026 .\\build\\vsts-validate.ps1\n\u0026 .\\build\\vsts-build-prerequisites\n\u0026 .\\build\\vsts-build.ps1 -WorkingDirectory .\\ -SkipPublish\n```\nThe built module will be located in the `.\\publish` folder.\n\n## Support\n⚠If you need help regarding the usage of the module, please **first see the help page** by running:\n```powershell\nImport-Module FactorioProfiles\nGet-Help about_FactorioProfiles\n```\n\nIf something is still unclear, or there is a bug or problem, please create a new **Github Issue**.\n\n## Contributing\nIf you have a suggestion, create a new **Github Issue** detailing the idea.\n\nFeel free to make pull requests if you have an improvement. Only submit a single feature at a time, and make sure that the code is cleanly formatted, readable, and well commented.\n\n## License \nThis project is licensed under the **GPLv3** license - see [.\\LICENSE](./LICENSE) for details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkubap%2Ffactorio-profiles","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkubap%2Ffactorio-profiles","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkubap%2Ffactorio-profiles/lists"}