{ "info": { "author": "Micka\u00ebl Thomas", "author_email": "mickael9@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3 :: Only", "Topic :: Communications :: Chat :: Internet Relay Chat", "Topic :: Games/Entertainment" ], "description": "========\nFactoIRC\n========\n\nFactoIRC is a bidirectional IRC bridge between Factorio and IRC.\nIt comes as a plugin for the irc3_ python module.\n\nIt can join one or more channels and forward messages back and forth between IRC and Factorio.\n\nSome IRC commands are also provided :\n\n- **!rcon**: Execute an RCON command and return the result.\n- **!players**: Get the list of the currently online players.\n\nFactoIRC uses the RCON protocol introduced in Factorio 0.13 to forward messages from IRC to Factorio.\nAs a result, FactoIRC **will not work with Factorio 0.12** and earlier versions.\n\nForwarding Factorio chat messages to IRC requires access to the Factorio server output which can be achieved using several methods depending on your setup.\n\nCompatibility\n-------------\n\n*On Windows, forwarding in the IRC -> Factorio direction is only supported starting from Factorio 0.15 and using the console log* (`--console-log`)\n: https://forums.factorio.com/viewtopic.php?f=49&t=37108.\n\nJoin/leave messages should work with Factorio 0.13 but are broken in 0.14 (https://forums.factorio.com/viewtopic.php?f=6&t=30697).\nFactorio 0.15 brings them back.\n\nInstallation\n------------\n\nYou'll need to have Python 3.5 (or later) which can be obtained through your distribution's package manager\nor downloaded from https://www.python.org/ (for Windows users).\n\nOn Windows, make sure to check the *\"Add Python 3.x to PATH\"* checkbox when installing.\n\nOnce Python is installed, FactoIRC can be installed using\n\n.. code:: bash\n\n $ pip3 install factoirc\n\nConfiguration\n-------------\n\nConfiguration is done using the `config.ini` file. A config.example.ini_ file is provided as an example and contains extensive documentation.\n\nDepending on your setup, you will have to use one of the `file`, `stdin` or `systemd` methods.\n\nMethod 1: `file` (recommended)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThis method reads the Factorio chat from a console log.\n\n.. code:: ini\n\n [factoirc]\n method = file\n file = console.log\n\nThe console log can be generated using `--console-log` in Factorio 0.15:\n\n.. code:: bash\n\n $ factorio --rcon-port=27015 --rcon-password=password --start-server=save.zip --console-log=console.log\n\nFor Factorio < 0.15, you can redirect the Factorio output to a file to achieve the same behavior (`doesn't work on Windows `_):\n\n.. code:: bash\n\n $ factorio --rcon-port=27015 --rcon-password=password --start-server=save.zip > console.log\n\nfactorio-init_ users can also use the `server.out` file as input.\nNote that the systemd service for `factorio-init` does not save the output into the journal, so you can't use the `systemd` method with it.\n\n**Warning:** do *not* use the `factorio-current.log` file created by Factorio. It does not contain the chat log.\n\nMethod 2: `systemd` journal\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThis method applies only if your Factorio server runs under systemd (only for Linux machines) and its output is stored in the journal.\n\nIn this case, FactoIRC can directly read the log from the journal.\n\nYou'll need the following options in your configuration file:\n\n.. code:: ini\n\n [factoirc]\n method = systemd\n unit = factorio.service\n\nFor this method to work, the `python-systemd` module is required and can be installed via pip:\n\n.. code:: bash\n\n $ pip3 install python-systemd\n\nMethod 3: `stdin`\n~~~~~~~~~~~~~~~~~\n\nThis method reads the Factorio chat log from the standard input stream, it also supports reading from a file via shell redirection.\n\n.. code:: ini\n\n [factoirc]\n method = stdin\n\nYou will need to connect the Factorio chat log output to the FactoIRC bot:\n\n.. code:: bash\n\n $ factorio --rcon-port=27015 --rcon-password=password --start-server=save.zip | irc3 config.ini\n\n\nForwarding customization\n~~~~~~~~~~~~~~~~~~~~~~~~\n\nYou can customize the forwarding of messages for the different game and irc actions, see config.example.ini_ for more information.\n\nRunning\n-------\n\nTo run FactoIRC, you just need to use the `irc3` command with a FactoIRC-enabled config file (see config.example.ini_)\n\n.. code:: bash\n\n $ irc3 config.ini\n\n`irc3` can be started with the ``-v`` flag to show more log messages (including those generated by FactoIRC).\n\nIRC raw traffic can be shown with ``-r``.\n\nTry ``irc3 -h`` for the full list of options.\n\n.. _irc3: https://irc3.readthedocs.io/\n.. _config.example.ini: config.example.ini\n.. _factorio-init: https://github.com/Bisa/factorio-init\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/mickael9/factoirc", "keywords": "factorio irc", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "factoirc", "package_url": "https://pypi.org/project/factoirc/", "platform": "", "project_url": "https://pypi.org/project/factoirc/", "project_urls": { "Homepage": "https://github.com/mickael9/factoirc" }, "release_url": "https://pypi.org/project/factoirc/0.6/", "requires_dist": null, "requires_python": "", "summary": "Bidirectional IRC bridge for Factorio", "version": "0.6" }, "last_serial": 2879053, "releases": { "0.2": [ { "comment_text": "", "digests": { "md5": "d364cf2beababe73cf0161ccd07e0edc", "sha256": "d8b73d83e2e899cc311d7b8fc21bfdb818d265f232b7ce4ee58721ca74e7f2dc" }, "downloads": -1, "filename": "factoirc-0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "d364cf2beababe73cf0161ccd07e0edc", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8142, "upload_time": "2016-07-14T15:58:17", "url": "https://files.pythonhosted.org/packages/3e/55/208f30cd69e3942093bab8a5c375c4fb9f68551e8c795dbd5c48d332217c/factoirc-0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4ac3bf146c93b82eea699bbd3fb9b2f6", "sha256": "997de06a8b9c00a3336c9358257a354b51b680d420b9db2d6ddd944726102bd3" }, "downloads": -1, "filename": "factoirc-0.2.tar.gz", "has_sig": false, "md5_digest": "4ac3bf146c93b82eea699bbd3fb9b2f6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7184, "upload_time": "2016-07-14T15:57:20", "url": "https://files.pythonhosted.org/packages/65/8d/4be3c206feddd66d6f7a0c788976002d0b2313373222849d2ea9c34f5661/factoirc-0.2.tar.gz" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "0efdad9e8e94223a51d4df69a4be90dd", "sha256": "f8eed7c0f3b547548516d04d1302d93ce3d0aeb3d3de4adbaa45a222f11ccd5a" }, "downloads": -1, "filename": "factoirc-0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "0efdad9e8e94223a51d4df69a4be90dd", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8999, "upload_time": "2016-07-14T20:39:05", "url": "https://files.pythonhosted.org/packages/0c/f0/855a74a063529e056c7ac2bd3c4e542603ca5746fdd2895a71382a23b479/factoirc-0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "519eded0e2c75345396a4b3824108d4c", "sha256": "99278365351720e75bfdb3e0ac1e57c4562e629fae89bf79c04792cff36b7455" }, "downloads": -1, "filename": "factoirc-0.3.tar.gz", "has_sig": false, "md5_digest": "519eded0e2c75345396a4b3824108d4c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7788, "upload_time": "2016-07-14T20:38:51", "url": "https://files.pythonhosted.org/packages/a8/a0/c8b46316798072d9d8313d98110d35f74c1a47d3f4ab3a8be4976d0589c8/factoirc-0.3.tar.gz" } ], "0.4": [ { "comment_text": "", "digests": { "md5": "d322d31ffdcda6010155363513d3d928", "sha256": "88c58c2cbef3ebfcfc226ca13b1a7a6204029aec5ed61c1b8be12e2a8b1c9f48" }, "downloads": -1, "filename": "factoirc-0.4-py3-none-any.whl", "has_sig": false, "md5_digest": "d322d31ffdcda6010155363513d3d928", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9094, "upload_time": "2016-07-20T23:28:30", "url": "https://files.pythonhosted.org/packages/3d/2c/26be81e0e13fdfff29c5461c7504b164bd016cc7db5afe678222ae9235ce/factoirc-0.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c25b3019c93b39b4fd01fa023335b69f", "sha256": "48f691ef273382572a75bfec093db36c4f269ce9d9a22f3c7af638fd562982e3" }, "downloads": -1, "filename": "factoirc-0.4.tar.gz", "has_sig": false, "md5_digest": "c25b3019c93b39b4fd01fa023335b69f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7873, "upload_time": "2016-07-20T23:28:38", "url": "https://files.pythonhosted.org/packages/28/01/a085f0885b10fbe966c304b73ce32c780bc3b2e237e7406ffd37cd9477ca/factoirc-0.4.tar.gz" } ], "0.5": [ { "comment_text": "", "digests": { "md5": "3348fb38989dab88c6f9ba20f6346c26", "sha256": "468ce45f54d44a84cfcdde943fb1baa0710f0d65ae6d082dbe4a5df81edb1c35" }, "downloads": -1, "filename": "factoirc-0.5-py3-none-any.whl", "has_sig": false, "md5_digest": "3348fb38989dab88c6f9ba20f6346c26", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 9251, "upload_time": "2016-07-23T16:49:13", "url": "https://files.pythonhosted.org/packages/c2/07/7120b8f06c2fb07c45bc39133a60470c985d2691b8a9b329c7084f9a4eb5/factoirc-0.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f36953ff21ca66dd107d90aa0f2d09b8", "sha256": "955ce51462233e4fdeb011789eb202cde6f56d4fe513694dc72165a36590ccaa" }, "downloads": -1, "filename": "factoirc-0.5.tar.gz", "has_sig": false, "md5_digest": "f36953ff21ca66dd107d90aa0f2d09b8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8002, "upload_time": "2016-07-23T16:49:10", "url": "https://files.pythonhosted.org/packages/dc/5a/1f0ce379b4cb8bcdaff990cbca9756892d80e6a24adb670c2e26e9634a0e/factoirc-0.5.tar.gz" } ], "0.6": [ { "comment_text": "", "digests": { "md5": "d06c7761548f361cc383a74da01396e5", "sha256": "d10f85cadce6abeb1d1087d5fa993951b4919d02e6e0bc9f1f49ceb2d50148d3" }, "downloads": -1, "filename": "factoirc-0.6-py3-none-any.whl", "has_sig": false, "md5_digest": "d06c7761548f361cc383a74da01396e5", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 13685, "upload_time": "2017-05-16T20:14:05", "url": "https://files.pythonhosted.org/packages/8f/d2/a259e3a86b8558147ab5f08ad027298f701f5fcf55b87daf0b20f3244a26/factoirc-0.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "541563f761800bc3196eb8550dddbaed", "sha256": "1e4301244c3254085e2bbdc17390925b9fa499dc0f7da311518079e9252a2d1b" }, "downloads": -1, "filename": "factoirc-0.6.tar.gz", "has_sig": false, "md5_digest": "541563f761800bc3196eb8550dddbaed", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12349, "upload_time": "2017-05-16T20:14:02", "url": "https://files.pythonhosted.org/packages/e0/18/7a5ca1eb6f5074d2bfd0f5659ddbcf4e375c8ffd691bd15ef4306c2fa18c/factoirc-0.6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d06c7761548f361cc383a74da01396e5", "sha256": "d10f85cadce6abeb1d1087d5fa993951b4919d02e6e0bc9f1f49ceb2d50148d3" }, "downloads": -1, "filename": "factoirc-0.6-py3-none-any.whl", "has_sig": false, "md5_digest": "d06c7761548f361cc383a74da01396e5", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 13685, "upload_time": "2017-05-16T20:14:05", "url": "https://files.pythonhosted.org/packages/8f/d2/a259e3a86b8558147ab5f08ad027298f701f5fcf55b87daf0b20f3244a26/factoirc-0.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "541563f761800bc3196eb8550dddbaed", "sha256": "1e4301244c3254085e2bbdc17390925b9fa499dc0f7da311518079e9252a2d1b" }, "downloads": -1, "filename": "factoirc-0.6.tar.gz", "has_sig": false, "md5_digest": "541563f761800bc3196eb8550dddbaed", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12349, "upload_time": "2017-05-16T20:14:02", "url": "https://files.pythonhosted.org/packages/e0/18/7a5ca1eb6f5074d2bfd0f5659ddbcf4e375c8ffd691bd15ef4306c2fa18c/factoirc-0.6.tar.gz" } ] }