|
1 | 1 | # Getting Started |
2 | 2 |
|
3 | | -Welcome to the Minecraft Command Generator! This guide will help you get started with using the tool. |
| 3 | +Welcome to the Minecraft Command Generator! This guide will help you get started with the application. |
| 4 | + |
| 5 | +## Prerequisites |
| 6 | + |
| 7 | +- Python 3.8 or higher |
| 8 | +- Git (for installation) |
| 9 | +- Minecraft Java Edition (for testing commands) |
4 | 10 |
|
5 | 11 | ## Installation |
6 | 12 |
|
7 | 13 | 1. Clone the repository: |
8 | 14 | ```bash |
9 | 15 | git clone https://github.com/ShockerAttack01/MinecraftCommandGenerator.git |
| 16 | + cd MinecraftCommandGenerator |
| 17 | + ``` |
| 18 | + |
| 19 | +2. Create a virtual environment: |
| 20 | + ```bash |
| 21 | + python -m venv venv |
10 | 22 | ``` |
11 | 23 |
|
12 | | -2. Install dependencies: |
| 24 | +3. Activate the virtual environment: |
| 25 | + - Windows: |
| 26 | + ```bash |
| 27 | + .\venv\Scripts\activate |
| 28 | + ``` |
| 29 | + - Linux/Mac: |
| 30 | + ```bash |
| 31 | + source venv/bin/activate |
| 32 | + ``` |
| 33 | + |
| 34 | +4. Install dependencies: |
13 | 35 | ```bash |
14 | 36 | pip install -r requirements.txt |
15 | 37 | ``` |
16 | 38 |
|
17 | | -3. Run the application: |
| 39 | +## Running the Application |
| 40 | + |
| 41 | +1. Start the application: |
18 | 42 | ```bash |
19 | 43 | python main.py |
20 | 44 | ``` |
21 | 45 |
|
| 46 | +2. The main window will open with: |
| 47 | + - Command type selection |
| 48 | + - Parameter input fields |
| 49 | + - Real-time validation |
| 50 | + - Command preview |
| 51 | + |
22 | 52 | ## Basic Usage |
23 | 53 |
|
24 | | -### 1. Selecting a Command |
25 | | -- Choose a command type from the dropdown menu |
26 | | -- Available commands include: |
27 | | - - `/give`: Give items to players |
28 | | - - `/effect`: Apply effects to players |
29 | | - - `/gamemode`: Change player gamemode |
30 | | - - `/teleport`: Teleport players |
31 | | - |
32 | | -### 2. Using the Give Command |
33 | | -1. Select a player: |
34 | | - - Enter a player name |
35 | | - - Or use a target selector (@a, @p, @e, @r, @s) |
36 | | - |
37 | | -2. Choose an item: |
38 | | - - Use the category dropdown to filter items |
39 | | - - Search for items by name |
40 | | - - Select from the suggestions |
41 | | - |
42 | | -3. Set the amount: |
43 | | - - Enter a number (default: 1) |
44 | | - - Leave empty for default amount |
45 | | - |
46 | | -4. Add NBT data (optional): |
47 | | - - Enter NBT data if needed |
48 | | - - Format: `{key:value}` |
49 | | - |
50 | | -### 3. Command Feedback |
51 | | -- The command is validated in real-time |
52 | | -- Feedback shows: |
53 | | - - Command validity |
54 | | - - Parameter status |
55 | | - - Error messages |
56 | | - - Item information |
57 | | - |
58 | | -## Documentation |
59 | | - |
60 | | -### Wiki Updates |
61 | | -The project's documentation is automatically updated through GitHub Actions: |
62 | | -- Documentation is stored in the `docs/wiki` directory |
63 | | -- Changes are automatically validated and formatted |
64 | | -- Updates are pushed to the GitHub wiki |
65 | | -- Broken links and formatting issues are caught early |
66 | | - |
67 | | -### Contributing to Documentation |
68 | | -1. Make changes to files in `docs/wiki` |
69 | | -2. Commit and push your changes |
70 | | -3. The wiki will be automatically updated |
71 | | -4. Check the Actions tab for validation results |
| 54 | +### Creating Your First Command |
| 55 | + |
| 56 | +1. Select a command type from the dropdown |
| 57 | +2. Fill in the required parameters |
| 58 | +3. Watch the command preview update in real-time |
| 59 | +4. Copy the generated command |
| 60 | + |
| 61 | +### Using Item Search |
| 62 | + |
| 63 | +1. Click the item search field |
| 64 | +2. Type to search for items |
| 65 | +3. Use categories to filter results |
| 66 | +4. Select an item from the suggestions |
| 67 | + |
| 68 | +### Command Validation |
| 69 | + |
| 70 | +- Required fields are marked with * |
| 71 | +- Invalid inputs are highlighted in red |
| 72 | +- Hover over fields for help text |
| 73 | +- Check the command preview for errors |
| 74 | + |
| 75 | +## Common Tasks |
| 76 | + |
| 77 | +### Giving Items |
| 78 | +1. Select "Give Command" |
| 79 | +2. Choose a player |
| 80 | +3. Search for an item |
| 81 | +4. Set quantity and NBT data |
| 82 | +5. Copy the command |
| 83 | + |
| 84 | +### Applying Effects |
| 85 | +1. Select "Effect Command" |
| 86 | +2. Choose a player |
| 87 | +3. Select an effect |
| 88 | +4. Set duration and amplifier |
| 89 | +5. Copy the command |
| 90 | + |
| 91 | +## Troubleshooting |
| 92 | + |
| 93 | +### Common Issues |
| 94 | + |
| 95 | +1. **Application won't start** |
| 96 | + - Check Python version |
| 97 | + - Verify virtual environment |
| 98 | + - Check dependencies |
| 99 | +
|
| 100 | +2. **Item search not working** |
| 101 | + - Check internet connection |
| 102 | + - Verify item data files |
| 103 | + - Clear search cache |
| 104 | +
|
| 105 | +3. **Command validation errors** |
| 106 | + - Check parameter types |
| 107 | + - Verify player names |
| 108 | + - Check item IDs |
72 | 109 |
|
73 | 110 | ## Next Steps |
74 | 111 |
|
75 | | -- Read the [[Basic Usage]] guide for more details |
76 | | -- Check out the [[Item Search Guide]] for advanced item selection |
77 | | -- Visit [[Troubleshooting]] if you encounter any issues |
| 112 | +- Read the [[Basic Usage]] guide |
| 113 | +- Explore [[Command Types]] |
| 114 | +- Learn about [[Item Search]] |
| 115 | +- Check [[Troubleshooting]] for help |
78 | 116 |
|
79 | | -## Tips |
| 117 | +## Support |
80 | 118 |
|
81 | | -- Use the category filter to quickly find items |
82 | | -- Target selectors can save time when affecting multiple players |
83 | | -- The feedback system helps prevent invalid commands |
84 | | -- NBT data is optional but useful for custom items |
| 119 | +- Visit our [GitHub Issues](https://github.com/ShockerAttack01/MinecraftCommandGenerator/issues) |
| 120 | +- Join our [Discord Community](https://discord.gg/your-invite-link) |
| 121 | +- Check the [[Troubleshooting]] guide |
0 commit comments