|
| 1 | +# Voxy NeoForge 1.21.1 Testing Guide |
| 2 | + |
| 3 | +## Prerequisites |
| 4 | + |
| 5 | +Before setting up the testing environment, ensure you have: |
| 6 | + |
| 7 | +- **Java 21 or later** (required for Minecraft 1.21.1) |
| 8 | +- **Prism Launcher** installed ([download here](https://prismlauncher.org/download/)) |
| 9 | +- **Internet connection** for downloading Minecraft and mod dependencies |
| 10 | + |
| 11 | +## Step 1: Create NeoForge 1.21.1 Profile |
| 12 | + |
| 13 | +### 1.1 Create New Instance |
| 14 | + |
| 15 | +1. Open Prism Launcher |
| 16 | +2. Click **"Add Instance"** in the top toolbar |
| 17 | +3. In the Create New Instance dialog: |
| 18 | + - **Name:** `Voxy NeoForge 1.21.1 Testing` |
| 19 | + - **Version:** Select `1.21.1` |
| 20 | + - **Mod Loader:** Select **NeoForge** |
| 21 | + - **Loader Version:** Select latest `21.1.x` version (e.g., `21.1.73` or newer) |
| 22 | +4. Click **"OK"** to create the instance |
| 23 | + |
| 24 | +### 1.2 Configure Java Runtime |
| 25 | + |
| 26 | +1. Right-click the newly created instance |
| 27 | +2. Select **"Edit Instance"** |
| 28 | +3. Navigate to **"Settings"** → **"Java"** |
| 29 | +4. Enable **"Use custom Java installation"** if needed |
| 30 | +5. Ensure Java 21+ is selected |
| 31 | +6. Set **"Maximum memory allocation"** to at least **4096 MiB** (recommended: 6144 MiB or higher for Voxy's voxelization) |
| 32 | + |
| 33 | +### 1.3 Configure JVM Arguments (Optional but Recommended) |
| 34 | + |
| 35 | +In the Java settings, add these JVM arguments for better performance: |
| 36 | + |
| 37 | +``` |
| 38 | +-XX:+UseG1GC -XX:+ParallelRefProcEnabled -XX:MaxGCPauseMillis=200 -XX:+UnlockExperimentalVMOptions -XX:+DisableExplicitGC -XX:G1NewSizePercent=30 -XX:G1MaxNewSizePercent=40 -XX:G1HeapRegionSize=8M -XX:G1ReservePercent=20 -XX:G1HeapWastePercent=5 -XX:G1MixedGCCountTarget=4 -XX:InitiatingHeapOccupancyPercent=15 -XX:G1MixedGCLiveThresholdPercent=90 -XX:G1RSetUpdatingPauseTimePercent=5 -XX:SurvivorRatio=32 -XX:+PerfDisableSharedMem -XX:MaxTenuringThreshold=1 |
| 39 | +``` |
| 40 | + |
| 41 | +## Step 2: Install Required Dependencies |
| 42 | + |
| 43 | +### 2.1 Download Sodium for NeoForge |
| 44 | + |
| 45 | +Voxy requires **Sodium 0.6.9 or later** for NeoForge 1.21.1: |
| 46 | + |
| 47 | +1. Go to [Modrinth Sodium page](https://modrinth.com/mod/sodium) or [CurseForge Sodium page](https://www.curseforge.com/minecraft/mc-mods/sodium) |
| 48 | +2. Download the **NeoForge 1.21.1** compatible version (0.6.9+) |
| 49 | +3. **Important:** Ensure you download the **NeoForge** version, NOT the Fabric version |
| 50 | + |
| 51 | +### 2.2 Install Sodium |
| 52 | + |
| 53 | +1. In Prism Launcher, right-click the instance |
| 54 | +2. Select **"Edit Instance"** |
| 55 | +3. Navigate to **"Mods"** tab |
| 56 | +4. Click **"Add .jar"** or **"Add file"** |
| 57 | +5. Select the downloaded Sodium jar file |
| 58 | +6. Verify Sodium appears in the mod list |
| 59 | + |
| 60 | +## Step 3: Install Voxy Mod |
| 61 | + |
| 62 | +### 3.1 Build Voxy (if not already built) |
| 63 | + |
| 64 | +From the project directory: |
| 65 | + |
| 66 | +```bash |
| 67 | +./gradlew build |
| 68 | +``` |
| 69 | + |
| 70 | +The compiled mod will be located at: |
| 71 | +``` |
| 72 | +build/libs/voxy-0.2.9-alpha.jar |
| 73 | +``` |
| 74 | + |
| 75 | +### 3.2 Install Voxy |
| 76 | + |
| 77 | +1. In Prism Launcher, ensure you're still in **"Edit Instance"** → **"Mods"** tab |
| 78 | +2. Click **"Add .jar"** |
| 79 | +3. Navigate to `build/libs/voxy-0.2.9-alpha.jar` |
| 80 | +4. Click **"Open"** |
| 81 | +5. Verify both Sodium and Voxy appear in the mod list |
| 82 | + |
| 83 | +### 3.3 Verify Dependencies |
| 84 | + |
| 85 | +Ensure the following mods are installed and enabled: |
| 86 | +- ✅ **Sodium** (0.6.9+) |
| 87 | +- ✅ **Voxy** (0.2.9-alpha) |
| 88 | + |
| 89 | +## Step 4: Launch Configuration |
| 90 | + |
| 91 | +### 4.1 First Launch |
| 92 | + |
| 93 | +1. Close the "Edit Instance" window |
| 94 | +2. Double-click the instance to launch |
| 95 | +3. Wait for Minecraft to start (first launch may take longer) |
| 96 | +4. If you encounter any crashes, check the logs (see Troubleshooting section) |
| 97 | + |
| 98 | +### 4.2 In-Game Voxy Configuration |
| 99 | + |
| 100 | +Once in-game: |
| 101 | + |
| 102 | +1. Create or load a world |
| 103 | +2. Access Voxy settings (check key bindings or mod menu) |
| 104 | +3. Configure render distance and LOD settings |
| 105 | +4. Test voxelization and chunk rendering |
| 106 | + |
| 107 | +## Step 5: Testing Checklist |
| 108 | + |
| 109 | +### Basic Functionality Tests |
| 110 | + |
| 111 | +- [ ] **Mod loads without crashes** |
| 112 | +- [ ] **Voxy appears in mod list** (check via Mod Menu if installed) |
| 113 | +- [ ] **World loads successfully** |
| 114 | +- [ ] **Chunk voxelization executes** (check for distant terrain rendering) |
| 115 | +- [ ] **No console errors during normal gameplay** |
| 116 | +- [ ] **Shader compilation succeeds** (check logs for GL errors) |
| 117 | +- [ ] **Block model textures render correctly** |
| 118 | +- [ ] **Fluid rendering works** (test with water/lava) |
| 119 | +- [ ] **Biome tinting applies correctly** (grass, foliage, water colors) |
| 120 | + |
| 121 | +### Performance Tests |
| 122 | + |
| 123 | +- [ ] **FPS is stable during chunk loading** |
| 124 | +- [ ] **Memory usage is reasonable** (press F3 in-game) |
| 125 | +- [ ] **No memory leaks over extended play sessions** |
| 126 | +- [ ] **Voxelization performance is acceptable** (check taskbar progress if on Windows) |
| 127 | + |
| 128 | +### Edge Case Tests |
| 129 | + |
| 130 | +- [ ] **Leaves render correctly** (RenderType.solid override) |
| 131 | +- [ ] **Translucent blocks work** (glass, stained glass) |
| 132 | +- [ ] **Cutout blocks work** (doors, trapdoors) |
| 133 | +- [ ] **Block entities handle correctly** (or are skipped appropriately) |
| 134 | +- [ ] **Biome transitions are smooth** |
| 135 | +- [ ] **LOD mipmap levels display correctly** |
| 136 | + |
| 137 | +## Troubleshooting |
| 138 | + |
| 139 | +### Viewing Logs |
| 140 | + |
| 141 | +To check for errors: |
| 142 | + |
| 143 | +1. Right-click the instance in Prism Launcher |
| 144 | +2. Select **"Folder"** → **"View Logs"** |
| 145 | +3. Open `latest.log` to see runtime errors |
| 146 | + |
| 147 | +### Common Issues |
| 148 | + |
| 149 | +#### Issue: Crash on Launch |
| 150 | + |
| 151 | +**Symptoms:** Game crashes before reaching main menu |
| 152 | + |
| 153 | +**Possible Causes:** |
| 154 | +1. Incompatible Sodium version (check you have NeoForge version, not Fabric) |
| 155 | +2. Java version mismatch (ensure Java 21+) |
| 156 | +3. Missing NeoForge dependencies |
| 157 | + |
| 158 | +**Fix:** |
| 159 | +- Check `crash-reports/` folder for crash details |
| 160 | +- Verify Sodium is the NeoForge version |
| 161 | +- Ensure NeoForge 21.1+ is installed |
| 162 | + |
| 163 | +#### Issue: Black/Missing Textures |
| 164 | + |
| 165 | +**Symptoms:** Blocks render black or pink/purple checkerboard |
| 166 | + |
| 167 | +**Possible Causes:** |
| 168 | +1. Texture GL ID access not implemented (known limitation - see `ModelTextureBakery.java:231-234`) |
| 169 | +2. Shader compilation failures |
| 170 | +3. Block atlas binding issues |
| 171 | + |
| 172 | +**Fix:** |
| 173 | +- Check logs for GL errors |
| 174 | +- Check `blockTextureId` TODO implementation status |
| 175 | +- Consider implementing mixin accessor for `AbstractTexture.getId()` |
| 176 | + |
| 177 | +#### Issue: Reflection Errors |
| 178 | + |
| 179 | +**Symptoms:** Errors mentioning `PalettedContainer`, `Data`, `palette`, or `storage` |
| 180 | + |
| 181 | +**Possible Causes:** |
| 182 | +- Minecraft internals changed in update/patch |
| 183 | +- NeoForge remapping differences |
| 184 | + |
| 185 | +**Fix:** |
| 186 | +- Check `WorldConversionFactory.java` reflection initialization (lines 29-42) |
| 187 | +- Verify field names match current Minecraft version |
| 188 | +- Check console for `IllegalAccessException` or `NoSuchFieldException` |
| 189 | + |
| 190 | +#### Issue: FOV/Camera Problems |
| 191 | + |
| 192 | +**Symptoms:** Incorrect field of view or camera rendering |
| 193 | + |
| 194 | +**Possible Causes:** |
| 195 | +- FOV calculation fallback in `VoxyRenderSystem.java:385` may not account for modifiers |
| 196 | + |
| 197 | +**Fix:** |
| 198 | +- Consider implementing `ViewportEvent.ComputeFov` hook for accurate FOV |
| 199 | +- Check if other mods are modifying FOV |
| 200 | + |
| 201 | +#### Issue: Mipmap Issues |
| 202 | + |
| 203 | +**Symptoms:** LOD textures look incorrect at distance |
| 204 | + |
| 205 | +**Possible Causes:** |
| 206 | +- Hardcoded `maxMipLevel = 4` in `ModelStore.java:35` may not match actual atlas |
| 207 | + |
| 208 | +**Fix:** |
| 209 | +- Try adjusting the hardcoded value (2, 4, or 6) |
| 210 | +- Implement reflection to access `TextureAtlas.maxMipLevel` |
| 211 | +- Check in-game video settings for mipmap level configuration |
| 212 | + |
| 213 | +## Known Limitations (Ported from Fabric) |
| 214 | + |
| 215 | +The following are known limitations in this NeoForge port: |
| 216 | + |
| 217 | +1. **PalettedContainer.Data Access** |
| 218 | + - Uses reflection due to package-private visibility |
| 219 | + - Functional but may have performance overhead |
| 220 | + - Location: `WorldConversionFactory.java:24-66` |
| 221 | + |
| 222 | +2. **TextureAtlas.maxMipLevel** |
| 223 | + - Hardcoded to `4` (field is now private) |
| 224 | + - May need adjustment based on user settings |
| 225 | + - Location: `ModelStore.java:33-35` |
| 226 | + |
| 227 | +3. **BlockColor Access** |
| 228 | + - Uses reflection to access private `blockColors` field |
| 229 | + - Location: `ModelFactory.java:741-742` |
| 230 | + |
| 231 | +4. **Texture GL ID Access** |
| 232 | + - Stubbed out, currently not implemented |
| 233 | + - Will fail at runtime if code path is reached |
| 234 | + - Location: `ModelTextureBakery.java:231-234` |
| 235 | + - **Fix Required:** Implement mixin accessor for texture GL IDs |
| 236 | + |
| 237 | +5. **FOV Calculation** |
| 238 | + - Uses fallback `options.fov().get()` instead of `GameRenderer.getFov()` |
| 239 | + - May not account for FOV modifiers from other mods |
| 240 | + - Location: `VoxyRenderSystem.java:384-386` |
| 241 | + |
| 242 | +## Advanced Testing |
| 243 | + |
| 244 | +### Debug Mode |
| 245 | + |
| 246 | +To enable verbose logging for debugging: |
| 247 | + |
| 248 | +1. Edit `options.txt` in the instance folder |
| 249 | +2. Add Voxy-specific debug flags (if implemented) |
| 250 | +3. Restart Minecraft |
| 251 | + |
| 252 | +### Profiling |
| 253 | + |
| 254 | +To profile performance: |
| 255 | + |
| 256 | +1. Use Minecraft's built-in profiler (press F3 + L) |
| 257 | +2. Use external tools like JProfiler or VisualVM |
| 258 | +3. Monitor taskbar progress on Windows for voxelization status |
| 259 | + |
| 260 | +### Shader Debugging |
| 261 | + |
| 262 | +To check shader compilation: |
| 263 | + |
| 264 | +1. Monitor logs for GL shader errors |
| 265 | +2. Check `resources/assets/voxy/shaders/` for GLSL source |
| 266 | +3. Use OpenGL debugging tools (apitrace, RenderDoc) |
| 267 | + |
| 268 | +## Reporting Issues |
| 269 | + |
| 270 | +When reporting issues, please include: |
| 271 | + |
| 272 | +1. **Crash report** (from `crash-reports/` folder) |
| 273 | +2. **Latest log** (from `logs/latest.log`) |
| 274 | +3. **Mod list** (all installed mods and versions) |
| 275 | +4. **System information** (Java version, GPU, OS) |
| 276 | +5. **Steps to reproduce** |
| 277 | +6. **Expected vs actual behavior** |
| 278 | + |
| 279 | +## Next Steps After Testing |
| 280 | + |
| 281 | +Once basic testing is complete: |
| 282 | + |
| 283 | +1. **Address Runtime TODOs:** |
| 284 | + - Implement texture GL ID access (ModelTextureBakery.java:231-234) |
| 285 | + - Consider FOV event integration (VoxyRenderSystem.java:385) |
| 286 | + - Test maxMipLevel value across different texture packs |
| 287 | + |
| 288 | +2. **Optimize Reflection:** |
| 289 | + - Profile PalettedContainer.Data access performance |
| 290 | + - Consider caching or alternative approaches |
| 291 | + |
| 292 | +3. **Expand Testing:** |
| 293 | + - Test with various texture packs |
| 294 | + - Test with complementary mods (shaders, optimization mods) |
| 295 | + - Test in multiplayer environments |
| 296 | + |
| 297 | +4. **Documentation:** |
| 298 | + - Document any new issues discovered |
| 299 | + - Update inline TODO comments as issues are resolved |
| 300 | + - Create user-facing documentation for Voxy features |
| 301 | + |
| 302 | +--- |
| 303 | + |
| 304 | +**Happy Testing!** |
| 305 | + |
| 306 | +For issues or questions, refer to the [Voxy GitHub repository](https://github.com/MCRcortex/voxy/issues). |
0 commit comments