# SS13 tools
[](https://github.com/RigglePrime/SS13-tools/actions/workflows/pylint.yml)
[](https://github.com/RigglePrime/SS13-tools/actions/workflows/flake8-lint.yml)
[](https://github.com/RigglePrime/SS13-tools/actions/workflows/publish.yml)
A set of tools to help with automating tasks for the /tg/ branch of SS13.
If you're looking for LogBuddy help, click [here](https://github.com/RigglePrime/SS13-tools/tree/master/ss13_tools/log_buddy/README.md)
Made for Python 3.9+
## How to run
### Github Codespaces
Click the following button to open a codespace with ss13tools in your browser:
[](https://codespaces.new/RigglePrime/SS13-tools)
### Windows
Download the executable [here](https://github.com/RigglePrime/SS13-tools/releases/latest)
### pip
`pip install ss13-tools; ss13tools` (or pip3 on some linux distributions)
If the latter is giving you trouble, try the former. Python can be installed [here](https://www.python.org/downloads/)
### Docker
```bash
docker run --rm -it ghcr.io/riggleprime/ss13tools
# Or to run a specific command (for example, logbuddy)
docker run --rm -it ghcr.io/riggleprime/ss13tools logbuddy
# If you need access to any local files, you'll want to mount a volume as well
docker run --rm -it -v ./directory:/directory ghcr.io/riggleprime/ss13tools logbuddy
```
Alternatively, you can open the `devcontainer.json` with your code editor of choice, if supported (namely, Visual Studio Code)
Remember, if you ever screw an input up try pressing the up arrow.
## Contents
- Root script that displays all options: `ss13tools`
- auth: authenticate and download from raw logs
- byond: tools for working with BYOND, such as checking if a ckey exists
- [centcom](https://centcom.melonmesa.com/), comes as a script `centcom`
- log_downloader: downloads logs from tg's [parsed logs](https://tgstation13.org/parsed-logs)
- [LogBuddy](https://github.com/RigglePrime/SS13-tools/tree/master/ss13_tools/log_buddy/README.md), comes as a script `logbuddy`
- scrubby: scrubby tools
- slur_detector: what it says on the tin
For examples on how to use please see [this file](https://github.com/RigglePrime/SS13-tools/tree/master/ss13_tools/menu.py)
## Downloading
For compiled versions, see [this link](https://github.com/RigglePrime/admin-tools/releases).
If the above link is giving you trouble, try installing it with `pip`.
1. Download python from [here](https://www.python.org/downloads/)
2. Install, make sure to check "add to environment variables" or "add to PATH", and use `py` launcher
3. Run `pip install ss13-tools`. If this is giving you trouble, try logging out and back in.
4. Run `ss13tools` or `logbuddy` directly
Now also available on [PyPi](https://pypi.org/project/ss13-tools/)!
If you know your way around python, you may try using [PyPy](https://www.pypy.org/) for faster performance.
Raw data
{
"_id": null,
"home_page": "https://github.com/RigglePrime/SS13-tools",
"name": "SS13-tools",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.8.10",
"maintainer_email": null,
"keywords": "ss13, tgstation",
"author": "RigglePrime",
"author_email": "27156122+RigglePrime@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/06/ba/ef36b0f3be59fe91134646cfdb8afe192cffd9553e20be00ee2ea5710104/ss13_tools-2.4.1.tar.gz",
"platform": null,
"description": "# SS13 tools\n\n[](https://github.com/RigglePrime/SS13-tools/actions/workflows/pylint.yml)\n[](https://github.com/RigglePrime/SS13-tools/actions/workflows/flake8-lint.yml)\n[](https://github.com/RigglePrime/SS13-tools/actions/workflows/publish.yml)\n\nA set of tools to help with automating tasks for the /tg/ branch of SS13.\n\nIf you're looking for LogBuddy help, click [here](https://github.com/RigglePrime/SS13-tools/tree/master/ss13_tools/log_buddy/README.md)\n\nMade for Python 3.9+\n\n## How to run\n\n### Github Codespaces\n\nClick the following button to open a codespace with ss13tools in your browser:\n\n[](https://codespaces.new/RigglePrime/SS13-tools)\n\n### Windows\n\nDownload the executable [here](https://github.com/RigglePrime/SS13-tools/releases/latest)\n\n### pip\n\n`pip install ss13-tools; ss13tools` (or pip3 on some linux distributions)\n\nIf the latter is giving you trouble, try the former. Python can be installed [here](https://www.python.org/downloads/)\n\n### Docker\n\n```bash\ndocker run --rm -it ghcr.io/riggleprime/ss13tools\n\n# Or to run a specific command (for example, logbuddy)\n\ndocker run --rm -it ghcr.io/riggleprime/ss13tools logbuddy\n\n# If you need access to any local files, you'll want to mount a volume as well\n\ndocker run --rm -it -v ./directory:/directory ghcr.io/riggleprime/ss13tools logbuddy\n```\n\nAlternatively, you can open the `devcontainer.json` with your code editor of choice, if supported (namely, Visual Studio Code)\n\nRemember, if you ever screw an input up try pressing the up arrow.\n\n## Contents\n\n- Root script that displays all options: `ss13tools`\n- auth: authenticate and download from raw logs\n- byond: tools for working with BYOND, such as checking if a ckey exists\n- [centcom](https://centcom.melonmesa.com/), comes as a script `centcom`\n- log_downloader: downloads logs from tg's [parsed logs](https://tgstation13.org/parsed-logs)\n- [LogBuddy](https://github.com/RigglePrime/SS13-tools/tree/master/ss13_tools/log_buddy/README.md), comes as a script `logbuddy`\n- scrubby: scrubby tools\n- slur_detector: what it says on the tin\n\nFor examples on how to use please see [this file](https://github.com/RigglePrime/SS13-tools/tree/master/ss13_tools/menu.py)\n\n## Downloading\n\nFor compiled versions, see [this link](https://github.com/RigglePrime/admin-tools/releases).\n\nIf the above link is giving you trouble, try installing it with `pip`.\n\n1. Download python from [here](https://www.python.org/downloads/)\n2. Install, make sure to check \"add to environment variables\" or \"add to PATH\", and use `py` launcher\n3. Run `pip install ss13-tools`. If this is giving you trouble, try logging out and back in.\n4. Run `ss13tools` or `logbuddy` directly\n\nNow also available on [PyPi](https://pypi.org/project/ss13-tools/)!\n\nIf you know your way around python, you may try using [PyPy](https://www.pypy.org/) for faster performance.\n",
"bugtrack_url": null,
"license": null,
"summary": "Python toolchain for SS13",
"version": "2.4.1",
"project_urls": {
"Homepage": "https://github.com/RigglePrime/SS13-tools",
"Repository": "https://github.com/RigglePrime/SS13-tools"
},
"split_keywords": [
"ss13",
" tgstation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8eed61ade97dd78bcb6a5796f4597ee3cf231f0d7e88b4ae36453ac9c7cae2d8",
"md5": "63da8bfc5eb51a2caf5989971efbd9e3",
"sha256": "9730f87d82229dc130eab38dab8cd6e9a611e2dff3043523f825423713763b77"
},
"downloads": -1,
"filename": "ss13_tools-2.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "63da8bfc5eb51a2caf5989971efbd9e3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.8.10",
"size": 81050,
"upload_time": "2024-03-26T04:22:24",
"upload_time_iso_8601": "2024-03-26T04:22:24.879077Z",
"url": "https://files.pythonhosted.org/packages/8e/ed/61ade97dd78bcb6a5796f4597ee3cf231f0d7e88b4ae36453ac9c7cae2d8/ss13_tools-2.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "06baef36b0f3be59fe91134646cfdb8afe192cffd9553e20be00ee2ea5710104",
"md5": "ee060fc413a70bbfdead50ec1409b34f",
"sha256": "ff9314ad9f1bb8ccc69733dac23903d4ff09e3991e24f91e0639b0d91f215f4a"
},
"downloads": -1,
"filename": "ss13_tools-2.4.1.tar.gz",
"has_sig": false,
"md5_digest": "ee060fc413a70bbfdead50ec1409b34f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.8.10",
"size": 67100,
"upload_time": "2024-03-26T04:22:26",
"upload_time_iso_8601": "2024-03-26T04:22:26.645439Z",
"url": "https://files.pythonhosted.org/packages/06/ba/ef36b0f3be59fe91134646cfdb8afe192cffd9553e20be00ee2ea5710104/ss13_tools-2.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-26 04:22:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RigglePrime",
"github_project": "SS13-tools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ss13-tools"
}
JSON
