{"id":26600699,"url":"https://github.com/maxwelljens/gibman","last_synced_at":"2025-10-06T00:36:20.637Z","repository":{"id":280700054,"uuid":"942872139","full_name":"maxwelljens/gibman","owner":"maxwelljens","description":"A DOOM WAD manager for nerds","archived":false,"fork":false,"pushed_at":"2025-03-25T15:46:46.000Z","size":55,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-24T10:59:43.298Z","etag":null,"topics":["cli","doom","game","mod-manager","nim","terminal","wad"],"latest_commit_sha":null,"homepage":"","language":"Nim","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"eupl-1.2","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maxwelljens.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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":"2025-03-04T20:13:49.000Z","updated_at":"2025-04-10T14:35:54.000Z","dependencies_parsed_at":"2025-03-04T21:25:28.505Z","dependency_job_id":"1eacad47-617c-41df-ae38-981010f36774","html_url":"https://github.com/maxwelljens/gibman","commit_stats":null,"previous_names":["maxwelljens/gibman"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/maxwelljens/gibman","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxwelljens%2Fgibman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxwelljens%2Fgibman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxwelljens%2Fgibman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxwelljens%2Fgibman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maxwelljens","download_url":"https://codeload.github.com/maxwelljens/gibman/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxwelljens%2Fgibman/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278542660,"owners_count":26004060,"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","status":"online","status_checked_at":"2025-10-05T02:00:06.059Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["cli","doom","game","mod-manager","nim","terminal","wad"],"created_at":"2025-03-23T18:33:30.997Z","updated_at":"2025-10-06T00:36:20.621Z","avatar_url":"https://github.com/maxwelljens.png","language":"Nim","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gibman\n\n![](logo.png)\n\n*A DOOM WAD manager for nerds*\n\n## What is `gibman`?\n\n`gibman` is a simple CLI utility designed to do one thing: to run presets for\nyour favourite DOOM engine. Although chiefly designed with GZDoom in mind,\nother engines should be supported (more on that below). The program operates on\na simple [YAML](https://www.redhat.com/en/blog/yaml-beginners) file, with which\nyou can set up all of your engines, IWADs, and WADs. Both Windows and Linux are\nsupported.\n\n## Quick usage:\n\nGiven the following configuration in `$XDG_CONFIG_HOME/gibman/gibman.yaml`, or\n`~/.config/gibman/gibman.yaml` if `$XDG_CONFIG_HOME` is not set:\n\n```yaml\nengine:\n  - name: gzdoom\n    path: /path/to/gzdoom\n\niwad:\n  - name: doom2\n    path: /path/to/DOOM2.WAD\n\nsearch:\n  - /path/to/wads\n\npreset:\n  - name: example\n    description: A description to help you remember what the preset is for\n    engine: gzdoom\n    iwad: doom2\n    wad:\n      - eviternity\n    args: []\n```\n\nRun the following to run your `example` preset:\n\n```fish\ngibman -p example\n```\n\nThis will run GZDoom with the DOOM 2 IWAD and Eviternity WAD, if something like\n`Eviternity.WAD` exists in one of the directories outlined in the `search`\nsection of the configuration file. More information can be found in\n[`default_config.yaml`](https://github.com/maxwelljens/gibman/blob/master/default_config.yaml),\nwhich is also placed in `$XDG_CONFIG_HOME/gibman/gibman.yaml` when running the\nprogram for the first time.\n\n## How does `gibman` work?\n\nAt its core, the program simply constructs a string to execute as command in\nthe user's shell. This makes the program both platform-agnostic and not tied to\nany particular DOOM engine. The above example would produce the following\nstring:\n\n```fish\n/path/to/gzdoom -iwad /.../DOOM2.WAD -file /.../Eviternity.wad\n```\n\nOr with backslashes, if you are on Windows. If you were to specify any `args`\nin your preset, those would be added at the end. For example:\n\n```yaml\nargs:\n  - -dog\n  - 2\n```\n\nWould be added to the above command at the end as `-dog 2`, which is a command\nline option in the Woof! DOOM engine. This allows you to use any DOOM engine\nthat uses the `-iwad` and `-file` command line options. Such engines include\nGZDoom, ZDoom, Woof!, Eternity Engine, and probably many others.\n\n## Options\n\nThe program includes a few options. Running the program without any options\nsimply executes the default (i.e. topmost specified) engine and IWAD in the\n`gibman.yaml` configuration file.\n\n- **`-h/--help`**: Print help for the program.\n\n- **`-p/--preset`**: Execute the specified preset. The `name` attribute is used\nas the argument for this option.\n\n- **`-l/--list-presets`**: List the presets in your configuration. This is\nhelpful if you forget which presets you have, but don't want to open a text\neditor to read the `gibman.yaml` file again. It looks like the following:\n\n```\n┌─────────┬───────────────────────────────────────┬────────┬───────────────────┐\n│ Name    │ Description                           │ Engine │ WADs              │\n├─────────┼───────────────────────────────────────┼────────┼───────────────────┤\n│ example │ A description to help you remember    │ gzdoom │ doom2, eviternity │\n│         │ what the preset is for                │        │                   │\n└─────────┴───────────────────────────────────────┴────────┴───────────────────┘\n```\n\n- **`-v/--verbose`**: Run program in verbose mode. At the moment this only\nmeans printing the shell string before launching the game.\n\n## Environment variables\n\nWhile `gibman` makes extensive use of ANSI colour sequences in its output, it\ndoes respect the [`NO_COLOR`](https://no-color.org/) environment variable,\ndisabling colour if it is set to any value.\n\n## Installing\n\n### Windows and Linux\n\nBinary releases (executables) of `gibman` are available for both Windows and\nLinux in the [Releases page](https://github.com/maxwelljens/gibman/releases).\n\n### macOS\n\nDue to difficulty in cross-compiling for macOS, binary releases for macOS are\nnot available. macOS users need to compile from source.\n\n## Compiling from source\n\n`gibman` is made in the [Nim](https://nim-lang.org/) programming language, so\nthe Nim toolchain will be required. This can be acquired\n[here](https://nim-lang.org/install.html), and it is the recommended method for\nall platforms. This will install both Nim and the Nimble package manager, both\nof which are required for compiling `gibman` from source.\n\nAfterwards, navigate to the root of the project and run the following command\nto compile `gibman`:\n\n```fish\nnimble c -o:build/gibman src/gibman.nim\n```\n\nIf all goes well, this should download all dependencies and produce an\nexecutable of `gibman` in the `build` directory for your platform.\n\n## Licence\n\nThis software is licensed under the [European Union Public Licence\n1.2](https://eupl.eu/1.2/en/). 2025 copyright of Maxwell Jensen.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxwelljens%2Fgibman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaxwelljens%2Fgibman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxwelljens%2Fgibman/lists"}