Metadata-Version: 2.4
Name: ellinetircd
Version: 1.4.0.dev2
Summary: ElliNetIRCd - an asynchronous IRC server
Home-page: https://github.com/ElliNet13/ElliNetIRCd
Download-URL: https://pypi.org/project/ellinetircd/
Author: ElliNet13
Author-email: ellinetircd@ellinet13.com
License: GPL-3.0-or-later
Project-URL: Wiki, https://github.com/ElliNet13/ElliNetIRCd/wiki
Project-URL: Issues, https://github.com/ElliNet13/ElliNetIRCd/issues
Classifier: Environment :: No Input/Output (Daemon)
Classifier: Framework :: AsyncIO
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Communications :: Chat :: Internet Relay Chat
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: trio
Requires-Dist: lupa
Requires-Dist: pyyaml
Dynamic: download-url
Dynamic: license-file

ElliNetIRCd
=======

A python asynchronous IRC server based on aioirc.

### Installation and Usage

Download and install the latest stable version using pip.
```bash
python -m pip install ellinetircd
```

Then run the server:
```bash
HOST=0.0.0.0 LOGLEVEL=INFO python -m ellinetircd
```
If you are using powershell you can use the following command:
```powershell
$env:HOST="0.0.0.0"
$env:LOGLEVEL="INFO"
python -m ellinetircd
```

For other env vars check `python -m ellinetircd --help`.

## Plugins
As of v1.1.0 there is now support for plugins!
As of v1.2.0 there is now support for other languages then python!
Check the test plugins for example plugins.

### Supported plugin types
These are all supported plugins, if it is checked then it has been fully added, if its not checked it is still in dev.
- [x] Language support plugins (LANGUAGE) [As of v1.2.0]
- [x] Command plugins (COMMAND) [As of v1.1.0]
- [x] Generic plugins (GENERIC) [As of v1.2.0]

### Supported plugin languages
These are all supported plugins languages, if it is checked then it has been fully added, if its not checked it is still in dev.
- [x] Python [As of v1.1.0]
- [x] Lua [As of v1.2.0]

### Important notes
- Lua does not support async functions yet. (Setup in lua gets a wrapper function to make it async.)
- Lua can not be used to make a bot. (Due to missing async.)

### Plugin search paths
- ./plugins
- ellinetircd.core_plugins
- ellinetircd.test_plugins (if logging is set to debug)
