UltimateCustomCrosshair

** 🎯 Ultimate Custom Crosshair - Complete Documentation

---

🎮 Overview

Ultimate Custom Crosshair is a client-side Fabric mod for Minecraft 1.21.1+ that allows players to create, customize, and use fully personalized crosshairs. Unlike traditional crosshair mods that offer a fixed set of presets, this mod features a pixel-by-pixel editor with a 15x15 grid system, giving players unlimited creative freedom.

Why This Mod?

• Full Creative Control: Draw any shape you can imagine
• Performance-First: Lightweight rendering with minimal overhead
• Client-Side Only: Works on any server (no server installation needed)
• Modern Architecture: Built with Minecraft 1.21+ rendering APIs
• Persistent Storage: Save unlimited custom crosshairs
• Easy to Use: Intuitive GUI with real-time preview

---

✨ Features

🎨 Core Features

1. Pixel Grid Editor (15x15)

• Interactive Canvas: Click any cell to toggle pixels on/off
• Real-time Preview: See your crosshair as you design it
• Undo/Redo Support: Revert mistakes instantly
• Grid Overlay: Optional guides for symmetry
• Center Marker: Helps align your design

2. 30+ Built-in Presets
   Ready-to-use crosshairs including:

Category	Presets
Basic	Dot, Small Cross, Large Cross, T-Shape
Advanced	Circle, Hollow Circle, Diamond, Square
Gaming	CS:GO Style, Valorant Style, Apex Style
Sniper	Crosshair with Center Dot, Bracket Style
Creative	Arrow, Star, Heart, Skull
Functional	Rangefinder, Split Cross, Outlined Dot

3. Customization Options

Color Picker

• RGB Sliders: Precise color control (0-255)
• Preset Colors: Quick access to common colors
• White, Red, Green, Blue
• Color Preview: Live preview of selected color
• Hex Input: Enter hex codes directly (RRGGBB)

Size & Scale

• Scale Slider: 50% to 400% (0.5x to 4.0x)
• Pixel Size: Adjust thickness (1-5 pixels per grid cell)
• Aspect Ratio Lock: Maintain proportions when scaling

Opacity & Visibility

• Fade Distance: Auto-hide when far from target
• Dynamic Opacity: Changes based on game state
• Hide in Menus: Auto-disable in GUI screens

4. Advanced Rendering

Dynamic Effects

• Hit Marker: Flash on successful hit
• Hit Color: Custom color when damaging entities
• Pulse Animation: Breathing effect option
• Recoil Simulation: Crosshair expands when shooting

Visibility Rules

• Spectator Mode: Auto-hide option
• Item-Specific: Different crosshairs per weapon
• First Person Only: Disable in third-person view
• ADS Override: Special crosshair when aiming down sights

5. Profile System

Multi-Profile Support

• Unlimited Profiles: Save as many as you need
• Quick Switch: Keybind to cycle through profiles
• Import/Export: Share crosshairs with friends
• Cloud Backup: Optional sync (if configured)

Profile Organization

• Categories: Group by game type (PvP, Building, Mining)
• Favorites: Star frequently used crosshairs
• Search: Find crosshairs by name or tag
• Thumbnails: Visual preview in selection screen

---

📦 Installation Guide

Prerequisites

• Minecraft: 1.21.1 to 1.21.8
• Fabric Loader: 0.17.2+
• Fabric API: 0.110.0+
• Java: 21 or higher

Step-by-Step Installation

1. Download Fabric Loader

   • Visit fabricmc.net
   • Download installer for your OS
   • Run installer and select Minecraft 1.21.1

2. Install Fabric API and Mod Menu

   • Download Fabric-api and Mod menu
   • Place .jar file in .minecraft/mods/ folder

3. Install Ultimate Custom Crosshair

   • Download ultimatecustomcrosshair-1.0.0.jar
   • Place in .minecraft/mods/ folder
   • Launch Minecraft with Fabric profile

4. Verify Installation

   • In-game, press G (default keybind)
   • If editor opens, installation succeeded

Optional Dependencies

Mod	Purpose	Required?
Cloth Config	Enhanced settings UI	No
Puzzle	Additional resource pack support	No

---

🎓 User Guide

Opening the Editor

Default Keybind: G

Alternative Methods:

• Mod Menu → Ultimate Custom Crosshair → Open Editor
• Command: /crosshair editor

Creating Your First Crosshair

Method 1: Using the Pixel Grid

1. Open Editor (Press G)
2. Navigate to "Create" Tab
3. Click cells to toggle pixels on/off
   • Left-click: Enable pixel
   • Right-click: Disable pixel
   • Shift + Drag: Paint multiple cells
4. Adjust Settings:
   • Color: Use RGB sliders
   • Scale: Drag slider (100% = normal size)
5. Click "Save"
6. Test In-Game
   • Click "Apply & Close"
   • Your crosshair is now active!

Method 2: Starting from a Preset

1. Open Editor → "Presets" Tab
2. Browse available crosshairs
   • Click thumbnails to preview
   • Hover for description
3. Select a preset (e.g., "Classic Dot")
4. Click "Edit This Preset"
   • Opens in grid editor
   • Modify as desired
5. Save as new profile
   • "Save As..." → Enter new name

Understanding the Grid

Grid Layout (15x15):
┌─────────────────┐
│ □ □ □ □ □ □ □ │ ← Row 0
│ □ □ □ □ □ □ □ │
│ □ □ □ □ □ □ □ │
│ □ □ □ ■ □ □ □ │ ← Row 7 (Center)
│ □ □ □ □ □ □ □ │
│ □ □ □ □ □ □ □ │
└─────────────────┘
       ↑
    Column 7 (Center)

• Center Cell: Position [7,7] (always highlighted)
• White Cell: Pixel will render
• Gray Cell: Transparent (no pixel)
• Grid Size: 15x15 = 225 total pixels

Keybinds Reference

Action	Default Key	Customizable?
Open Editor	G	✅ Yes

Editor Won't Open

Check:

• Keybind conflict (rebind in Controls menu)
• Mod properly installed in mods/ folder
• Fabric API is present

 📊 Performance Metrics

| Aspect | Impact | Details |
|--------|--------|---------|
| **FPS Impact** | <1% | Minimal overhead |
| **Memory Usage** | ~5MB | Profile storage |
| **Load Time** | <100ms | Fast initialization |
| **Render Time** | <0.1ms | Per frame |

 Optimization Tips

1. **Reduce Grid Size**: Use smaller crosshairs
2. **Disable Effects**: Turn off pulse/hit markers
3. **Use Presets**: Pre-compiled rendering

---

 🎯 Use Cases

 1. **Competitive PvP**
- Create pinpoint-accurate crosshairs
- Match your aim style (flick vs. track)
- Custom colors for visibility

 2. **Building & Creative**
- Grid-aligned crosshairs for precise placement
- Large crosshairs for block selection
- Center indicators for symmetry

 3. **Roleplay Servers**
- Themed crosshairs (medieval, sci-fi)
- Hidden crosshairs for immersion
- Custom per-character

 4. **Accessibility**
- High-contrast colors for visibility
- Larger sizes for visual impairment
- Simplified shapes for clarity

---

 📝 Changelog

 Version 1.0.0 (Initial Release)
- ✅ Pixel grid editor (15x15)
- ✅ 30 built-in presets
- ✅ RGB color picker
- ✅ Scale controls
- ✅ Keybind customization

---

 🙏 Credits

- **Fabric Team**: For the modding framework
- **Minecraft**: Mojang Studios

---

 📞 Support

- **Discord**: *geturplugins*

---

**Made with ❤️ for the Minecraft community****