{"id":25228160,"url":"https://github.com/ompreetham/bitmapit-preview","last_synced_at":"2026-05-08T10:32:55.225Z","repository":{"id":276526983,"uuid":"929538431","full_name":"OmPreetham/bitmapit-preview","owner":"OmPreetham","description":"PREVIEW: A lightweight JavaScript library for generating bitmap-style ASCII art text. BitmapIt allows you to create customizable retro-style text displays with various styling options and character sets.","archived":false,"fork":false,"pushed_at":"2025-02-08T19:35:08.000Z","size":10,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-08T20:26:26.406Z","etag":null,"topics":["alphabets","ascii","bitmap","bitmapit","characters","js","library","npm","retro","styles"],"latest_commit_sha":null,"homepage":"https://bitmapit-preview.vercel.app","language":"HTML","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/OmPreetham.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":"2025-02-08T19:24:22.000Z","updated_at":"2025-02-08T19:36:33.000Z","dependencies_parsed_at":"2025-02-08T20:36:51.579Z","dependency_job_id":null,"html_url":"https://github.com/OmPreetham/bitmapit-preview","commit_stats":null,"previous_names":["ompreetham/bitmapit-preview"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmPreetham%2Fbitmapit-preview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmPreetham%2Fbitmapit-preview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmPreetham%2Fbitmapit-preview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmPreetham%2Fbitmapit-preview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OmPreetham","download_url":"https://codeload.github.com/OmPreetham/bitmapit-preview/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238271656,"owners_count":19444691,"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":["alphabets","ascii","bitmap","bitmapit","characters","js","library","npm","retro","styles"],"created_at":"2025-02-11T09:51:45.910Z","updated_at":"2026-05-08T10:32:55.146Z","avatar_url":"https://github.com/OmPreetham.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BitmapIt\n\nA lightweight JavaScript library for generating bitmap-style ASCII art text. BitmapIt allows you to create customizable retro-style text displays with various styling options and character sets.\n\n[![Demo](https://img.shields.io/badge/Try%20Demo-Live-blue)](https://bitmapit-preview.vercel.app/)\n[![npm](https://img.shields.io/npm/v/bitmapit)](https://www.npmjs.com/package/bitmapit)\n[![License](https://img.shields.io/badge/license-MIT-green)](LICENSE)\n\n## Features\n\n- Convert text to customizable bitmap patterns\n- Multiple display characters (blocks, symbols, custom characters)\n- Adjustable font dimensions and spacing\n- Clean and simple API\n- HTML output with custom colors\n- Mobile-friendly and responsive\n- Zero dependencies\n\n## Installation\n\n```bash\nnpm install bitmapit\n```\n\nOr include directly in your HTML:\n\n```html\n\u003cscript type=\"module\"\u003e\n  import { BitmapFontGenerator } from './path/to/bitmapit/index.js';\n\u003c/script\u003e\n```\n\n## Basic Usage\n\n```javascript\nimport { BitmapFontGenerator, defaultFont } from 'bitmapit';\n\n// Create generator\nconst generator = new BitmapFontGenerator();\n\n// Define characters\nObject.entries(defaultFont).forEach(([char, pattern]) =\u003e {\n  generator.defineCharacter(char, pattern);\n});\n\n// Generate text\nconst bitmap = generator.generateText('HELLO');\nconsole.log(generator.toAscii(bitmap));\n```\n\n## Customization\n\n### Font Dimensions\n\n```javascript\nconst generator = new BitmapFontGenerator({\n  width: 8,    // Character width\n  height: 8,   // Character height\n  spacing: 1   // Space between characters\n});\n```\n\n### Display Options\n\n```javascript\nconst generator = new BitmapFontGenerator({\n  onChar: '█',           // Character for filled pixels\n  offChar: ' ',          // Character for empty pixels\n  color: '#ffffff',      // Text color (HTML only)\n  backgroundColor: '#000000'  // Background color (HTML only)\n});\n```\n\n## API Reference\n\n### Constructor\n\n```javascript\nnew BitmapFontGenerator(options)\n```\n\nOptions:\n- `width` (Number, default: 8): Width of each character\n- `height` (Number, default: 8): Height of each character\n- `spacing` (Number, default: 1): Space between characters\n- `onChar` (String, default: '█'): Character for filled pixels\n- `offChar` (String, default: ' '): Character for empty pixels\n\n### Methods\n\n#### defineCharacter(char, pattern)\nDefine a new character pattern.\n\n```javascript\ngenerator.defineCharacter('A', [\n  [0,1,1,1,0],\n  [1,0,0,0,1],\n  [1,1,1,1,1],\n  [1,0,0,0,1],\n  [1,0,0,0,1]\n]);\n```\n\n#### generateText(text)\nGenerate a bitmap pattern for the given text.\n\n```javascript\nconst bitmap = generator.generateText('HELLO');\n```\n\n#### toAscii(bitmap, options)\nConvert a bitmap to ASCII art.\n\n```javascript\nconst ascii = generator.toAscii(bitmap, { \n  on: '█', \n  off: ' ' \n});\n```\n\n#### toHtml(bitmap, options)\nConvert a bitmap to HTML with styling.\n\n```javascript\nconst html = generator.toHtml(bitmap, {\n  color: '#ff0000',\n  backgroundColor: '#000000',\n  on: '█',\n  off: ' '\n});\n```\n\n#### setDimensions(width, height)\nUpdate the font dimensions.\n\n```javascript\ngenerator.setDimensions(10, 10);\n```\n\n#### setSpacing(spacing)\nSet the spacing between characters.\n\n```javascript\ngenerator.setSpacing(2);\n```\n\n## Browser Support\n\n- Chrome 61+\n- Firefox 60+\n- Safari 11+\n- Edge 16+\n\n## Examples\n\nVisit our [demo page](https://bitmapit.vercel.app) to try BitmapIt live and see various examples in action.\n\n## Contributing\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Author\n\nCreated by Om Preetham\n\n## Support\n\n- Report issues on [GitHub](https://github.com/OmPreetham/bitmapit/issues)\n- For questions and discussions, use [GitHub Discussions](https://github.com/OmPreetham/bitmapit/discussions)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fompreetham%2Fbitmapit-preview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fompreetham%2Fbitmapit-preview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fompreetham%2Fbitmapit-preview/lists"}