resetti

command module
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 8, 2023 License: GPL-3.0 Imports: 6 Imported by: 0

README

resetti

resetti is a Linux-compatible reset macro for Minecraft speedruns. It supports a variety of different resetting styles, categories, and Minecraft versions.

Installation

There are currently no distribution-specific packages available.

From source

If you have Go installed, you can install from source:

env CGO_ENABLED=0 go install github.com/woofdoggo/resetti@latest -ldflags="-s -w"
From binary

You can download the latest version from the Releases tab and place it somewhere on your $PATH. All binaries are statically linked and built for AMD64 (x86-64) systems.

Usage

You can refer to the documentation for detailed usage instructions:

Please report any bugs which you encounter. resetti is still beta software and is not guaranteed to work.

Features

  • Single- and multi-instance support
  • Wall-style resetting
    • Reset all instances
    • Reset an instance
    • Play an instance and reset all others
    • Play an instance
    • Lock an instance
    • Instance stretching for better visibility
    • Mouse support for quicker resetting
  • Lock instances to specific cores (affinity) for performance
  • Supports 1.14+ (Atum required)
  • Run with or without WorldPreview
  • Multi-version support
    • Reset with multiple different versions at once
  • OBS integration
    • Automatically switch OBS scenes
    • Simple setup wizard for generating OBS scene collections

Contributing

Contributions are welcome.

  • Please use proper English for documentation and code comments.
  • Ensure that code changes are properly formatted with go fmt ./....
  • Perform at least some testing before submitting code changes within a PR.
  • Try to keep lines wrapped at roughly 80 columns where possible.

License

resetti is licensed under the GNU General Public License v3 ONLY, no later version. You can view the full license here.

Prior Art

  • Wall
    • jojoe, for creating the wall
    • MultiResetWall by Specnr and contributors

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
internal
cfg
mc
Package mc implements facilities for detecting and working with Minecraft instances.
Package mc implements facilities for detecting and working with Minecraft instances.
obs
Package obs provides a basic obs-websocket 5.0 client.
Package obs provides a basic obs-websocket 5.0 client.
x11

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL