v6.4

README.en.md

@@ -0,0 +1,82 @@
+<p align="center">
+  <a href="README.md"><img src="https://img.shields.io/badge/lang-Español-yellow.svg" alt="español"></a>
+  <a href="README.en.md"><img src="https://img.shields.io/badge/lang-English-blue.svg" alt="english"></a>
+</p>
+
+# jenny's mod 2 (100% real)
+
+> Minecraft Fabric 26.2 mod that adds some "QOL" features, mostly related to the camera.
+
+## installation
+
+### for normal people:
+1. go to [releases](https://codeberg.org/retucio/sputnik/releases)
+2. choose the most recent version
+3. download the .jar file
+4. move it to your mods dir (prolly `%appdata%/.minecraft/mods`)
+
+
+make sure to have a Minecraft and Fabric version compatible with the mod (MC `26.2`; Fabric `0.19.3`)
+
+issues could arise when using it with other mods, especially other clients, since they could conflict
+
+### for nerds
+1. clone the repo (`git clone https://codeberg.org/retucio/sputnik`)
+2. enter the repo dir (`cd sputnik`)
+3. `gradlew build` for Windows (ew) or `chmod +x gradlew` + `./gradlew build` for Unix-likes (Linux & Mac)
+4. the built .jar will be found in `/build/libs/sputnik-X.X.jar`
+
+## usage
+
+`rshift` by default to open the GUI
+
+`insert` by default to open the HUD editor
+
+`$` as prefix for commands (autocompleted)
+
+some modules have keys assigned by default, assign them `ESC` to unbind them.
+
+## ui
+
+- left click to toggle modules
+- right click to open its settings
+- left click + drag to move a panel
+- right click on a panel's header to expand/contract it, or to close it
+- left click over settings to change them
+- shift + right click on a setting to reset it to its default value
+- place the mouse cursor over a module/setting to read its description
+
+## screenshots
+
+<img src="screenshots/automine.png" alt="auto mine">
+<img src="screenshots/blockesp.png" alt="block ESP + light overlay">
+<img src="screenshots/camtweaks.png" alt="perspective plus">
+<img src="screenshots/chatplus.png" alt="chatplus + nametags + screenshots plus">
+<img src="screenshots/clickgui.png" alt="click GUI">
+<img src="screenshots/freecam.png" alt="freecam + tracers">
+<img src="screenshots/hudeditor.png" alt="HUD editor">
+<img src="screenshots/itemphysics.png" alt="item physics">
+<img src="screenshots/lsd.png" alt="lsd module">
+<img src="screenshots/macros.png" alt="macros tab">
+<img src="screenshots/trajectories.png" alt="projectile trajectories">
+
+
+## contribution
+
+yes please (PRs are welcome)
+
+## license
+
+[CC0 license](LICENSE)
+
+## disclaimer
+
+i don't give a single fuck what happens to you when using this mod on servers where its features are bannable and such.
+
+## deps
+
+- [fabric api](https://modrinth.com/mod/fabric-api/)
+
+## notes
+
+this mod IS BUGGY. VERY BUGGY, i know. i started this project when i was 14 and the codebase is such a mess i refuse to fix it. i might rewrite it in a future, though.