resetti

command module
v0.5.3 Latest Latest
Warning

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

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

README

resetti Discord

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

Installation

Distribution specific packages are currently availible for Arch, Debian-based and RPM-based distributions. More distributions are planned for later.

From the AUR

There are two AUR packages available: resetti and resetti-git. Install with your AUR helper of choice, or manually:

git clone https://aur.archlinux.org/{resetti,resetti-git}
cd resetti
makepkg -si
From distro-specific packages

Check the Releases tab for distro-specific packages (deb or rpm) or download the latest development builds from the Discord.

From source

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

# Stable
env CGO_ENABLED=0 go install -ldflags="-s -w" github.com/tesselslate/resetti@latest

# Dev
env CGO_ENABLED=0 go install -ldflags="-s -w" github.com/tesselslate/resetti@dev
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, hiding, and preview freezing
    • Mouse support
    • Moving wall
      • Define one or more "groups" of instances to interact with
  • Flexible keybind and "hook" system for running commands
  • 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. Join the Discord or open an issue to discuss the changes you'd like to make.

  • 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.
  • Use make check.
  • 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
    • boyenn's moving wall ideas
    • MultiResetWall by Specnr and contributors

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
This program serves as a simple benchmarker for your world loading speeds.
This program serves as a simple benchmarker for your world loading speeds.
internal
cfg
Package cfg allows for reading the user's configuration.
Package cfg allows for reading the user's configuration.
ctl
Package ctl implements the main controller used for all of the available resetting schemes (e.g.
Package ctl implements the main controller used for all of the available resetting schemes (e.g.
log
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.
res
Package res contains various resources embedded within resetti that are used elsewhere.
Package res contains various resources embedded within resetti that are used elsewhere.
x11
Package x11 provides a simple client for interacting with the X server to do things like sending input events.
Package x11 provides a simple client for interacting with the X server to do things like sending input events.

Jump to

Keyboard shortcuts

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