{"id":22694975,"url":"https://github.com/xforever1313/chaskis","last_synced_at":"2025-04-13T01:36:11.865Z","repository":{"id":46306166,"uuid":"55370850","full_name":"xforever1313/Chaskis","owner":"xforever1313","description":"A framework for making IRC Bots.","archived":false,"fork":false,"pushed_at":"2023-04-17T23:47:30.000Z","size":7124,"stargazers_count":9,"open_issues_count":7,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-13T08:00:23.334Z","etag":null,"topics":["aur","bot","chocolatey","cowsay","dotnet","dotnet-core","framework","hacktoberfest","irc","irc-bot","irc-channel","linux","making-irc-bots","plugins","windows"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xforever1313.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE_1_0.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-04-03T21:49:49.000Z","updated_at":"2022-01-11T04:32:54.000Z","dependencies_parsed_at":"2022-09-17T16:20:40.391Z","dependency_job_id":null,"html_url":"https://github.com/xforever1313/Chaskis","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xforever1313%2FChaskis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xforever1313%2FChaskis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xforever1313%2FChaskis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xforever1313%2FChaskis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xforever1313","download_url":"https://codeload.github.com/xforever1313/Chaskis/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228996036,"owners_count":18003633,"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":["aur","bot","chocolatey","cowsay","dotnet","dotnet-core","framework","hacktoberfest","irc","irc-bot","irc-channel","linux","making-irc-bots","plugins","windows"],"created_at":"2024-12-10T03:10:42.383Z","updated_at":"2024-12-10T03:10:43.107Z","avatar_url":"https://github.com/xforever1313.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Icon](https://files.shendrick.net/projects/chaskis/assets/icon.png)](https://github.com/xforever1313/Chaskis/)\nChaskis \n==========\nA generic framework written in C# for making IRC Bots.\n\nBuild Status\n--------------\n[![Build status](https://ci.appveyor.com/api/projects/status/n8sbo1ay6wr2xxyc/branch/master?svg=true)](https://ci.appveyor.com/project/xforever1313/chaskis/branch/master)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/92071784a63e4d6ba070cb88c1b6c99f)](https://www.codacy.com/app/xforever1313/Chaskis?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=xforever1313/Chaskis\u0026amp;utm_campaign=Badge_Grade)\n\nPackages\n--------------\n\n[![NuGet](https://img.shields.io/nuget/v/ChaskisCore.svg)](https://www.nuget.org/packages/ChaskisCore/)\n[![Chocolatey](https://img.shields.io/chocolatey/v/chaskis.svg)](https://chocolatey.org/packages/chaskis/)\n[![AUR](https://img.shields.io/aur/version/chaskis.svg)](https://aur.archlinux.org/packages/chaskis/)\n\nDocker Images\n--------------\n\n[![Windows](https://img.shields.io/docker/v/xforever1313/chaskis.windows?label=Windows\u0026style=flat-square)](https://hub.docker.com/r/xforever1313/chaskis.windows)\n[![Ubuntu](https://img.shields.io/docker/v/xforever1313/chaskis.ubuntu?label=Ubuntu\u0026style=flat-square)](https://hub.docker.com/r/xforever1313/chaskis.ubuntu)\n[![Raspbian](https://img.shields.io/docker/v/xforever1313/chaskis.raspbian?label=Raspbian\u0026style=flat-square)](https://hub.docker.com/r/xforever1313/chaskis.raspbian)\n\nAbout\n--------\nChaskis is a framework for creating IRC Bots in an easy way.  It is a plugin-based architecture written in C# that can be run on Windows or Linux.  Users of the bot can add or remove plugins to run, or even write their own.\n\nChaskis is named after the [Chasqui](https://en.wikipedia.org/wiki/Chasqui), messengers who ran trails in the Inca Empire to deliver messages.\n\nLive Demo\n---------\n\nYou can talk to chaskisbot in our IRC channel on [Libera.chat](https://web.libera.chat/?channels=chaskis) (#chaskis @ irc.libera.chat).  Also, feel free to ask any questions there, someone will answer your questions as soon as possible.\n\nYou can also join our [Telegram Group](https://t.me/ChaskisIrc).  This is bridged with the same IRC channel that has chaskisbot in it, so you'll be able to talk with anyone in the IRC channel as well.\n\nInstall Instructions\n----------------------\n\n### Windows ###\nRun the Windows [installer](https://files.shendrick.net/projects/chaskis/releases/latest/windows/ChaskisInstaller.msi).  This will install Chaskis to ```C:\\Program Files\\Chaskis```.  The service will also be installed but NOT enabled.\n\nYou can also install via [chocolatey](https://chocolatey.org/packages/chaskis/) by running ```choco install chaskis```.\n\n### Linux ###\n\n * **Arch** - Install with the AUR: ```yaourt -S chaskis```.  There is a dependency of the dotnet runtime\n * **Debian** - [Install](https://docs.microsoft.com/en-us/dotnet/core/install/linux) an up-to-date version of the dotnet core runtime, and install the [.deb file](https://files.shendrick.net/projects/chaskis/releases/latest/debian/chaskis.deb).\n\nConfiguration\n---------------\nOnce Chaskis is installed, run ```Chaskis.exe --bootstrap``` to create an empty configuration in side of your Application Data folder.  On Windows, this is ```C:\\Users\\you\\AppData\\Roaming\\Chaskis```.  On Linux, this is ```/home/you/.config/Chaskis```.  If you wish to install a default config else where, specify that in the ```--chaskisroot argument``` (e.g. ```Chaskis.exe --bootstrap --chaskisroot=/home/you/chakisconfig```).\n\nNote, if running Chaskis as a Service, you MUST store your user's configuration in the Application Data folder.\n\nAfter running Chaskis.exe with the bootstrap argument, default configurations will appear in the folder.  They are XML Files, and their instructions live as comments in those files.  Plugin configuration lives in the Plugins folder.\n\nRunning\n---------------\n### Chaskis.exe ###\n\nThere are two ways to run Chaskis.  The first is with ```Chaskis.exe```. By default, this will look for configuration in your Application Data folder, but you can override this by passing in the ```--chaskisroot``` argument (e.g. ```Chaskis.exe --chaskisroot=/home/you/chakisconfig```).  You can run multiple instances of Chaskis.exe per user this way.  Running Chaskis in a tool such as tmux or screen an keep it running in the background.\n\n### ChaskisService.exe ###\n\nThe other way to run Chaskis is by the service.  The advantage of a service is you can tell Chaskis to run when your system starts up.  The disadvantage is you can only have on configuration per user, which lives in the user's Application Data folder.\n\n* [Windows Instructions](https://github.com/xforever1313/Chaskis/wiki/Running-as-a-Windows-Service)\n* [Linux Instructions](https://github.com/xforever1313/Chaskis/wiki/Running-as-a-Linux-Service)\n* [Docker Instructions](https://github.com/xforever1313/Chaskis/wiki/Running-with-Docker)\n\nWriting Plugins\n----------------\n\nVisit our Wiki page [here](https://github.com/xforever1313/Chaskis/wiki/Writing-Plugins).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxforever1313%2Fchaskis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxforever1313%2Fchaskis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxforever1313%2Fchaskis/lists"}