Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/younishd/neoreset
Neo's auto resetter for Minecraft speedrunning on Linux.
https://github.com/younishd/neoreset
minecraft speedrun
Last synced: about 1 month ago
JSON representation
Neo's auto resetter for Minecraft speedrunning on Linux.
- Host: GitHub
- URL: https://github.com/younishd/neoreset
- Owner: younishd
- License: mit
- Archived: true
- Created: 2021-04-11T19:05:07.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-12-30T13:23:16.000Z (almost 3 years ago)
- Last Synced: 2024-08-01T21:59:16.822Z (5 months ago)
- Topics: minecraft, speedrun
- Language: Python
- Homepage:
- Size: 2.9 MB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- starred - younishd/neoreset - Neo's auto resetter for Minecraft speedrunning on Linux. (Python)
README
# neoreset
_Neo's auto resetter for Minecraft speedrunning on Linux._
---
## TL;DR
Download the latest release from [**here**](https://github.com/younishd/neoreset/releases/latest).
Run the executable (e.g. from a terminal) and press…
- **F7** to reset (from title screen)
- **F8** to switch category
## Features
- **RSG/SSG/FSG**
- **1.16** and **1.14**
- Global and per session counter in world name
- Included filters
- filteredseed
- filteredvillage
- filteredshipwreck
- ruined-portal-loot
- fsg-power-village-looting-sword
## Options
```
usage: neoreset [-h] [-v] [-c CONFIG_PATH]
optional arguments:
-h, --help show this help message and exit
-v, --version show program's version number and exit
-c CONFIG_PATH, --config CONFIG_PATH
custom path to neoreset.json config file
```
### Examples
Pass a custom path to where the `neoreset.json` config file shall be:
```
neoreset --config /path/to/somewhere
```
This defaults to your `.minecraft` folder.
## Settings
Check out the file called `neoreset.json` in your `.minecraft` folder.
- `hotkey` - reset hotkey
- `hotkey2` - switch category hotkey
- `version` - minecraft version: `"1.16"` or `"1.14"`
- `category` - default category: `"rsg"`, `"ssg"`, `"fsg"`
- `delay` - delay in seconds between simulated keyboard inputs
- `session_thresh` - threshold when to wrap a session (in seconds)
- `sound` - voice on/off
- `world_name` - world name format string with placeholders
- `{c}` - category
- `{v}` - version
- `{s}` - per session counter
- `{g}` - global counter
- `ssg.seed` - seed to be used for SSG category (1.14 or 1.16)
- `fsg.filter` - filter to be used for FSG category (1.16 only)
- `"filteredseed"`
- `"filteredvillage"`
- `"filteredshipwreck"`
- `"ruined-portal-loot"`
- `"fsg-power-village-looting-sword"`
## Work in progress
- [x] 1.16
- [x] 1.14
- [x] RSG
- [x] SSG
- [x] FSG
- [x] Linux
- [ ] macOS
- [ ] Windows
(PRs are welcome.)
## Dev
Clone the repository and set up a virtual environment as follows.
```
git clone https://github.com/younishd/neoreset.git
cd neoreset
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```
Run the script like this:
```
./neoreset.py
```
### PyInstaller
We're using [PyInstaller](https://pyinstaller.readthedocs.io) to bundle everything into a single binary.
Install the `pyinstaller` package as follows.
```
pip install pyinstaller
```
Then run the following command to build the binary:
```
pyinstaller neoreset.py \
--onefile \
--add-data assets:assets \
--add-data VERSION:. \
--add-data README.md:. \
--add-data LICENSE:. \
--add-data neoreset.json:. \
--add-binary bin:bin \
--add-binary lib:lib \
--hidden-import=pynput.keyboard._xorg \
--hidden-import=pynput.mouse._xorg
```
Run the new binary (outside the venv) like this
```
dist/neoreset
```
## Bugs
Feel free to report any issues [here](https://github.com/younishd/neoreset/issues) or DM me (`neo#0495`) on discord.
## Credits
Thanks to [@AndyNovo](https://github.com/andynovo) for the FSG goodies.