{"id":17770121,"url":"https://github.com/j3rn/spell","last_synced_at":"2025-04-01T14:24:48.569Z","repository":{"id":34859379,"uuid":"38857599","full_name":"J3RN/spell","owner":"J3RN","description":"Spelling bot","archived":false,"fork":false,"pushed_at":"2015-09-07T18:36:59.000Z","size":996,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-07T09:13:20.274Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/J3RN.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-07-10T02:57:20.000Z","updated_at":"2015-07-10T02:57:58.000Z","dependencies_parsed_at":"2022-09-15T07:20:22.673Z","dependency_job_id":null,"html_url":"https://github.com/J3RN/spell","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/J3RN%2Fspell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/J3RN%2Fspell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/J3RN%2Fspell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/J3RN%2Fspell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/J3RN","download_url":"https://codeload.github.com/J3RN/spell/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246652765,"owners_count":20812186,"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":[],"created_at":"2024-10-26T21:20:42.661Z","updated_at":"2025-04-01T14:24:48.549Z","avatar_url":"https://github.com/J3RN.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# spell\nThe spelling bot\n\n## What is spell?\n\nSpell is a bot to correct spelling. When in a channel with spell, simply say:\n```\nspell: Spell this sentance!\n```\nAnd spell will obediently reply:\n```\n\u003cyour nick here\u003e meant to say \"spell this sentence!\"\n```\n\n## Commands\n\n### All user commands\n- `!!top\u003cx\u003e`: Spell will list the top `x` number of words said. Only works for single digits (on purpose).\n\n### Master commands\n- `!!annoying`: Enable annoying mode. Spell will correct everything said in all channels. Everything.\n- `!!stop`: Disable annoying mode. Spell will stop correcting everything said everywhere.\n- `!!join \u003cchannel\u003e`: Spell will join that channel.\n- `!!part`: Spell will leave the current channel.\n- `!!add \u003cword1 word2 ...\u003e`: Adds the given words to the dictionary.\n\n*I am not responsible for anything Spell says to a normal user trying to use a master command.*\n\n## Setup\n\nFirst, you'll need to have a [Redis](http://redis.io) server running.\n\nAfter downloading a dictionary file (try [ENABLE](https://code.google.com/p/dotnetperls-controls/downloads/detail?name=enable1.txt)), and saving it in the directory as `words.txt`, run:\n\n```bash\n./bin/bootstrap\n```\n\nNext, you'll need specify some configuration. Look at `settings-example.json` for an example. You may simply copy `settings-example.json` to `settings.json`, and change the fields appropriately.\n\nThen, to start the bot, simply run:\n\n```bash\n./bin/start\n```\n\nAlso, if you'd like to play around with the underlying `Spell` class, I've added:\n\n```bash\nbin/console\n```\n\nThen you can use the provided `@spell` instance\n\n```\nirb(main)\u003e @spell.best_match('aligator')\n=\u003e \"alligator\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fj3rn%2Fspell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fj3rn%2Fspell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fj3rn%2Fspell/lists"}