README.md

starcheat ) )

starcheat is a Starbound player save editor, you can get free pixels with this! (omg)

Downloads

Starbound	starcheat
Nightly	dev branch
Upbeat Giraffe	0.19
Enraged Koala	0.17

Reporting a Issue

Please read and follow these instructions when reporting an issue. This will help us fix your issue faster, because we don't need to ask you for additional informations.

Building from source

Here is how to build starcheat from source. Make sure everything in the dependencies section is installed before you do a build.

Dependencies

• Python 3.3+
• PyQt5
• Qt 5 (included in PyQt5 binaries on Windows)
• Pillow
• py-starbound

NOTE: py-starbound is included as a git submodule and needs to be cloned with the following commands:

• cd <starcheat top folder>
• git submodule sync
• git submodule update --init

Applications such as Sourcetree should offer to clone it automatically.

Windows

Lines starting with > can be run in PowerShell or cmd.exe.

• > cd <starcheat top folder>
• > C:\Python33\python.exe .\build.py
• Browse to newly created build\ folder
• Double click starcheat.py

Standalone Build

The standalone build makes an executable which includes all Python and Qt dependencies.

• Install cx_freeze
• > cd <starcheat top folder>
• > C:\Python33\python.exe .\build.py -e
• Browse to newly created dist\ folder
• Double click starcheat.exe

Linux

$ cd <starcheat top folder>
$ ./build.py
$ ./build/starcheat.py

• Arch Linux (AUR)

Mac

Install

• Install homebrew
• $ brew update
• $ brew tap chrmoritz/starcheat
• $ brew install starcheat (optionally pass --without-app to not create a .app)
• brew linkapps starcheat (symlinks the .app into your Applications folder)

Update

• $ brew update (check if starcheat is in the updated formula list)
• $ brew upgrade starcheat (if its in the list above or in brew outdated)

Release checklist

• Update version string in config.py
• Update version string in starcheat tap's brew file
• Update storage name in config.py and assets.py
• Tag release