{"id":20972198,"url":"https://github.com/drkhsh/zsh-banner","last_synced_at":"2025-04-23T05:09:37.763Z","repository":{"id":255928338,"uuid":"853030272","full_name":"drkhsh/zsh-banner","owner":"drkhsh","description":"zsh-plugin to display ascii/ansi art on startup. mirror from git.drkhsh.at","archived":false,"fork":false,"pushed_at":"2024-09-27T13:06:48.000Z","size":5,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-23T05:09:31.128Z","etag":null,"topics":["ansi-art","banner","motd","zsh","zsh-custom","zsh-plugin","zshell"],"latest_commit_sha":null,"homepage":"https://git.drkhsh.at/zsh-banner","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/drkhsh.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":"2024-09-05T21:25:02.000Z","updated_at":"2025-02-19T15:23:29.000Z","dependencies_parsed_at":"2024-09-07T22:51:25.727Z","dependency_job_id":"8a9692eb-3eac-4c9d-8402-f2f87a605b4b","html_url":"https://github.com/drkhsh/zsh-banner","commit_stats":null,"previous_names":["drkhsh/zsh-banner"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drkhsh%2Fzsh-banner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drkhsh%2Fzsh-banner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drkhsh%2Fzsh-banner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drkhsh%2Fzsh-banner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/drkhsh","download_url":"https://codeload.github.com/drkhsh/zsh-banner/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250372929,"owners_count":21419722,"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":["ansi-art","banner","motd","zsh","zsh-custom","zsh-plugin","zshell"],"created_at":"2024-11-19T04:06:48.768Z","updated_at":"2025-04-23T05:09:37.747Z","avatar_url":"https://github.com/drkhsh.png","language":"Shell","funding_links":[],"categories":["Plugins"],"sub_categories":["ZSH on Windows"],"readme":"```\n              __           __\n .-----.-----|  |--.______|  |--.---.-.-----.-----.-----.----.\n |-- __|__ --|     |______|  _  |  _  |     |     |  -__|   _|\n |_____|_____|__|__|      |_____|___._|__|__|__|__|_____|__|\n```\n\n# zsh-banner\n\nA zsh plugin to display ANSI/ASCII art on shell startup.\n\nThis is a simplified/slightly adapted and maintained fork of\n[yuhonas/zsh-ansimotd](https://github.com/yuhonas/zsh-ansimotd).\n\n## Installation\n\n### Dependencies\n\n* [zsh](https://www.zsh.org/)\n\n#### Optional\n* [shuf]( https://en.wikipedia.org/wiki/Shuf) which is part of gnu\n  [coreutils](https://formulae.brew.sh/formula/coreutils)\n* [fd](https://github.com/sharkdp/fd) a modern `find` replacement, it will use\n  this preferentially if it's installed otherwise fallback to `find`.\n* [pv](https://www.ivarch.com/programs/pv.shtml) a pipe viewer which can limit\n  the art rendering speed to emulate the feel of an old skool BBS.\n\n### Install using your favourite plugin manager or not\n\n```\n# for zinit\nzinit light drkhsh/zsh-banner\n\n# for znap\nznap source yuhonas/zsh-ansimotd\n\n# for antigen\nantigen bundle yuhonas/zsh-ansimotd\n\n# for zplug\nzplug \"yuhonas/zsh-ansimotd\"\n\n# manually\n# Clone the repository and source it in your shell's rc file\n```\n\n### Getting some awesome ansi art to display\n\nAfter installation you'll need to download some ansi art for it to randomly\ndisplay, I suggest a few places:\n\n#### 16colo.rs\n\nHead over to [16colo.rs](https://16colo.rs/) and if you find a year(s) you like\nyou can download everything from that year using their rsync mirror.\n\neg. to download everything from [1996](https://16colo.rs/year/1996/) to the\n`ZSH_BANNER_DIR`:\n\n```\nrsync -azvhP --include '*/' --include '*.ANS' --exclude '*' rsync://16colo.rs/pack/1996 \"$ZSH_BANNER_DIR\"\n```\n\n#### artscene.textfiles.com\n\nFind a pack you like at [artscene](http://artscene.textfiles.com/artpacks/) and\nunpack it into the ansi motd config directory.\n\nYou can do this by copying any `.ans`, or `.asc` files containg ansi art into\nyour `ZSH_BANNER_DIR` directory which is derived from\n`${XDG_CONFIG_HOME:-$HOME/.config}/ansimotd` (the plugin performs a recursive\nsearch for art so any directory nesting is fine).\n\n### Configuration / Settings\n\nThe plugin exports the following useful variables to the session\n\n* `ZSH_BANNER_DIR`  - the full path to the config directory where the plugin\n  will search for ansi art\n* `ZSH_BANNER_FILENAME` - the full file path to the last shown peice of ansi art,\n  if you want to do something with it, laud over it, delete it etc\n\nThere's also a handful of ENV variables you can use to configure the plugin\n(these will need to be set prior to plugin instantiation).\n\n#### The real BBS experience\n\nTo buffer the ansi art output at a fixed speed you can set the\n`ZSH_BANNER_RATE_LIMIT_OUTPUT` ENV variable.\n\neg. to limit the ansi art rendering rate to a data rate of 8k:\n\n```\nexport ZSH_BANNER_RATE_LIMIT_OUTPUT=\"8k\"\n```\n\n#### Small screens\n\nIf you happen to be running on a small fixed screen perhaps on something like\n[termux](https://termux.dev/en/) you can set the following environemnt variable\nto truncate the art to screen width:\n\n```\nexport ZSH_BANNER_DISABLE_LINE_WRAPPING=1\n```\n\n### Note\n\nArt to be displayed is assumed to use the\n[Code Page 437]( https://en.wikipedia.org/wiki/Code_page_437 ) character set.\n\n\n### License\n\nThis project is licensed under the [MIT](./LICENSE) license.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdrkhsh%2Fzsh-banner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdrkhsh%2Fzsh-banner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdrkhsh%2Fzsh-banner/lists"}