Добавлен новый readme.md

README.md

@@ -1,30 +1,100 @@
-<<<<<<< HEAD
+# CubeNet Core
 
-Installation information
+A Minecraft NeoForge mod for CubeNet that adds custom items with 3D models and textures.
-=======
 
-This template repository can be directly cloned to get you started with a new
+## Features
-mod. Simply create a new repository cloned from this one, by following the
-instructions provided by [GitHub](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
 
-Once you have your clone, simply open the repository in the IDE of your choice. The usual recommendation for an IDE is either IntelliJ IDEA or Eclipse.
+- **Custom Items**: Paper items (Paper2, Paper3, Paper4) with unique 3D models
+- **Custom Textures**: High-quality textures for all items
+- **Creative Tab**: Dedicated "CubeNet" creative mode tab with all items
+- **Block Items**: Includes terrain blocks (Skytech Block, Grass Block, Terrain Block)
 
-If at any point you are missing libraries in your IDE, or you've run into problems you can
+## Items
-run `gradlew --refresh-dependencies` to refresh the local cache. `gradlew clean` to reset everything 
-{this does not affect your code} and then start the process again.
 
-Mapping Names:
+### Paper Items
-============
+- **Paper2**: A vertical paper item with custom 3D model and texture
-By default, the MDK is configured to use the official mapping names from Mojang for methods and fields 
+- **Paper3**: A wider horizontal paper item with custom display settings
-in the Minecraft codebase. These names are covered by a specific license. All modders should be aware of this
+- **Paper4**: A tall vertical paper item with unique proportions
-license. For the latest license text, refer to the mapping file itself, or the reference copy here:
-https://github.com/NeoForged/NeoForm/blob/main/Mojang.md
 
-Additional Resources: 
+### Block Items
-==========
+- **Skytech Block**: Blue terrain block
-Community Documentation: https://docs.neoforged.net/  
+- **Grass Block**: Natural grass textured block
-NeoForged Discord: https://discord.neoforged.net/
+- **Terrain Block**: Green terrain block
-=======
-# cubenet_mod_core
 
->>>>>>> 07fa0307fd8dd2b9ee3208f1ea90d70a3a07902a
+## Installation
+
+### Requirements
+- Java 21 or higher
+- Gradle (included with gradlew)
+- Minecraft 1.21.6 or compatible version
+
+### Setup
+
+1. Clone the repository:
+```bash
+git clone <repository-url>
+cd cubenet_core
+```
+
+2. Open in your IDE (IntelliJ IDEA or Eclipse recommended)
+
+3. If missing libraries, refresh dependencies:
+```bash
+./gradlew --refresh-dependencies
+```
+
+4. Build the mod:
+```bash
+./gradlew build
+```
+
+## Development
+
+### Project Structure
+```
+src/main/
+├── java/com/skytech/cubenetcore/
+│   ├── CubeNetCore.java          # Main mod class with item/block registration
+│   ├── Config.java               # Configuration class
+│   ├── block/                    # Block definitions
+│   ├── blockentity/              # Block entity classes
+│   ├── item/                     # Item classes
+│   ├── screen/                   # UI screen classes
+│   └── client/                   # Client-side events
+└── resources/assets/cubenetcore/
+    ├── models/item/              # Item 3D models (JSON)
+    ├── models/block/             # Block models
+    ├── textures/item/            # Item textures
+    └── textures/block/           # Block textures
+```
+
+### Adding New Items
+
+To add a new item:
+
+1. Register in `CubeNetCore.java`:
+```java
+public static final DeferredItem<Item> ITEM_NAME = ITEMS.registerSimpleItem("item_name");
+```
+
+2. Create model file: `src/main/resources/assets/cubenetcore/models/item/item_name.json`
+
+3. Add texture: `src/main/resources/assets/cubenetcore/textures/item/item_name.png`
+
+4. Add to creative tab in the displayItems method
+
+5. Rebuild and test
+
+## Resources
+
+- **Community Documentation**: https://docs.neoforged.net/
+- **NeoForged Discord**: https://discord.neoforged.net/
+- **Mapping License**: https://github.com/NeoForged/NeoForm/blob/main/Mojang.md
+
+## License
+
+See LICENSE file for more information.
+
+## Credits
+
+Made with Blockbench for 3D models.