Skip to content

Commit c3cc217

Browse files
authored
Update README.md
1 parent 5a4371d commit c3cc217

1 file changed

Lines changed: 53 additions & 30 deletions

File tree

README.md

Lines changed: 53 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,47 +2,70 @@
22

33
[![build](https://github.com/KdGaming0/ScaleMe/actions/workflows/build.yml/badge.svg)](https://github.com/KdGaming0/ScaleMe/actions/workflows/build.yml)
44

5-
A simple, client-side Minecraft mod that allows you to visually change the scale of your own player model and other players' models.
5+
**Scale players, NPCs, and even your items in Minecraft.**
6+
A simple, client-side mod that gives you full control over the size and positioning of player models, NPCs, and the items you hold. Works great for fun with friends, screenshots, or just making the game look the way you want.
67

78
### 📦 Download from Modrinth
89

910
[![Download on Modrinth](https://img.shields.io/badge/Modrinth-Download-brightgreen?style=for-the-badge&logo=modrinth)](https://modrinth.com/mod/scaleme)
1011

11-
## Features
12+
---
1213

13-
* **Individual Scaling:** Adjust the visual size of your own player model independently from others.
14-
* **Other Player Scaling:** Enable and control the scale of all other players on a server.
15-
* **Smooth Transitions:** Toggle smooth, gradual scaling animations for a less jarring experience.
16-
* **In-Game Configuration:** Easily change settings on the fly using the in-game config screen (powered by [MidnightLib](https://modrinth.com/mod/midnightlib)).
17-
* **Custom Keybinding:** Open the configuration menu with a configurable key (defaults to `O`).
14+
## 🛠 Features
1815

19-
## Installation
16+
### Player & NPC Scaling
17+
- **Individual Player Scaling** – Change your own player size from tiny to towering.
18+
- **Other Player Scaling** – Set the size for all other players on the server.
19+
- **Per-Player Scaling** – Give a specific player a custom size while keeping everyone else normal. *(Default keybind: `P`)*
20+
- **Smooth Transitions** – Optional smooth scaling animations for better visuals.
21+
- **NPC Scaling in Hypixel SkyBlock** – Set a specific scale for NPCs, with a separate slider for villagers used as NPCs (make Jerry tiny or huge).
22+
- **Safeguards for Hypixel** – Automatic limits to prevent scaling from giving unfair advantages in competitive modes.
2023

21-
1. **Install Fabric:** Make sure you have the [Fabric Loader](https://fabricmc.net/use/) installed.
22-
2. **Install Dependencies:** This mod requires:
23-
* [Fabric API](https://modrinth.com/mod/fabric-api)
24-
3. **Download ScaleMe:** Get the latest version from the project's release page.
25-
4. **Add to Mods:** Place the downloaded `.jar` files into your `.minecraft/mods` folder.
24+
### Item Scaling & Positioning
25+
- **Item Scaling** – Change the size of the item you hold.
26+
- **Position Controls** – Adjust yaw, pitch, roll, and X, Y, Z position in your hand.
27+
- **Swing Speed Control** – Change how fast your swing animation plays.
2628

27-
## Configuration
29+
### View Options
30+
- **Third-Person Crosshair (Back View)** – Optional crosshair while in third-person view from behind.
31+
- **Third-Person Crosshair (Front View)** – Optional crosshair while in front-facing third-person view.
32+
- **Disable Selfie Cam** – Remove the front-facing camera entirely if you prefer.
2833

29-
You can access the configuration screen in two ways:
30-
* Press the `O` key by default (this can be changed in Minecraft's keybinding settings).
31-
* Through [Mod Menu](https://modrinth.com/mod/modmenu) if you have it installed.
34+
### Configuration
35+
- **In-Game Config Screen** – Change all settings in real time.
36+
The config menu is transparent so you can see how your changes affect you or other players’ scale while adjusting them. Especially useful for item scale and position configuration. *(Powered by [MidnightLib](https://modrinth.com/mod/midnightlib))*
3237

33-
The following options are available:
38+
---
3439

35-
* **Own Player Scale:** A slider to control the size of your character (from 0.1x to 3.0x).
36-
* **Smooth Scaling for Own Player:** Toggles gradual scale transitions for your character.
37-
* **Enable Other Players Scaling:** A master switch to turn scaling for other players on or off.
38-
* **Other Players Scale:** A slider to control the size of other players.
39-
* **Smooth Scaling for Other Players:** Toggles gradual scale transitions for other players.
40-
* **Apply to All Players:** When enabled, uses the "Other Players Scale" for everyone, including you.
40+
## 📦 Installation
4141

42-
## Building from Source
42+
1. Install [Fabric Loader](https://fabricmc.net/use/).
43+
2. Install required dependencies:
44+
- [Fabric API](https://modrinth.com/mod/fabric-api)
45+
- [oωo (owo-lib)](https://modrinth.com/mod/owo-lib)
46+
3. Download **ScaleMe** and drop it into your `mods` folder.
4347

44-
1. Clone the repository: `git clone https://github.com/KdGaming0/ScaleMe.git`
45-
2. Navigate to the project directory: `cd ScaleMe`
46-
3. Grant execute permissions to the Gradle wrapper: `chmod +x ./gradlew`
47-
4. Build the project: `./gradlew build`
48-
5. The compiled mod `.jar` will be located in the `build/libs/` directory.
48+
---
49+
50+
## 💻 Development
51+
52+
### Building from Source
53+
1. Clone the repository: `git clone https://github.com/KdGaming0/ScaleMe.git`
54+
2. Navigate to the project directory: `cd ScaleMe`
55+
3. Grant execute permissions to the Gradle wrapper: `chmod +x ./gradlew`
56+
4. Build the project: `./gradlew build`
57+
5. The compiled mod `.jar` will be located in the `build/libs/` directory.
58+
59+
---
60+
61+
[![Bisect Hosting Banner](https://www.bisecthosting.com/partners/custom-banners/8a1e1ba8-343f-4e31-a276-a1eba99388f3.webp)](https://www.bisecthosting.com/SBE)
62+
63+
## 💻 Need a Minecraft Server?
64+
65+
I’ve partnered with **Bisect Hosting** to offer fast, reliable game servers that work great with modded Minecraft or any other game they host!
66+
Their setup is quick, the hardware is solid, and support is always fast to respond.
67+
68+
Use code **SBE** at checkout for **25% off** your first month:
69+
👉 [Get a server here](https://www.bisecthosting.com/SBE)
70+
71+
Every server purchased through this link directly supports my work on this mod.

0 commit comments

Comments
 (0)