Skip to content
Getting started

Your first project

A walkthrough of a real first project, a Paper homes plugin, from request to tested JAR.

Updated

On this page
  1. The request
  2. What happens next
  3. Look at the result
  4. Change something
  5. Build and test it
  6. Next

This walkthrough builds a small but real plugin, so you see every stage once. The same flow applies to every project type.

#The request

On Create, pick Bukkit/Spigot/Paper Plugin (Java) and write:

Text
A Paper 1.21.4 plugin called SimpleHomes.
- /sethome saves the player's current location as their home (one home per player).
- /home teleports them there after a 3 second warm-up; moving cancels it.
- 30 second cooldown on /home, configurable in config.yml.
- Homes persist across restarts in a YAML file.
- Permissions: simplehomes.use (default true), simplehomes.bypasscooldown (default op).
- Messages configurable in config.yml, with color codes.

Notice what it contains: the platform and version, each command and what it does, timing rules, storage, permissions and what should be configurable. That's what makes the first result usable.

#What happens next

  1. Codexe streams the files: a Maven pom.xml, the main class, command and listener classes, plugin.yml and config.yml.
  2. The banner switches to Checking project… and then Building…. Codexe compiles the plugin.
  3. If the compiler reports an error (for example a wrong import), you'll see Fixing an issue…. Codexe repairs the code and builds again. This doesn't use your tokens.
  4. The project becomes Ready.

#Look at the result

  • Open plugin.yml and check that the commands and permissions match what you asked.
  • Open config.yml: the cooldown and messages should be there.
  • Skim the main class. You don't need to understand every line, but you can spot obvious gaps.

#Change something

In the project chat, type:

Text
Allow up to 3 named homes per player: /sethome <name>, /home <name>, /delhome <name>, /homes to list them.

Codexe edits the existing files instead of starting over. Follow-ups cost far less than a new project because only the affected files are rewritten. When the change touches a buildable project, Codexe verifies it again.

#Build and test it

Press Compile to run a fresh build, then Download JAR. Put the JAR in your server's plugins/ folder and restart. Test each command, including the edge cases (moving during the warm-up, the cooldown, a restart).

#Next

Your first project | Codexe Docs