Skip to content

RigglePrime/SS13-tools

Repository files navigation

SS13 tools

PyLint Flake8 Build

A set of tools to help with automating tasks for the /tg/ branch of SS13.

If you're looking for LogBuddy help, click here

Made for Python 3.9+

How to run

Github Codespaces

Click the following button to open a codespace with ss13tools in your browser:

Open in GitHub Codespaces

Windows

Download the executable here

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

Docker

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, comes as a script centcom
  • log_downloader: downloads logs from tg's parsed logs
  • LogBuddy, 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

Downloading

For compiled versions, see this link.

If the above link is giving you trouble, try installing it with pip.

  1. Download python from here
  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!

If you know your way around python, you may try using PyPy for faster performance.