Progress towards publishing

This commit is contained in:
Martin Prokoph
2024-02-08 19:35:10 +01:00
parent 23fd6e87f7
commit 9863a49398
6 changed files with 368 additions and 6 deletions

View File

@@ -50,5 +50,6 @@ import ContentMedia from '../components/ContentMedia.astro'
url_gh="https://github.com/TeamMidnightDust/MidnightLib"
url_mr="https://modrinth.com/mod/midnightlib"
url_cf="https://www.curseforge.com/minecraft/mc-mods/midnightlib"
url_wiki="/wiki/midnightlib"
/>
</DefaultLayout>

View File

@@ -3,8 +3,10 @@ layout: ../../layouts/MarkdownLayout.astro
title: MidnightLib Wiki
---
import VersionDropdown from '../../components/VersionDropdown.astro'
import { Icon } from 'astro-icon/components'
import { Notification } from 'accessible-astro-components'
import { resultingVersion } from '../../js/modversion.js'
# MidnightLib Wiki
@@ -12,6 +14,12 @@ Welcome to the MidnightLib wiki. Thanks for showing interest in our library!
This documentation aims to show you how to use the config system and the other features the library provides.
Use the tabs on the right side to switch between the different pages.
Explore MidnightLib's features on this page!
<a class="button has-icon color-secondary text-center text-lg items-center" href="/midnightlib">
<Icon name="ion:bookmark-outline" />
Get to know the features
</a>
To use the library in your mods, just edit `build.gradle` and `gradle.properties` as seen below:
### `build.gradle`
```java
@@ -26,19 +34,20 @@ dependencies {
modImplementation include "maven.modrinth:midnightlib:${project.midnightlib_version}"
}
```
### `gradle.properties`
```js
midnightlib_version=1.5.3-fabric
```
### `gradle.properties`
<VersionDropdown></VersionDropdown>
{<pre><code className="language-java">midnightlib_version = {resultingVersion}</code></pre>}
<Notification type="info">
<Icon name="ion:information-circle-outline" />
<p>
<strong>Info:</strong> You should always pick the version that suits your modloader and Minecraft version best.
The version selector is currently still WIP.
Find all available versions on [Modrinth](https://www.modrinth.com/mod/midnightlib/versions)
</p>
</Notification>
### `MidnightConfigExample.java`
### `YourConfigClass.java`
To get started with implementing the config, you must create a public class that extends MidnightConfig.
In this class, your variables can be stored and accessed. Here you can see the contents of an example config class:
```java