Skip to content

Commit bb684e0

Browse files
committed
chore(paper): cleanup project setup main class description
1 parent 7cd5ede commit bb684e0

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/content/docs/paper/dev/getting-started/project-setup.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,10 @@ This allows for a unique package name for every plugin.
141141
### The _main_ class
142142

143143
The main class is the entry point to your plugin and will be the only class that extends
144-
[`JavaPlugin`](jd:paper:org.bukkit.plugin.java.JavaPlugin) in your plugin.
145-
This is an example of what your `ExamplePlugin` class could look like:
144+
[`JavaPlugin`](jd:paper:org.bukkit.plugin.java.JavaPlugin) in your plugin. It is considered
145+
good practise to **not** name this class `Main`. Instead, choose a more descriptive name,
146+
like your plugin's name. If your plugin is called `Example`, your main class could be called
147+
`ExamplePlugin`. An example implementation of this class might look like this:
146148

147149
```java title="ExamplePlugin.java"
148150
package io.papermc.testplugin;

0 commit comments

Comments
 (0)