Skip to content

Add README with Maven integration and setup instructions #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Snabeldier merged 2 commits into from
Feb 3, 2026
Merged

Add README with Maven integration and setup instructions #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
daafb33
Initial plan
Copilot Feb 3, 2026
33c051d
Add README.md with brief description and Maven integration instructions
Copilot Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 97 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# ![Logo](https://cdn.minevalley.eu/branding/logo_64px_cropped.png) - CraftingAPI

The CraftingAPI provides access to custom crafting recipes for MineValleyEU, enabling the creation of shaped and shapeless recipes with custom crafting durations.

## Maven Integration

To use this API in your module, we provide a Maven repository hosted on GitHub.
Before proceeding, ensure you've added a token to your `settings.xml` file (details below).

```xml
<repository>
<id>CraftingAPI</id>
<url>https://maven.pkg.github.com/MineValley/CraftingAPI</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
```

```xml
<dependency>
<groupId>minevalley.crafting</groupId>
<artifactId>api</artifactId>
<version>1.0.0</version>
</dependency>
```

## Linking Your GitHub Account

While the API is publicly accessible, a GitHub account is required to access the repository. If you already have an
account, follow these steps to create a token:

> [!IMPORTANT]\
> Opting for a token with no expiration increases the likelihood of unauthorized access and should be carefully
> considered.\
> Reusing the same token across multiple purposes or devices significantly increases the potential damage in the event
> of a leak.

### Creating a Personal Access Token

1. Go to **Settings** on GitHub (top-right corner, click your profile picture → **Settings**).
2. Scroll down and select **Developer settings** → **Personal access tokens** → **Tokens (classic)**.
3. Click **Generate new token** and choose **Generate new token (classic)** from the dropdown.
4. Add a meaningful name in the **Note** field (e.g., "MineValley").
5. Under **Expiration**, select a valid duration for the token. Once expired, you'll need to create a new token.
Alternatively, you can select **No expiration** for permanent use.
6. Check the box for **read:packages**.
7. Click **Generate token** and copy the token.

### Adding the Token to Your Maven Settings

Once you have your token, add it to the `settings.xml` file of your Maven installation. Replace `USERNAME` with your
GitHub username and `TOKEN` with the generated token.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
<servers>
<server>
<id>CraftingAPI</id>
<username>USERNAME</username>
<password>TOKEN</password>
</server>
</servers>
</settings>
```

> **Tip**: In IntelliJ, you can create a `settings.xml` file by right-clicking on the `pom.xml` of any project and
> selecting **Create settings.xml**.

## Troubleshooting / FAQ

<strong>I'm having issues with Eclipse.</strong>
<ul>
<li>Use IntelliJ.</li>
</ul>

<strong>I'm unsure if I used the correct GitHub username.</strong>
<ul>
<li>You can find your GitHub username on your profile page. If in doubt, try logging in with your username. If it works,
it's correct.</li>
</ul>

<strong>Can I choose the content of <code>&lt;id&gt;</code> freely?</strong>
<ul>
<li>You could theoretically, as long as the content of <code>&lt;id&gt;</code> in both the <code>settings.xml</code> and <code>pom.xml</code> are identical.
To allow other developers to deploy your code without having to change their <code>settings.xml</code> it is recommended to stick to the naming given in this README.</li>
</ul>

<strong>I followed all steps, but the dependency could not be found.</strong>
<ol>
<li>Click <strong>Maven</strong> in the right-hand sidebar.</li>
<li>Press the <strong>Reload All Maven Projects</strong> button (top-left).</li>
<li>If the problem persists, go to <strong>File</strong> → <strong>Invalidate Caches...</strong> → <strong>Invalidate and Restart</strong>.</li>
</ol>
Loading