inital

README.md

@@ -0,0 +1,100 @@
+# 🔥 TinyTorch
+
+A Minecraft Fabric mod that makes lighting more realistic and atmospheric by reducing torch brightness and adding optional flickering effects.
+
+## Features
+
+### ✨ Core Features
+
+- **Reduced Light Radius**: Normal torch brightness reduced from light level 14 to configurable level (default: 8)
+- **Works for all torch types**: Both standing and wall torches affected
+- **Configurable**: All settings customizable via `tinytorch.json`
+
+### 🎭 Optional Effects
+
+- **Flicker Effect**: Light level oscillates randomly ±1 every few ticks to simulate flickering flame
+- **Particle Effects**: Small smoke and spark particles appear occasionally around torches
+- **Held Light**: Torches emit weak light (level 4-5) when held in main/offhand
+- **Smart Updates**: Held light only updates when player moves for performance
+
+### ⚡ Advanced Features
+
+- **Light Falloff Curve**: Sharper brightness drop-off after a few blocks (dark corners stay dark)
+- **Material-Based Lighting**: 
+  - Stone/Cobblestone/Deepslate absorb light slightly
+  - Iron/Copper/Gold blocks reflect light slightly
+- **Performance Optimized**: Lightweight implementation compatible with OptiFine/Sodium
+
+## Configuration
+
+The mod creates a `tinytorch.json` config file in your config directory:
+
+```json
+{
+  "torch_light_level": 8,
+  "held_light_level": 5, 
+  "enable_flicker": true,
+  "flicker_speed": 5,
+  "use_falloff_curve": true,
+  "held_light": true
+}
+```
+
+### Config Options
+
+- `torch_light_level` (0-15): Light level emitted by placed torches (default: 8)
+- `held_light_level` (0-15): Light level when holding a torch (default: 5)
+- `enable_flicker` (true/false): Enable flickering flame effect (default: true)
+- `flicker_speed` (1+): Ticks between flicker changes, higher = slower (default: 5)
+- `use_falloff_curve` (true/false): Use custom sharp light falloff (default: true) 
+- `held_light` (true/false): Enable dynamic lighting when holding torches (default: true)
+
+## Gameplay Impact
+
+- **Caves become darker** even with torches, forcing closer placement
+- **Building interiors** have cozy, dim lighting atmosphere
+- **Night exploration** feels eerie but natural
+- **Torches glow gently** in-hand when walking at night
+- **Strategic lighting** becomes more important for visibility
+
+## Installation
+
+1. Install [Fabric Loader](https://fabricmc.net/use/)
+2. Install [Fabric API](https://modrinth.com/mod/fabric-api)
+3. Download TinyTorch jar
+4. Place in your `mods` folder
+
+## Compatibility
+
+- ✅ **Fabric API**: Required
+- ✅ **OptiFine**: Compatible
+- ✅ **Sodium**: Compatible  
+- ✅ **Shaders**: Works with vanilla lighting pipeline
+- ✅ **Multiplayer**: Server-side mod, clients benefit from effects
+
+## Technical Details
+
+- **Minecraft Version**: 1.21.1
+- **Fabric Loader**: 0.17.3+
+- **Java**: 21+
+- **License**: CC0-1.0
+
+## Building
+
+```bash
+./gradlew build
+```
+
+Built jar will be in `build/libs/`
+
+## Contributing
+
+Contributions welcome! Please ensure:
+- Code follows existing style
+- Features are configurable
+- Performance impact is minimal
+- Works on both client and server
+
+---
+
+*Made with ❤️ for atmospheric Minecraft lighting*