Skip to content

Commit

Permalink
Add a download page.
Browse files Browse the repository at this point in the history
  • Loading branch information
shartte committed Feb 9, 2025
1 parent 0e68bae commit 49f4900
Show file tree
Hide file tree
Showing 5 changed files with 126 additions and 0 deletions.
58 changes: 58 additions & 0 deletions docs/docs/03-downloads.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
import DownloadCurseforge from '@site/src/components/DownloadCurseforge';
import DownloadModrinth from '@site/src/components/DownloadModrinth';

# Downloads

## For Players

The mod can be downloaded from both Curseforge and Modrinth.

<p>
<DownloadCurseforge />
</p>

<p>
<DownloadModrinth />
</p>

## For Developers

### Releases

GuideME publishes Maven artifacts on both [Github Packages](https://github.com/AppliedEnergistics/GuideME/packages/2384035)
and [Maven Central](https://central.sonatype.com/artifact/org.appliedenergistics/guideme).

![GuideME](https://img.shields.io/maven-central/v/org.appliedenergistics/guideme)

How you can use GuideME in your build script will depend on which build tool you use.

If you use ModDevGradle, this snippet will include GuideMEs API during compile-time, and its full package during runtime:

```gradle
repositories {
mavenCentral() // You might already have this
}
dependencies {
compileOnly 'org.appliedenergistics:guideme:<version>:api'
runtimeOnly 'org.appliedenergistics:guideme:<version>'
}
```

### Snapshots

We publish every commit on the main branch to the Maven Central Snapshot repository.

You can see the [list of versions](https://central.sonatype.com/service/rest/repository/browse/maven-snapshots/org/appliedenergistics/guideme/).

To use these versions, you can use this repository in Gradle:

```gradle
maven {
name = 'GuideME Snapshots'
url = 'https://central.sonatype.com/repository/maven-snapshots/'
content {
includeModule('org.appliedenergistics', 'guideme')
}
}
```
12 changes: 12 additions & 0 deletions docs/src/components/DownloadCurseforge.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import CurseforgeLogo from './curseforge.svg';

function DownloadCurseforge() {
return (
<a href="https://www.curseforge.com/minecraft/mc-mods/guideme" className="button button--outline button--secondary"
title="Download from Curseforge" aria-label="Download from Curseforge">
<CurseforgeLogo style={{fill: "#000000", width: '250px'}}/>
</a>
);
}

export default DownloadCurseforge;
13 changes: 13 additions & 0 deletions docs/src/components/DownloadModrinth.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

import ModrinthLogo from './modrinth.svg';

function DownloadModrinth() {
return (
<a href="https://modrinth.com/mod/guideme" className="button button--outline button--secondary"
title="Download from Modrinth" aria-label="Download from Modrinth">
<ModrinthLogo style={{width: '250px'}} />
</a>
);
}

export default DownloadModrinth;
16 changes: 16 additions & 0 deletions docs/src/components/curseforge.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 27 additions & 0 deletions docs/src/components/modrinth.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 49f4900

Please sign in to comment.