An open API service indexing awesome lists of open source software.

https://github.com/draxonv1/f3commands

Client-side F3-style debug commands for Minecraft Modded Versions.
https://github.com/draxonv1/f3commands

debug f3 f3-mod f3commands minecraft minecraft-java minecraft-java-mod minecraft-mod

Last synced: 24 days ago
JSON representation

Client-side F3-style debug commands for Minecraft Modded Versions.

Awesome Lists containing this project

README

          

# **F3Commands** ๐ŸŒŸ

**[Fabric Mod]** โ€“ Access Minecraftโ€™s debug information with simple client-side commands!

F3Commands is a **client-side Fabric mod** that replaces complex F3 key combinations with intuitive slash commands. Get instant access to performance stats, world info, debug tools, and moreโ€”**without memorizing hotkeys!**

---

## โœจ **Features**

- **70+ Client Commands** โ€“ Access all debug info via simple commands.
- **Performance Tracking** โ€“ Monitor FPS, memory, and system resources.
- **World Information** โ€“ Get details about your position, biome, dimension, and more.
- **Debug Tools** โ€“ Check graphics settings, reload resources, and manage client state.
- **Color-Coded Output** โ€“ Easy-to-read, formatted responses.
- **Comprehensive Help** โ€“ Built-in help system with categorized commands.
- **Client-Side Only** โ€“ Works on any server without installation.
- **Mod Menu Integration** โ€“ Configure settings in-game (optional).

---

## ๐Ÿ“ฆ **Installation**

### **Requirements**
- **Minecraft** (Fabric)
- **Fabric Loader** (latest stable)
- **Fabric API** (latest stable)
- **Java 17+**

### **Steps**
1. Install **[Fabric Loader](https://fabricmc.net/use/)**.
2. Download **[Fabric API](https://www.curseforge.com/minecraft/mc-mods/fabric-api)**.
3. Download the latest **F3Commands** release for your Minecraft version.
4. Place both `.jar` files in your `.minecraft/mods` folder.
5. Launch Minecraft with the Fabric profile.

### **Optional Dependencies**
- **[Mod Menu](https://modrinth.com/mod/modmenu)** โ€“ For in-game configuration.
- **[Cloth Config](https://modrinth.com/mod/cloth-config)** โ€“ Bundled for settings UI.

---

## ๐ŸŽฎ **Commands**

### **Quick Start**
Type `/f3help` in-game to see all available commands!

### **Command Categories**

#### **๐Ÿ“ Position & World Info**
Get details about your location and surroundings:
```
/mycoords, /myblockpos, /mychunkpos, /myrotation, /mydimension, /mybiome, /myfacing, /currenttime, /worldday, /moonphase, /myhealth, /myhunger, /mysaturation, /myarmor, /myair, /myxplevel, /myxpbar, /amionground, /myvelocity, /myspeed, /myhorizontalspeed, /lightlevel, /skylightlevel, /blocklightlevel, /currentweather
```

#### **๐Ÿ”ง Debug & Settings**
Check and manage game settings:
```
/advtooltips, /switchtooltips, /rechunks, /reresources, /clearchat, /checkfullscreen, /checkvsync, /checkfov, /checkrenderdist, /checksimuldist, /checkgraphics, /checkframelimit, /checkguiscale, /checkbrightness, /checkentitydist, /checkmastervol, /checkmusicvol, /checkmipmaplevel, /checkparticles, /checksmoothlighting, /checkclouds, /checkbiomeblend, /checkautosave, /viewlimitations, /windowinfo
```

#### **โšก Performance Monitoring**
Track game performance and system resources:
```
/currentfps, /avgfps, /maxfps, /minfps, /fpsreport, /memused, /memmax, /memfree, /memusage, /memreport, /chunkupdates, /chunksloaded, /chunkstats, /entitycount, /particlecount, /javaversion, /cpucores, /osinfo, /sysreport, /resetfpstracker, /perfstatus
```

#### **๐Ÿ“š Help System**
```
/f3help, /f3info, /f3debug, /f3perf
```

---

## ๐ŸŽจ **Command Output**
All commands use **color-coded output** for clarity:
- **Gold (ยง6)** โ€“ Category labels
- **White (ยงf)** โ€“ Values and data
- **Yellow (ยงe)** โ€“ Command names
- **Green (ยงa)** โ€“ Subcategories
- **Red (ยงc)** โ€“ Warnings (e.g., high memory usage)

**Example:**
```
ยง6Position: ยงfX: 123.45 Y: 64.00 Z: -789.12
ยง6Health: ยงf20.0 / 20.0
ยง6Memory Usage: ยงf1024 MB / 4096 MB (ยงc25%ยงf)
```

---

## ๐Ÿ› ๏ธ **Development**

### **Building from Source**
```bash
git clone https://github.com/DraxonV1/F3Commands.git
cd F3Commands
./gradlew build
```
The compiled `.jar` will be in `build/libs/`.

### **Project Structure**
```
F3Commands/
โ”œโ”€โ”€ src/main/java/com/draxon/f3commands/
โ”‚ โ”œโ”€โ”€ commands/
โ”‚ โ”‚ โ”œโ”€โ”€ debug/
โ”‚ โ”‚ โ”œโ”€โ”€ help/
โ”‚ โ”‚ โ”œโ”€โ”€ info/
โ”‚ โ”‚ โ”œโ”€โ”€ performance/
โ”‚ โ”‚ โ””โ”€โ”€ CommandRegistrar.java
โ”‚ โ”œโ”€โ”€ config/
โ”‚ โ””โ”€โ”€ F3CommandsClient.java
โ””โ”€โ”€ src/main/resources/
โ””โ”€โ”€ fabric.mod.json
```

---

## ๐Ÿค **Contributing**
Contributions are welcome! Submit a **Pull Request** or open an **Issue** on [GitHub](https://github.com/DraxonV1/F3Commands).

---

## ๐Ÿ“ **License**
**MIT License** โ€“ See [LICENSE](LICENSE).

---

## ๐Ÿ› **Bug Reports**
Found a bug? Report it on **[GitHub Issues](https://github.com/DraxonV1/F3Commands/issues)** with:
- Minecraft version
- Fabric Loader version
- F3Commands version
- Steps to reproduce
- Expected vs. actual behavior

---

## ๐Ÿ’ฌ **Support**
- **[GitHub Issues](https://github.com/DraxonV1/F3Commands/issues)** โ€“ Bug reports & feature requests.
- **[Wiki](https://f3commands.mc.draxon.asia)** โ€“ Detailed documentation.

---

## โญ **Credits**
- **Author**: DraxonV1
- **Built with**: [Fabric](https://fabricmc.net/)
- **Dependencies**: Fabric API, Cloth Config, Mod Menu (optional)

---

**Made with โค๏ธ for the Minecraft Fabric community**

๐Ÿ”— **[Modrinth](https://modrinth.com/mod/f3commands)** | **[GitHub](https://github.com/DraxonV1/F3Commands)** | **[Wiki](https://f3commands.mc.draxon.asia)**