Update README.

This commit is contained in:
2025-08-07 21:12:45 +02:00
parent 397a80a1d0
commit 1e499492e6

View File

@@ -0,0 +1,55 @@
# 🔨 Hammer - 2D Map Editor
**Hammer** is a lightweight and intuitive tilemap editor, specially designed to create 2D maps for our upcoming game directly in your browser.
![Hammer Editor](https://img.shields.io/badge/Status-Online-brightgreen) ![Version](https://img.shields.io/badge/Version-1.0-blue) ![License](https://img.shields.io/badge/License-MIT-green)
## ✨ Features
- **🎨 Custom Tilesheets**: Import your images (PNG, JPG, JPEG) with automatic 16x16 slicing
- **🖼️ Infinite Canvas**: Free navigation with zoom and pan
- **🛠️ Editing Tools**: Brush and eraser to place/remove tiles
- **💾 Save & Load**: Export/import in compressed `.tmpx` format
- **⌨️ Keyboard Shortcuts**: Optimized workflow
- **📝 Real-time Console**: Instant feedback
## 🚀 Quick Start
1. **Load a tilesheet**: `U` or "Upload Tilesheet" button
2. **Select a tile**: Click in the left palette
3. **Draw**: Draw tool (`D`) + click on canvas
4. **Navigate**: Right-click + drag / Mouse wheel to zoom
5. **Save**: `Ctrl + S` to export your map
## 📋 Shortcuts
| Key | Action |
|-----|--------|
| `U` | Import tilesheet |
| `D` | Draw tool |
| `E` | Erase tool |
| `C` | Center view |
| `Ctrl + S` | Save |
## 📄 .tmpx Format
Compressed file containing embedded tilesheet and map data, optimized for our game engine.
## 📱 Compatibility
- ✅ Chrome, Firefox, Edge
- ❌ Safari (not supported)
- ❌ Mobile/tablet (not suitable)
## 📞 Support
- 🐛 [Issues](https://github.com/Under-scape/hammer/issues)
- 💡 [Discussions](https://github.com/Under-scape/hammer/discussions)
## 📜 License
[MIT License](LICENSE) - Free to use and modify.
---
**✨ Create your levels now!** Tool dedicated to developing our upcoming game.