factotum


Namefactotum JSON
Version 0.1.6 PyPI version JSON
download
home_pagehttps://github.com/Denubis/factotum
SummaryA tool to control a headless factorio server.
upload_time2017-01-21 05:40:16
maintainer
docs_urlNone
authorBrian Ballsun-Stanton
requires_python
licenseGPLv3
keywords factorio rcon headless
VCS
bugtrack_url
requirements require-python-3
Travis-CI No Travis.
coveralls test coverage
            # A Factotum for Headless Factorio!
A python manager to deploy and run headless factorio servers.
By: Brian Ballsun-Stanton, Andrew Ardill, and James Zhao

Released under the GPL v3 License, 2016.
No warranty of any kind, folks.

## Installation:

### On ubuntu 14.04/16.04:

```sudo apt update && sudo apt install python3-pip -y && echo /opt/factorio > $HOME/.factorioPath && sudo pip3 install factotum && factotum fulldeploy && source $HOME/.bashrc```	

### On other systems:

```sudo pip3 install factotum```

## Usage:

* `factotum --help`
   * This provides all Factory Factotum commands.
* `factotum COMMAND --help`
   * This provides help for each Factory Factotum command.

* `factotum fulldeploy`
   * Runs install, authenticate, newmap, setup.
* `factotum install`
	* Installs factorio (default /opt/factorio, override with a new path in ~/.factorioPath)
* `factotum authenticate --username <Username>`
	* Gets your authentication token from factorio servers so your password isn't stored in plaintext.
* `factotum newmap`
	* Generates a new map from a config file in FACTORIOHOME/config/mapsettings.json
* `factotum setup --servername "Server Name Here" --description "Server Description Here" --tag "Tag 1" --tag "Tag n"`
	* Configures the settings.json file including setting a password of 4 diceware words.
* `factotum factorio start`
   * This starts the factorio headless server in daemon mode with latest save.
* `factotum factorio stop`
   * This asks the headless server to stop. Politely. It will take some time and will likely report failed.
* `factotum factorio status`
   * This reports on the status of the server.      
* `factotum rcon /help`
   * This sends commands into an already running server started by factotum.         



            

Raw data

            {
    "_id": null,
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "cheesecake_code_kwalitee_id": null,
    "keywords": "factorio rcon headless",
    "upload_time": "2017-01-21 05:40:16",
    "requirements": [
        {
            "name": "require-python-3",
            "specs": []
        }
    ],
    "author": "Brian Ballsun-Stanton",
    "home_page": "https://github.com/Denubis/factotum",
    "github_user": "Denubis",
    "download_url": "https://pypi.python.org/packages/8c/51/7493ab0f9030f22ad5ceaa7c5eb7095a6ef57c926fb7e32816403025cb27/factotum-0.1.6.tar.gz",
    "platform": "",
    "version": "0.1.6",
    "cheesecake_documentation_id": null,
    "description": "# A Factotum for Headless Factorio!\nA python manager to deploy and run headless factorio servers.\nBy: Brian Ballsun-Stanton, Andrew Ardill, and James Zhao\n\nReleased under the GPL v3 License, 2016.\nNo warranty of any kind, folks.\n\n## Installation:\n\n### On ubuntu 14.04/16.04:\n\n```sudo apt update && sudo apt install python3-pip -y && echo /opt/factorio > $HOME/.factorioPath && sudo pip3 install factotum && factotum fulldeploy && source $HOME/.bashrc```\t\n\n### On other systems:\n\n```sudo pip3 install factotum```\n\n## Usage:\n\n* `factotum --help`\n   * This provides all Factory Factotum commands.\n* `factotum COMMAND --help`\n   * This provides help for each Factory Factotum command.\n\n* `factotum fulldeploy`\n   * Runs install, authenticate, newmap, setup.\n* `factotum install`\n\t* Installs factorio (default /opt/factorio, override with a new path in ~/.factorioPath)\n* `factotum authenticate --username <Username>`\n\t* Gets your authentication token from factorio servers so your password isn't stored in plaintext.\n* `factotum newmap`\n\t* Generates a new map from a config file in FACTORIOHOME/config/mapsettings.json\n* `factotum setup --servername \"Server Name Here\" --description \"Server Description Here\" --tag \"Tag 1\" --tag \"Tag n\"`\n\t* Configures the settings.json file including setting a password of 4 diceware words.\n* `factotum factorio start`\n   * This starts the factorio headless server in daemon mode with latest save.\n* `factotum factorio stop`\n   * This asks the headless server to stop. Politely. It will take some time and will likely report failed.\n* `factotum factorio status`\n   * This reports on the status of the server.      \n* `factotum rcon /help`\n   * This sends commands into an already running server started by factotum.         \n\n\n",
    "lcname": "factotum",
    "name": "factotum",
    "github": true,
    "bugtrack_url": null,
    "license": "GPLv3",
    "travis_ci": false,
    "github_project": "factotum",
    "summary": "A tool to control a headless factorio server.",
    "split_keywords": [
        "factorio",
        "rcon",
        "headless"
    ],
    "author_email": "factorio@drbbs.org",
    "urls": [
        {
            "has_sig": true,
            "upload_time": "2017-01-21T05:40:25",
            "comment_text": "",
            "python_version": "3.5",
            "url": "https://pypi.python.org/packages/93/c3/d9037a333771885864f1303815b9d424788bc56ae6bdf3ed0f971340925d/factotum-0.1.6-py3-none-any.whl",
            "md5_digest": "708687bdb43dfb3ef610a410baa8d9a3",
            "downloads": 0,
            "filename": "factotum-0.1.6-py3-none-any.whl",
            "packagetype": "bdist_wheel",
            "path": "93/c3/d9037a333771885864f1303815b9d424788bc56ae6bdf3ed0f971340925d/factotum-0.1.6-py3-none-any.whl",
            "size": 48222
        },
        {
            "has_sig": true,
            "upload_time": "2017-01-21T05:40:20",
            "comment_text": "",
            "python_version": "3.5",
            "url": "https://pypi.python.org/packages/2f/17/1f292fb07dde433cb176c786c64d8eb6ab43cd6304a2d21561ad304a04c3/factotum-0.1.6-py3.5.egg",
            "md5_digest": "76cefaa8bfb2f7c76890e078e0526fce",
            "downloads": 0,
            "filename": "factotum-0.1.6-py3.5.egg",
            "packagetype": "bdist_egg",
            "path": "2f/17/1f292fb07dde433cb176c786c64d8eb6ab43cd6304a2d21561ad304a04c3/factotum-0.1.6-py3.5.egg",
            "size": 57512
        },
        {
            "has_sig": true,
            "upload_time": "2017-01-21T05:40:16",
            "comment_text": "",
            "python_version": "source",
            "url": "https://pypi.python.org/packages/8c/51/7493ab0f9030f22ad5ceaa7c5eb7095a6ef57c926fb7e32816403025cb27/factotum-0.1.6.tar.gz",
            "md5_digest": "8c1af810c5ba5028e6ba6abd63f5feb9",
            "downloads": 0,
            "filename": "factotum-0.1.6.tar.gz",
            "packagetype": "sdist",
            "path": "8c/51/7493ab0f9030f22ad5ceaa7c5eb7095a6ef57c926fb7e32816403025cb27/factotum-0.1.6.tar.gz",
            "size": 45634
        }
    ],
    "cheesecake_installability_id": null,
    "coveralls": true
}
        
Elapsed time: 0.03276s