Skip to content

Commit c133c87

Browse files
committed
Docs
1 parent e4cd3c5 commit c133c87

File tree

4 files changed

+64
-0
lines changed

4 files changed

+64
-0
lines changed

.github/workflows/build.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Barium Build Script
2+
3+
on:
4+
push:
5+
branches: [ ver/1.16.5 ]
6+
pull_request:
7+
branches: [ ver/1.16.5 ]
8+
9+
jobs:
10+
build:
11+
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- uses: actions/checkout@v2
16+
- name: Set up JDK 11
17+
uses: actions/setup-java@v1
18+
with:
19+
java-version: 11
20+
21+
- name: Pull Gradle Cache
22+
uses: actions/cache@v2
23+
id: gradle-cache
24+
with:
25+
path: ~/.gradle
26+
key: ${{ runner.os }}-maven-${{ hashFiles('gradle/wrapper/gradle-wrapper.properties') }}-java-11
27+
28+
- name: Build Barium
29+
run: |
30+
./gradlew clean build
31+
32+
- name: Upload Artifact
33+
uses: actions/upload-artifact@v2
34+
with:
35+
name: Barrium
36+
path: ./build/libs/barium-fabric-0.1-SNAPSHOT-all.jar
37+

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<img width="200" src="https://yatopiamc.org/static/img/barrium.png" alt="Yatopia" align="right">
2+
<div align="left">
3+
<h1>Barium</h1>
4+
5+
[![Github-CI](https://github.com/YatopiaMC/barium-fabric/workflows/Barium%20Build%20Script/badge.svg)](https://github.com/YatopiaMC/barium-fabric/actions?query=workflow%3ACI)
6+
[![CodeMC](https://ci.codemc.io/buildStatus/icon?job=YatopiaMC%2Fbarium-fabric%2Fver%252F1.16.5)](https://ci.codemc.io/job/YatopiaMC/job/barium-fabric/job/ver%252F1.16.5/)
7+
[![Discord](https://img.shields.io/discord/342814924310970398?color=%237289DA&label=Discord&logo=discord&logoColor=white)](https://discord.io/YatopiaMC)
8+
<h3>A Fabric mod designed to improve the chunk performance of Minecraft.</h3>
9+
</div>
10+
11+
## So what is Barium?
12+
Barium is a Fabric mod designed to improve of chunk generation, I/O, and loading. This is done by taking advantage of multiple CPU cores in parallel. For the best performance it is recommended to use Barium with [Lithium](https://github.com/CaffeineMC/lithium-fabric) and [Starlight](https://github.com/Spottedleaf/Starlight).
13+
14+
## Building and setting up
15+
16+
Run the following commands in the root directory:
17+
18+
```shell
19+
./gradlew clean
20+
./gradlew build
21+
```
22+
23+
## License
24+
25+
License information can be found [here](../LICENSE).
3.82 MB
Loading

src/main/resources/fabric.mod.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,15 @@
55
"name": "Barium",
66
"description": "A Fabric mod designed to improve the world generation performance of Minecraft",
77
"authors": [
8+
"YatopiaMC",
89
"ishland"
910
],
1011
"contact": {
1112
"website": "https://yatopiamc.org/",
1213
"repo": "https://github.com/YatopiaMC/barium-fabric"
1314
},
1415
"license": "MIT",
16+
"icon": "assets/barium/icon.png",
1517
"environment": "*",
1618
"entrypoints": {
1719
"main": [

0 commit comments

Comments
 (0)