mirror of
https://gitlab.com/MaddoScientisto/cirnogodot.git
synced 2026-06-01 09:55:35 +00:00
57 lines
2 KiB
Markdown
57 lines
2 KiB
Markdown
|
# Weapon Creator 3D Plugin
|
||
|
|
|
||
|
|
A powerful Godot editor plugin that streamlines the creation of 3D weapons with all required resources.
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
- **User-Friendly UI**: Intuitive dock panel with organized input fields
|
||
|
|
- **Real-time Feedback**: Live output log showing creation progress and errors
|
||
|
|
- **Auto-generation**: Automatically generates item keys from weapon names
|
||
|
|
- **Full Validation**: Input validation with helpful error messages
|
||
|
|
- **Complete Integration**: Creates WeaponResource, LootItem, and adds to ItemsDatabase automatically
|
||
|
|
- **Customizable Stats**: Fine-tune all weapon parameters through the UI
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
1. The plugin is already installed in `addons/weapon_creator/`
|
||
|
|
2. Go to **Project → Project Settings → Plugins**
|
||
|
|
3. Enable "Weapon Creator 3D"
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
1. Open the **Weapon Creator** panel from the bottom dock
|
||
|
|
2. Fill in the weapon details:
|
||
|
|
- **Basic Information**: Name, key, description
|
||
|
|
- **Weapon Statistics**: All gameplay parameters
|
||
|
|
3. Click **Create Weapon** button
|
||
|
|
4. Check the output log for results
|
||
|
|
5. Find your new weapon resources in:
|
||
|
|
- `Resources/Weapons/[WEAPON_KEY].tres`
|
||
|
|
- `Resources/Items/[WEAPON_KEY]_Item.tres`
|
||
|
|
|
||
|
|
## Tips
|
||
|
|
|
||
|
|
- Item Key is auto-generated from Weapon Name (converts to UPPERCASE_WITH_UNDERSCORES)
|
||
|
|
- The bullet path defaults to the simple ice bullet - change if needed
|
||
|
|
- All fields have tooltips explaining their purpose
|
||
|
|
- Use "Clear Log" to reset the output display
|
||
|
|
|
||
|
|
## What Gets Created
|
||
|
|
|
||
|
|
1. **WeaponResource** - Contains all weapon stats and bullet data
|
||
|
|
2. **LootItem** - Makes the weapon pickupable in-game
|
||
|
|
3. **Database Entry** - Automatically added to ItemsDatabase.tres
|
||
|
|
|
||
|
|
## After Creation
|
||
|
|
|
||
|
|
Remember to:
|
||
|
|
1. Add weapon sounds (shoot, reload) to the WeaponResource
|
||
|
|
2. Add an inventory sprite to the LootItem
|
||
|
|
3. Test the weapon in-game
|
||
|
|
|
||
|
|
## Troubleshooting
|
||
|
|
|
||
|
|
- **"Resource already exists"**: Choose a different weapon name/key
|
||
|
|
- **"Bullet resource not found"**: Verify the bullet path is correct
|
||
|
|
- **No output**: Check the Godot console for errors
|
||
|
|
|