From 8acb69001451dd4b3e0b3e7b777633e74e8d2e14 Mon Sep 17 00:00:00 2001 From: Rob B Date: Tue, 13 Aug 2024 19:36:41 -0500 Subject: [PATCH] feat: docs update, darwin dirs (#66) * chore: update linter and spellchecker for readme * docs: add basic directions for managing installations * chore: replace old repo links * feat: dirs for darwin support --------- Co-authored-by: Vilsol --- README.md | 77 +++++++++++++++++++++++++++++++++-------------------- cmd/root.go | 2 ++ cspell.json | 1 + tools.go | 2 ++ 4 files changed, 53 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index f0d2c61..a35614f 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ - + + +ficsit-cli screenshot -# ficsit-cli [![push](https://github.com/Vilsol/ficsit-cli/actions/workflows/push.yaml/badge.svg)](https://github.com/Vilsol/ficsit-cli/actions/workflows/push.yaml) ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/vilsol/ficsit-cli) ![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/vilsol/ficsit-cli) [![GitHub license](https://img.shields.io/github/license/Vilsol/ficsit-cli)](https://github.com/Vilsol/ficsit-cli/blob/master/LICENSE) ![GitHub all releases](https://img.shields.io/github/downloads/vilsol/ficsit-cli/total) +# ficsit-cli [![push](https://github.com/satisfactorymodding/ficsit-cli/actions/workflows/push.yaml/badge.svg)](https://github.com/satisfactorymodding/ficsit-cli/actions/workflows/push.yaml) ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/satisfactorymodding/ficsit-cli) ![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/satisfactorymodding/ficsit-cli) [![GitHub license](https://img.shields.io/github/license/satisfactorymodding/ficsit-cli)](https://github.com/satisfactorymodding/ficsit-cli/blob/master/LICENSE) ![GitHub all releases](https://img.shields.io/github/downloads/satisfactorymodding/ficsit-cli/total) -A CLI tool for managing mods for the game Satisfactory +A CLI tool for managing mods for the game [Satisfactory](https://www.satisfactorygame.com/). --- @@ -19,10 +21,10 @@ A CLI tool for managing mods for the game Satisfactory Windows - amd64 - 386 - arm64 - armv7 + amd64 + 386 + arm64 + armv7 N/A @@ -31,39 +33,39 @@ A CLI tool for managing mods for the game Satisfactory Debian - amd64 - 386 - arm64 - armv7 - ppc64le + amd64 + 386 + arm64 + armv7 + ppc64le Fedora - amd64 - 386 - arm64 - armv7 - ppc64le + amd64 + 386 + arm64 + armv7 + ppc64le Alpine - amd64 - 386 - arm64 - armv7 - ppc64le + amd64 + 386 + arm64 + armv7 + ppc64le Linux - amd64 - 386 - arm64 - armv7 - ppc64le + amd64 + 386 + arm64 + armv7 + ppc64le macOS - darwin_all + darwin_all N/A @@ -74,15 +76,32 @@ A CLI tool for managing mods for the game Satisfactory To launch the interactive CLI, run the executable without any arguments. +All screens display control hints at the bottom. + ### Command Line -Run `ficsit help` to see a list of available commands. +Run `ficsit help` to see a list of available commands and flags. + +## Managing Installations + +Unlike [Satisfactory Mod Manager](https://github.com/satisfactorymodding/SatisfactoryModManager/), +ficsit-cli does not automatically detect installations. + +First, locate your game install path. +Check the [Modding FAQ](https://docs.ficsit.app/satisfactory-modding/latest/faq.html#Files_GameInstall) +to learn how to find it given your specific install situation. + +To add installations in the interactive CLI, use `Installations` > `new installation`. + +To add installations from the command line, use `ficsit-cli installation add yourPathHere`. ## Troubleshooting * Profile and installation records are located in `%APPDATA%\ficsit\` * Downloads are cached in `%LOCALAPPDATA%\ficsit\downloadCache\` +Get help on the [modding Discord](https://discord.ficsit.app/). + ## Development ### Dependencies diff --git a/cmd/root.go b/cmd/root.go index 6c4369f..6f72312 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -131,6 +131,8 @@ func init() { baseLocalDir = os.Getenv("APPDATA") case "linux": baseLocalDir = filepath.Join(os.Getenv("HOME"), ".local", "share") + case "darwin": + baseLocalDir = filepath.Join(os.Getenv("HOME"), "Library", "Application Support") default: panic("unsupported platform: " + runtime.GOOS) } diff --git a/cspell.json b/cspell.json index b9ab9fa..430c2df 100644 --- a/cspell.json +++ b/cspell.json @@ -6,6 +6,7 @@ "language": "en", // words - list of words to be always considered correct "words": [ + "armv", "ficsit", "gofumpt", "Goland", diff --git a/tools.go b/tools.go index dc2b940..bbd3f57 100644 --- a/tools.go +++ b/tools.go @@ -46,6 +46,8 @@ func main() { baseLocalDir = os.Getenv("APPDATA") case "linux": baseLocalDir = filepath.Join(os.Getenv("HOME"), ".local", "share") + case "darwin": + baseLocalDir = filepath.Join(os.Getenv("HOME"), "Library", "Application Support") default: panic("unsupported platform: " + runtime.GOOS) }