Skip to content

README.md

Latest commit

 

History

History
94 lines (69 loc) · 2.78 KB

README.md

File metadata and controls

94 lines (69 loc) · 2.78 KB

📚 CodeEngine Documentation

Official documentation repository for CodeEngine Plugin - Custom enchantments, items, and configurations for Minecraft Folia/Paper/Spigot servers.

🎯 Purpose

This repository contains complete, working examples of CodeEngine configurations that you can:

  • 📋 Copy and use directly in your server
  • 🤖 Provide to ChatGPT for custom modifications
  • 📖 Learn from to understand the plugin's capabilities
  • 🔄 Adapt for your own unique needs

📂 Structure

codeengine-docs/
├── folia/
│   └── 1.21/
│       └── weapons/
│           └── sword/
│               └── blade_of_condemned.yml
├── paper/ (coming soon)

## 🗡️ Available Documentation

### Folia 1.21

#### Weapons - Sword
- **[blade_of_condemned.yml](folia/1.21/weapons/sword/blade_of_condemned.yml)** - Epic sword enchantment
  - Summons (Vex and Phantoms)
  - Life Steal
  - Bleeding Effect with particles
  - Combo System (Level 3)
  - Bloodlust multiplier (Level 2+)
  - Shadow Step teleportation
  - Execution mechanic
  - Attribute modifiers

## 🤖 How to Use with ChatGPT

1. **Copy the raw file URL** from GitHub
2. **Paste it into ChatGPT** and say:

Read this CodeEngine configuration: [paste URL]

I want to create [describe what you want]

3. **ChatGPT can access GitHub directly!** No need to copy the entire file
4. **Ask for modifications:**
- "Adapt this for a helmet enchantment"
- "Add fire damage instead of bleeding"
- "Make it work for Paper 1.20"
- "Simplify it to only have life steal"

### Example Prompt

Read this CodeEngine sword enchantment: https://raw.githubusercontent.com/[username]/codeengine-docs/main/folia/1.21/weapons/sword/blade_of_condemned.yml

I want to create a pickaxe enchantment that:

  • Gives speed when mining
  • Has a 20% chance to drop bonus diamonds
  • Adds particle effects
  • Works on Folia 1.21

Please generate the complete YAML configuration following the same structure.


## 💡 Tips for Best Results

1. **Be specific** - Tell ChatGPT exactly what you want
2. **Reference the structure** - ChatGPT will follow the same pattern
3. **Ask for explanations** - Request comments in the code
4. **Iterate** - Ask ChatGPT to modify parts you don't like
5. **Test** - Always test on a development server first

## 🔗 Links

- **Website**: https://codeengine.store-syncmaster.com
- **Documentation Page**: https://codeengine.store-syncmaster.com/documentation
- **Discord**: [Join our community](https://discord.gg/your-invite)

## 📝 License

This documentation is provided **free** for the Minecraft community. Use it, modify it, share it!

## 🚀 Contributing

Want to add more documentation? Open a Pull Request or contact us on Discord!

---

Made with ❤️ by the CodeEngine team