chore: Edit feature

Author: Zhou-Shilin

.gitignore

@@ -4,4 +4,8 @@ temp/*
 build/*
 logs/*
 test.py
-_config.yaml
+_config.yaml
+codes/*
+dev/*
+test.txt
+test/*

README.md

@@ -15,26 +15,28 @@
 > Developers and translators are welcome to join the CubeGPT Team!
 
 ## Introduction
-> Give GPT your idea, AI generates customized Minecraft server plugins with one click, which is suitable for Bukkit, Spigot, Paper, Purpur, Arclight, CatServer, Magma, Mohist and other Bukkit-based servers.
+> Give the LLM your idea, AI generates customized Minecraft server plugins with one click, which is suitable for Bukkit, Spigot, Paper, Purpur, Arclight, CatServer, Magma, Mohist and other Bukkit-based servers.
 
-BukkitGPT is an open source, free, AI-powered Minecraft Bukkit plugin generator. It was developed for minecraft server owners who are not technically savvy but need to implement all kinds of customized small plugins. From code to build, debug, all done by gpt.
+BukkitGPT is an open source, free, AI-powered Minecraft Bukkit plugin generator. It was developed for minecraft server owners who are not technically savvy but need to implement all kinds of customized small plugins. From code to build, debug, all done by the LLM.
 
-## WebApp
+<details>
+<summary>The WebApp Edition: Generate plugin on a website, available even on your phone!</summary>
 > [!WARNING]
 > There're big differences between *BukkitGPT(-v3)* and *BukkitGPT WebApp*. The BukkitGPT is a self-hosted, free, open-source, community-driven project, while the BukkitGPT WebApp is a paid, cloud-hosted service that provides a more user-friendly experience for non-developers.
 > Issues and questions about BukkitGPT WebApp should be directed to our [Discord Server](https://discord.gg/kTZtXw8s7r).
 
-Don't want to prepare the Python & Maven environment? Try our [WebApp](http://cubegpt.org/), designed for non-developers, just enter the plugin name and description, and you can get the plugin jar file.
+Don't want to deal with Python, Maven, BuildTools, and other complicated environments?
+Hey! Here's [the WebApp version](https://webapp.cubegpt.org) designed just for you - generate plugins **even on your phone**!
 
 *The service is paid since the API key we are using is not free. You can get 1 key for 5 generations for $1 [here](https://ko-fi.com/s/cd5d4fcaba) or [here (for Chinese users)](https://afdian.com/item/b839835461e311efbd1252540025c377)
 
-## Partner
-[![](https://www.bisecthosting.com/partners/custom-banners/c37f58c7-c49b-414d-b53c-1a6e1b1cff71.webp)](https://bisecthosting.com/cubegpt)
+*The WebApp edition doesn't support plugin editing feature yet, but we are working on it.
+</details>
 
 ## Features
 
 - Automatically generate plugin code based on the user's description.
-- Edit existing plugins. (WIP)
+- Edit existing plugins.
 
 ## Plans and TODOs
 
@@ -59,11 +61,9 @@ python -m venv venv
 source venv/bin/activate # for Windows, use `venv\Scripts\activate`
 pip install -r requirements.txt
 ```
-2. Edit `config.yaml` and fill in your [OpenAI API Key](https://platform.openai.com/settings/organization/api-keys).
+2. Edit `config.yaml` and fill in your OpenAI API Key.
 3. Run `ui.py` (with command `python ui.py`).
-4. Enter the artifact name & description & package id as instructed to generate your plugin.
-5. Copy your plugin from `projects/<artifact_name>/target/<artifact_name>-<version>.jar` to your server `plugins/` folder.
-6. Restart your server and enjoy your AI-powered-plugin.
+4. Enjoy!
 
 ## Troubleshooting
 

build.py

@@ -2,8 +2,8 @@
 from log_writer import logger
 
 
-def build_plugin(artifact_name):
-    project_path = f"codes/{artifact_name}"
+def build_plugin(artifact_name, path=False) -> str:
+    project_path = f"codes/{artifact_name}" if path == False else artifact_name
     build_command = [
         "cd",
         project_path,

codes/ExamplePlugin4/target/ExamplePlugin4-1.0-SNAPSHOT.jar

@@ -15,12 +15,8 @@ def load_config():
     with open("config.yaml", "r") as conf:
         config_content = yaml.safe_load(conf)
         for key, value in config_content.items():
-            if key == "GENERATE_MODEL" and value == "gpt-4":
-                globals()[
-                    key
-                ] = "gpt-4-turbo-preview"  # Force using gpt-4-turbo-preview if the user set the GENERATE_MODEL to gpt-4. Because gpt-4 is not longer supports json modes.
             globals()[key] = value
-            logger(f"config: {key} -> {value}")
+            logger(f"config: {key} -> {value if key != 'API_KEY' else '********'}")
 
 
 def edit_config(key, value):

codes/ExamplePlugin4/target/classes/org/cubegpt/188eba63/Main.class

@@ -2,17 +2,15 @@
 
 # GPT SETTINGS #
 # Get your api key from openai. Remember google/bing is always your best friend.
-# Model names: gpt-4o, o1-preview, o1-mini
-# Recommend -> o1-preview (Expensive and Slow, Best Performance) , gpt-4o (Cheap and fast, Good Performance)
 
-API_KEY: ""
-BASE_URL: "https://api.openai.com/v1"
+API_KEY: "" # Get your API Key from https://openrouter.ai/settings/keys for free
+BASE_URL: "https://openrouter.ai/api/v1"
 
-GENERATION_MODEL: "gpt-4o"
-FIXING_MODEL: "gpt-4o" # Deprecated
+GENERATION_MODEL: "deepseek/deepseek-r1:free"
+FIXING_MODEL: "openai/gpt-4o"
 
 # DEVELOPER SETTINGS #
-VERSION_NUMBER: "0.1.3"
+VERSION_NUMBER: "1.0.0"
 
 # PROMPT SETTINGS #
 # If you don't know what it is, please don't touch it. Be sure to backup before editing.
@@ -25,8 +23,9 @@ SYS_GEN: |
   codes/%ARTIFACT_NAME%/src/main/resources/plugin.yml
   codes/%ARTIFACT_NAME%/src/main/resources/config.yml
   codes/%ARTIFACT_NAME%/pom.xml
-  Response in json format.
   
+  You should output one and only one JSON containing all the final codes inside a ```json``` tag. You can response other stuffs like your plan, steps and explainations outside the ```json``` tag. Only the json code inside the ```json``` tag will be used to apply the edit and text outside will be ignored.
+
   This JSON contains an array under the key `codes`, where each element represents a file with its path and content for a Minecraft plugin project setup. Here’s a more detailed breakdown:
 
   The JSON has four file objects, each specifying:
@@ -35,7 +34,7 @@ SYS_GEN: |
   
   For each file:
   Main.java:
-   Path: codes/%ARTIFACT_NAME%/src/main/java/%PKG_ID_LST%/Main.java
+   Path: codes/%ARTIFACT_NAME%/src/main/java/%PKG_ID_LST%Main.java
    Content: The main Java class implementing the plugin's core functionality. It includes essential imports (import org.bukkit.Bukkit;) and extends JavaPlugin while implementing CommandExecutor.
   plugin.yml:
    Path: codes/%ARTIFACT_NAME%/src/main/resources/plugin.yml
@@ -65,50 +64,73 @@ SYS_GEN: |
   </dependencies>
 
   If the user ask you to add a new item, as you are not able to generate textures, you should use the texture of a similar item of vanilla minecraft. For example: Mooncake -> Texture: Pumpkin Pie.
-  You should never response anything else. Never use Markdown format. Never write not compeleted codes, such as leave a comment that says "// Your codes here" or "// Not compeleted". Do not forget to add ";" in the java codes. Make sure your response is json formatted.
-
-  Special Requirement: No ANY line feeds. Here're some examples:
-  (eg. for java codes) package com.example.plugin; import org.bukkit.plugin.java.JavaPlugin; public class Main extends JavaPlugin { public void onEnable() { getLogger().info("Plugin has been enabled!"); } }
-  (eg. for yaml files) {name: ExamplePlugin, main: com.example.example.plugin.Main, version: "1.0"}
-  Same for the xml file.
+  Never write not completed codes, such as leave a comment that says "// Your codes here" or "// Not completed". Do not forget to add ";" in the java codes. Make sure your response is json formatted.
 
 USR_GEN: | 
   %DESCRIPTION%
 
-SYS_FIX: |
-  You're a minecraft bukkit plugin coder AI. Game Version: 1.13.2 (1.13.2-R0.1-SNAPSHOT)
-  Fix the error in the code provided by user. The error message is also provided by the user.
-  Response in json format:
-  {
-      \"codes\": [
-          {
-              \"file\": \"codes/%ARTIFACT_NAME%/src/main/java/%PKG_ID_LST%Main.java\",
-              \"code\": \"package ...;\\nimport org.bukkit.Bukkit;\\npublic class Main extends JavaPlugin implements CommandExecutor {\\n... (The code you need to write)\"
-          },
-          {
-              \"file\": \"codes/%ARTIFACT_NAME%/src/main/resources/plugin.yml\",
-              \"code\": \"name: ...\\nversion: ...\\n...\"
-          },
-          {
-              \"file\": \"codes/%ARTIFACT_NAME%/src/main/resources/config.yml\",
-              \"code\": \"...\"
-          },
-          {
-              \"file\": \"codes/%ARTIFACT_NAME%/pom.xml\",
-              \"code\": \"...\"
-          }
-      ]
-  }
-  You should never response anything else. Never use Markdown format. Use \n for line feed, and never forget to use \ before ". Never write uncompeleted codes, such as leave a comment that says "// Your codes here" or "// Original code" or "// Uncompeleted".
-
-USR_FIX: |
-  Main.java:
-  %MAIN_JAVA%
-  plugin.yml:
-  %PLUGIN_YML%
-  config.yml:
-  %CONFIG_YML%
-  pom.xml:
-  %POM_XML%
-  error message:
-  %P_ERROR_MSG%
+SYS_EDIT: |
+  You're a minecraft bukkit plugin coder AI.
+  You're given the codes of a minecraft bukkit plugin and a request to edit the plugin.
+  You should edit the codes to meet the request.
+  You should use git diff (without index line) to show the changes you made.
+
+  For example, if the original code of codes/ExamplePlugin4/src/main/java/org/cubegpt/188eba63/Main.java is:
+  ```java
+  1 package org.cubegpt._188eba63;
+  2 
+  3 import org.bukkit.Bukkit;
+  4 import org.bukkit.event.EventHandler;
+  5 import org.bukkit.event.Listener;
+  6 import org.bukkit.event.player.PlayerJoinEvent;
+  7 import org.bukkit.plugin.java.JavaPlugin;
+  8 
+  9 public class Main extends JavaPlugin implements Listener {
+  10 
+  11     @Override
+  12     public void onEnable() {
+  13         Bukkit.getServer().getPluginManager().registerEvents(this, this);
+  14     }
+  15
+  16     @EventHandler
+  17     public void onPlayerJoin(PlayerJoinEvent event) {
+  18         event.getPlayer().sendMessage("hello");
+  19     }
+  20 }
+  ```
+  And the request is "Change the join message to 'hi'", then the response should be:
+  ```diff
+  diff --git a/codes/ExamplePlugin4/src/main/java/org/cubegpt/188eba63/Main.java b/codes/ExamplePlugin4/src/main/java/org/cubegpt/188eba63/Main.java
+  --- a/codes/ExamplePlugin4/src/main/java/org/cubegpt/188eba63/Main.java
+  +++ b/codes/ExamplePlugin4/src/main/java/org/cubegpt/188eba63/Main.java
+  @@ -1,17 +1,17 @@
+  -event.getPlayer().sendMessage("hello");
+  +event.getPlayer().sendMessage("hi");
+  @@ -19,20 +19,20 @@
+  ```
+  There could be multiple diffs, put each diff inside a markdown ```diff``` tag.
+  You can response other stuffs like your plan, steps and explainations outside the ```diff``` tag. Only the diffs inside the ```diff``` tag will be used to apply the edit and text outside will be ignored.
+  Make sure the diffs are valid and can be applied to the original code.
+  Do not forget to add ";" in the java codes.
+
+  There should be a empty pom.xml in the original code, and you should fill the pom.xml with things needed for the plugin to work. Always add this in pom.xml:
+    <repositories>
+      <repository>
+          <id>spigot-repo</id>
+          <url>https://hub.spigotmc.org/nexus/content/repositories/snapshots/</url>
+      </repository>
+  </repositories>
+
+  <dependencies>
+      <dependency>
+             <groupId>org.spigotmc</groupId>
+             <artifactId>spigot-api</artifactId>
+             <version>1.13.2-R0.1-SNAPSHOT</version>
+             <scope>provided</scope>
+      </dependency>
+  </dependencies>
+
+USR_EDIT: |
+  %ORIGINAL_CODE%
+  My request:
+  %REQUEST%