Skip to content

Commit

Permalink
Merge pull request #10 from RappyTV/master
Browse files Browse the repository at this point in the history
Improve list in first-steps, replace backslashes in paths by slashes
  • Loading branch information
jumpingpxl authored Feb 24, 2024
2 parents 3e3afe3 + eab39c1 commit 30989f9
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
3 changes: 2 additions & 1 deletion docs/pages/addon/features/version-dependent.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ high impact on the performance of the players that use your addon.
The use case we will implement in the following example will show how to display messages in the player's chat. We have
already implemented this, but it is relatively easy to show and understand.

We will first create a new interface in our `core`- or `api` module called `ExampleChatExecutor` and declare a new
We will first create a new interface in our `core`- or `api` module called `ExampleChatExecutor`, annotate it with the `@Referenceable` annotation and declare a new
method `void displayMessageInChat(String)`. Now we head to the module of the version we want and create a new class
called `VersionedExampleChatExecutor` in our desired package. If there is no folder called `src` in the module, you'll
need to create the following folder structure inside the module: `src/main/java/`.
Expand All @@ -47,6 +47,7 @@ Those are the results from this example:

=== ":octicons-file-code-16: ExampleChatExecutor"
```java
@Referenceable
public interface ExampleChatExecutor {

void displayMessageInChat(String message);
Expand Down
6 changes: 4 additions & 2 deletions docs/pages/addon/setup/first-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@ First you'll need a Java IDE, as of now we only support
<a href="https://www.jetbrains.com/idea/download/" target="_blank">IntelliJ IDEA</a>. Then download <a href="https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html" target="_blank">JDK (Java Development Kit) 17</a> if you haven't already.

Differences between the "Community" and "Ultimate" edition:

- **IntelliJ IDEA Community Edition** is the free to use version for everyone.
- **IntelliJ IDEA Ultimate** is the version where you need a valid purchased subscription based licensed, its also possible to use the "Ultimate" edition if you have a valid educational license.
- **IntelliJ IDEA Ultimate** is the version where you need a valid subscription based license.

You can apply for a educational license at Jetbrains <a href="https://www.jetbrains.com/community/education/" target="_blank">here</a>
You can apply for a free educational license at Jetbrains <a href="https://www.jetbrains.com/community/education/" target="_blank">here</a>.<br>
Its also possible obtain an "Ultimate" edition license if you are part of the <a href="https://education.github.com" target="_blank">GitHub Global Campus</a> where you can apply <a href="https://education.github.com/pack/join" target="_blank">here</a>.

Now
<a href="https://github.com/LabyMod/addon-template" target="_blank">download or clone our addon template</a> and open it in your preferred IDE.
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/addon/setup/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ After you have changed these attributes, reload the Gradle project, and you're g


## Understanding the Basics
Head to `core\src\main\java` in your root project folder. You'll find some examples, starting with the main addon class: `ExampleAddon`.
Head to `core/src/main/java` in your root project folder. You'll find some examples, starting with the main addon class: `ExampleAddon`.

### The Main Class

Expand Down

0 comments on commit 30989f9

Please sign in to comment.